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
owner	string	No	The tenant that holds this action: key: for a sandbox key, org: for a live one.
mode	string	No	sandbox or live. An action is only ever visible to a key of its own mode.
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
idempotencyKey	string or null	No
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
updatedAt	string	No

Full JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "projectId": {
      "type": "string"
    },
    "owner": {
      "type": "string",
      "description": "The tenant that holds this action: key:<id> for a sandbox key, org:<id> for a live one."
    },
    "mode": {
      "type": "string",
      "description": "sandbox or live. An action is only ever visible to a key of its own mode."
    },
    "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"
    },
    "idempotencyKey": {
      "anyOf": [
        {
          "type": "string",
          "description": "The key the original request carried, unique per owner. Recover an action by it with GET /projects/{id}/actions/by-key/{idempotencyKey} when a lost response left you without the id."
        },
        {
          "type": "null"
        }
      ]
    },
    "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"
    },
    "updatedAt": {
      "type": "string"
    }
  }
}