Send message

Durably admit one session input and schedule agent-loop execution unless resume is false.

POST/api/session/{sessionID}/prompt

Path parameters

sessionIDobjectrequired

Request body

requiredapplication/json

idobject | any

Show properties

Any of:

object

object

any

any

textstringrequired

filesPromptInput.FileAttachment[]

Show properties

Array of PromptInput.FileAttachment

uristringrequired

namestring

descriptionstring

mentionPrompt.Mention

Show properties

startnumberrequired

endnumberrequired

textstringrequired

agentsPrompt.AgentAttachment[]

Show properties

Array of Prompt.AgentAttachment

namestringrequired

mentionPrompt.Mention

Show properties

startnumberrequired

endnumberrequired

textstringrequired

metadataobject

deliverystring | any

Show properties

Any of:

string

string

any

any

resumeboolean | any

Show properties

Any of:

boolean

boolean

any

any

Responses

200Success

dataSessionPending.Userrequired

Show properties

admittedSeqobjectrequired

Show properties

object

idobjectrequired

Show properties

object

sessionIDobjectrequired

Show properties

object

timeCreatednumberrequired

typestringrequired

Allowed:user

dataSessionPending.UserDatarequired

Show properties

textstringrequired

filesPrompt.FileAttachment[]

Show properties

Array of Prompt.FileAttachment

dataPrompt.Base64required

Show properties

object

mimestringrequired

sourcePrompt.FileSourcerequired

Show properties

Any of:

object

typestringrequired

Allowed:inline

object

typestringrequired

Allowed:uri

uristringrequired

namestring

descriptionstring

mentionPrompt.Mention

Show properties

startnumberrequired

endnumberrequired

textstringrequired

agentsPrompt.AgentAttachment[]

Show properties

Array of Prompt.AgentAttachment

namestringrequired

mentionPrompt.Mention

Show properties

startnumberrequired

endnumberrequired

textstringrequired

metadataobject

deliverystringrequired

Allowed:steerqueue

400InvalidRequestError

Any of:

InvalidRequestError1

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

InvalidRequestError

_tagstringrequired

Allowed:InvalidRequestError

messagestringrequired

kindstring | any

Show properties

Any of:

string

string

any

any

fieldstring | any

Show properties

Any of:

string

string

any

any

401UnauthorizedError

_tagstringrequired

Allowed:UnauthorizedError

messagestringrequired

404SessionNotFoundError

Any of:

SessionNotFoundError

_tagstringrequired

Allowed:SessionNotFoundError

sessionIDstringrequired

messagestringrequired

SessionNotFoundError

_tagstringrequired

Allowed:SessionNotFoundError

sessionIDstringrequired

messagestringrequired

409ConflictError

_tagstringrequired

Allowed:ConflictError

messagestringrequired

resourcestring | any

Show properties

Any of:

string

string

any

any

Request

curl -X POST "/api/session/%5Bobject%20Object%5D/prompt" \
  -H "Content-Type: application/json" \
  -d '{
  "id": {},
  "text": "string",
  "files": [
    {
      "uri": "string",
      "name": "string",
      "description": "string",
      "mention": {
        "start": 0,
        "end": 0,
        "text": "string"
      }
    }
  ],
  "agents": [
    {
      "name": "string",
      "mention": {
        "start": 0,
        "end": 0,
        "text": "string"
      }
    }
  ],
  "metadata": {},
  "delivery": "steer",
  "resume": true
}'

const response = await fetch("/api/session/%5Bobject%20Object%5D/prompt", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "id": {},
  "text": "string",
  "files": [
    {
      "uri": "string",
      "name": "string",
      "description": "string",
      "mention": {
        "start": 0,
        "end": 0,
        "text": "string"
      }
    }
  ],
  "agents": [
    {
      "name": "string",
      "mention": {
        "start": 0,
        "end": 0,
        "text": "string"
      }
    }
  ],
  "metadata": {},
  "delivery": "steer",
  "resume": true
})
});

import requests

response = requests.post(
    "/api/session/%5Bobject%20Object%5D/prompt",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "id": {},
  "text": "string",
  "files": [
    {
      "uri": "string",
      "name": "string",
      "description": "string",
      "mention": {
        "start": 0,
        "end": 0,
        "text": "string"
      }
    }
  ],
  "agents": [
    {
      "name": "string",
      "mention": {
        "start": 0,
        "end": 0,
        "text": "string"
      }
    }
  ],
  "metadata": {},
  "delivery": "steer",
  "resume": True
},
)

Response

{
  "data": {
    "admittedSeq": {},
    "id": {},
    "sessionID": {},
    "timeCreated": 0,
    "type": "user",
    "data": {
      "text": "string",
      "files": [
        {
          "data": {},
          "mime": "string",
          "source": {
            "type": "inline"
          },
          "name": "string",
          "description": "string",
          "mention": {
            "start": 0,
            "end": 0,
            "text": "string"
          }
        }
      ],
      "agents": [
        {
          "name": "string",
          "mention": {
            "start": 0,
            "end": 0,
            "text": "string"
          }
        }
      ],
      "metadata": {}
    },
    "delivery": "steer"
  }
}