Send an input

POST

/v1/sessions/{sessionId}/inputs

• Production

Same key and content returns the existing input; different content is 409.

Authorizations

• bearerAuth

Parameters

Path Parameters

sessionId

required

string

Header Parameters

Idempotency-Key

required

string

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

Request Body ^required

object

content

required

Text parts (at most 16000 characters in total) and up to 10 file parts; some text or a file. Files unknown to the caller are 404 file_not_found; expired ones 410 file_gone.

Array

>= 1 items <= 16 items

One of:

object

object

type

required

string

Allowed value: text

text

required

string

object

object

type

required

string

Allowed value: file

fileId

required

A file of the caller, from POST /v1/files or a publish.

string

/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

delivery

string

Allowed values: prompt steer followUp

bookContext

Advisory Book/query context, frozen with this input. Never identity or authorization.

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

Responses

202

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