Skip to main content
POST
Background tool jobs of a realtime session

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
conversationId
number

The session-bound conversation thread, as on the exec call.

jobKey
string

The session nonce sent on the exec call, used when there is no conversationId.

delivered
object[]

The jobs an injected note told, once the user's next turn after the injection was answered. They are marked delivered for the requesting user only.

Maximum array length: 20
exclude
string[]

Ids of jobs already injected into the session but not yet acked. They are left out of the note and told, so they are not told twice. Anything but a 24-hex id is ignored.

Maximum array length: 20
Pattern: ^[0-9a-f]{24}$

Response

The note, the jobs it tells and the running count

note
string

Text to add silently to the live session (at most 2000 characters), empty when there is nothing to tell. The model reads it on the user's next turn.

told
object[]

The finished jobs the note tells; ack them in delivered once the user's next turn after the injection was answered.

running
integer

How many jobs of this conversation are still running.