Skip to content

Action response model

All models · Download OpenAPI

Nullable fields represent unknown values; they do not imply zero cost or a completed action.

Field Type Required Details
id string No
projectId string No
kind string No
stageId string or null No
availability string No
status string No queued, running, draft_ready, awaiting_approval, approved, sent, done or failed
input object No
output ActionOutput or null No Null until a result is saved. Read the kind-specific value at action.output.result.
error string or null No
agentRunId string or null No
taskId string or null No
createdAt string No
Full JSON schema
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"projectId": {
"type": "string"
},
"kind": {
"type": "string"
},
"stageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"availability": {
"type": "string"
},
"status": {
"type": "string",
"description": "queued, running, draft_ready, awaiting_approval, approved, sent, done or failed"
},
"input": {
"type": "object",
"properties": {}
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/ActionOutput"
},
{
"type": "null"
}
],
"description": "Null until a result is saved. Read the kind-specific value at action.output.result."
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"agentRunId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"taskId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
}
}
}