Withdraw a queued input

POST

/v1/sessions/{sessionId}/inputs/{inputId}/withdraw

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

sessionId

required

string

inputId

required

string

Responses

200

Success

object

id

required

The Idempotency-Key.

string

sessionId

required

string

createdBy

required

string

createdAt

required

Milliseconds since the epoch, as a string.

string

/^\d+$/

delivery

required

Delivery. Open: prompt | steer | followUp.

string

status

required

Input state. Open: queued | running | completed | withdrawn | failed.

string

content

required

Array<object>

Typed part; text is { type: “text”, text }. Open.

object

type

required

string

key

additional properties

entryId

string

answerEntryId

string

error

Sanitized failure. Never contains provider, AI or credential text.

object

code

required

string

type

string

bookContext

object

bookId

required

string

/^[A-Za-z0-9_-]{1,128}$/

query

required

string

<= 4000 characters /^[^\u0000-\u001f]*$/

attributes

Up to 16 string attributes of the message, such as its sender, channel or thread, at most 16000 characters in total. Names start with a letter, then up to 63 letters, digits, _, . or -. Advisory data for the agent, frozen with the input: never identity, permission or instructions.

object

key

additional properties

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

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

host

Host_in_use: the host another service holds.

string

service

Host_in_use: the id of the service that holds the host.

string