Stop the current run

POST

/v1/sessions/{sessionId}/stop

• Production

Returns once the abort is recorded, without waiting for idle.

Authorizations

• bearerAuth

Parameters

Path Parameters

sessionId

required

string

Responses

202

Success

object

id

required

string

title

string

createdAt

required

Milliseconds since the epoch, as a string.

string

/^\d+$/

updatedAt

required

Milliseconds since the epoch, as a string.

string

/^\d+$/

status

required

Run state. Open: idle | working | stopping.

string

archived

required

boolean

parent

object

sessionId

required

string

>= 1 characters <= 128 characters

entryId

required

string

>= 1 characters <= 128 characters

kind

required

string

Allowed value: fork

position

required

Fork boundary: at inherits history through entryId; before inherits history before it. Open: at | before.

string

model

required

object

id

required

string

thinkingLevel

string

context

required

Current conversation.

object

tokens

required

number

window

required

number

usage

required

This conversation only; inherited history is not counted again.

object

inputTokens

required

number

outputTokens

required

number

cacheReadTokens

required

number

cacheWriteTokens

required

number

estimatedCost

required

USD estimate from catalog prices; Bkper AI accounting is authoritative.

string

properties

required

object

key

additional properties

string

instructions

Present when set. Without it the agent runs with Bkper’s base only.

string

<= 16000 characters

400

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

401

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

403

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

404

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

409

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

410

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

411

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

413

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string

503

Rejected; never contains credentials or upstream payloads.

object

error

required

object

code

required

Stable code, e.g. not_found, idempotency_conflict, session_working, usage_limit_exceeded. Open.

string

type

Category, e.g. invalid_request_error, authentication_error, usage_limit_error. Open.

string

message

string