Skip to main content
POST
/
api
/
runs
Create a run
curl --request POST \
  --url https://api.example.com/api/runs \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "<string>",
  "items": [
    {}
  ],
  "version": "<string>",
  "metadata": {},
  "status": "in_progress",
  "state": "<unknown>",
  "failReason": "<unknown>"
}
'
{
  "id": "<string>",
  "createdAt": "2023-12-25",
  "updatedAt": "2023-12-25",
  "finishedAt": "2023-12-25",
  "status": "<string>",
  "version": "<string>",
  "metadata": {},
  "sessionItems": [
    {
      "id": "<string>",
      "createdAt": "2023-12-25",
      "updatedAt": "2023-12-25",
      "runId": "<string>",
      "sessionId": "<string>",
      "content": "<unknown>"
    }
  ],
  "sessionId": "<string>",
  "versionId": "<string>",
  "failReason": "<unknown>"
}

Body

application/json
sessionId
string
required
items
object[]
required
version
string
required
metadata
object
status
enum<string>
Available options:
in_progress,
completed,
cancelled,
failed
state
unknown
failReason
unknown

Response

Undescribed

id
string
required
createdAt
string<date>
required
updatedAt
string<date>
required
finishedAt
string<date> | null
required
status
string
required
version
string
required
metadata
object
required
sessionItems
object[]
required
sessionId
string
required
versionId
string | null
required
failReason
unknown