Add synthetic message

Durably admit synthetic session input and schedule execution unless resume is false.

POST/api/session/{sessionID}/synthetic

Path parameters

sessionIDobjectrequired

Request body

requiredapplication/json

idobject | any

Show properties

Any of:

object

object

any

any

textstringrequired

descriptionstring | any

Show properties

Any of:

string

string

any

any

metadataobject

deliverystring | any

Show properties

Any of:

string

string

any

any

resumeboolean | any

Show properties

Any of:

boolean

boolean

any

any

Responses

200Success

dataSessionPending.Syntheticrequired

Show properties

admittedSeqobjectrequired

Show properties

object

idobjectrequired

Show properties

object

sessionIDobjectrequired

Show properties

object

timeCreatednumberrequired

typestringrequired

Allowed:synthetic

dataSessionPending.SyntheticDatarequired

Show properties

textstringrequired

descriptionstring

metadataobject

deliverystringrequired

Allowed:steerqueue

400InvalidRequestError

_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/synthetic" \
  -H "Content-Type: application/json" \
  -d '{
  "id": {},
  "text": "string",
  "description": "string",
  "metadata": {},
  "delivery": "steer",
  "resume": true
}'

const response = await fetch("/api/session/%5Bobject%20Object%5D/synthetic", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "id": {},
  "text": "string",
  "description": "string",
  "metadata": {},
  "delivery": "steer",
  "resume": true
})
});

import requests

response = requests.post(
    "/api/session/%5Bobject%20Object%5D/synthetic",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "id": {},
  "text": "string",
  "description": "string",
  "metadata": {},
  "delivery": "steer",
  "resume": True
},
)

Response

{
  "data": {
    "admittedSeq": {},
    "id": {},
    "sessionID": {},
    "timeCreated": 0,
    "type": "synthetic",
    "data": {
      "text": "string",
      "description": "string",
      "metadata": {}
    },
    "delivery": "steer"
  }
}