Skip to content

Session ​

Type: object

FieldRequiredTypeDescription and constraints
allow_multiple_runsYesbooleanImmutable policy allowing subsequent runs. False means the sandbox is deleted after the first run terminates; session history remains available.
last_run_created_atYesstringCreation time of the latest run, not the last activity time. format: "date-time"
usageYesUsage
phaseYesstring / null
namespaceYesstring / nullLogical integration or workflow name. Opaque identifier, 1–128 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
external_keyYesstring / nullSource-qualified external object key; not unique across sessions. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.
active_run_idYesstring / null
configurationYesConfiguration
created_atYesstringformat: "date-time"
errorYesError / null
final_messageYesMessage / null
idYesstringformat: "uuid"
last_run_idYesstringformat: "uuid"
sandboxYesSandboxState
statusYesRunStatus

JSON Schema ​

json
{
  "properties": {
    "allow_multiple_runs": {
      "description": "Immutable policy allowing subsequent runs. False means the sandbox is deleted after the first run terminates; session history remains available.",
      "type": "boolean"
    },
    "last_run_created_at": {
      "description": "Creation time of the latest run, not the last activity time.",
      "format": "date-time",
      "type": "string"
    },
    "usage": {
      "$ref": "#/components/schemas/Usage"
    },
    "phase": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "preparation",
            "after_create",
            "before_run",
            "agent",
            "after_run"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "namespace": {
      "description": "Logical integration or workflow name. Opaque identifier, 1–128 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "external_key": {
      "description": "Source-qualified external object key; not unique across sessions. Opaque identifier, 1–512 UTF-8 bytes; no NUL or whitespace-only value. Compared exactly, without normalization.",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "active_run_id": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Active Run Id"
    },
    "configuration": {
      "$ref": "#/components/schemas/Configuration"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "error": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Error"
        },
        {
          "type": "null"
        }
      ]
    },
    "final_message": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Message"
        },
        {
          "type": "null"
        }
      ]
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "last_run_id": {
      "format": "uuid",
      "title": "Last Run Id",
      "type": "string"
    },
    "sandbox": {
      "$ref": "#/components/schemas/SandboxState"
    },
    "status": {
      "$ref": "#/components/schemas/RunStatus"
    }
  },
  "required": [
    "allow_multiple_runs",
    "usage",
    "phase",
    "namespace",
    "external_key",
    "id",
    "created_at",
    "last_run_created_at",
    "configuration",
    "sandbox",
    "active_run_id",
    "last_run_id",
    "status",
    "final_message",
    "error"
  ],
  "title": "Session",
  "type": "object"
}

All schemas · HTTP API