Skip to content
OpenBot

sessions.enqueueMessage

POST
/v1/sessions/{sessionId}/queue
curl --request POST \
  --url https://example.com/v1/sessions/example/queue \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "input": [ { "type": "message", "role": "user", "content": [ { "type": "input_text", "text": "example" } ] } ], "expected": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
sessionId
required
string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
input
required
Any of:
string
>= 1 characters
expected
integer
<= 9007199254740991

Responses

Section titled “Responses”

202

Section titled “202”

Success

Media typeapplication/json
object
session
required
string
item
required
string
revision
required
integer
<= 9007199254740991

Example generated

{
  "session": "example",
  "item": "example",
  "revision": 1
}

400

Section titled “400”

SessionInvalidRecord | SessionModelInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SessionInvalidRecord
message
required
string

Example 

{
  "_tag": "SessionInvalidRecord"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

404

Section titled “404”

SessionNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: SessionNotFound
session
required
string

Example 

{
  "_tag": "SessionNotFound"
}

409

Section titled “409”

SessionBusy | SessionConflict

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SessionBusy
session
required
string

Example 

{
  "_tag": "SessionBusy"
}

503

Section titled “503”

SessionStorageUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SessionStorageUnavailable

Example 

{
  "_tag": "SessionStorageUnavailable"
}