Restack · Schema

Agent Run

Represents the status and result of a Restack AI agent execution run.

AI AgentsWorkflowsOrchestrationEnterprisePython

Properties

Name Type Description
runId string Unique identifier for the agent run.
agentName string The name of the agent that was executed.
status string Current execution status of the agent run.
input object Input parameters provided when scheduling the agent.
output object Output returned by the agent upon completion.
error string Error message if the agent run failed.
createdAt string ISO 8601 timestamp when the agent run was created.
completedAt string ISO 8601 timestamp when the agent run completed.
View JSON Schema on GitHub

JSON Schema

restack-agent-run-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restack/refs/heads/main/json-schema/restack-agent-run-schema.json",
  "title": "Agent Run",
  "description": "Represents the status and result of a Restack AI agent execution run.",
  "type": "object",
  "properties": {
    "runId": {
      "type": "string",
      "description": "Unique identifier for the agent run.",
      "pattern": "^run_[a-zA-Z0-9]+$"
    },
    "agentName": {
      "type": "string",
      "description": "The name of the agent that was executed."
    },
    "status": {
      "type": "string",
      "description": "Current execution status of the agent run.",
      "enum": ["queued", "running", "completed", "failed"]
    },
    "input": {
      "type": "object",
      "description": "Input parameters provided when scheduling the agent.",
      "additionalProperties": true
    },
    "output": {
      "type": "object",
      "description": "Output returned by the agent upon completion.",
      "additionalProperties": true
    },
    "error": {
      "type": "string",
      "description": "Error message if the agent run failed."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the agent run was created."
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the agent run completed."
    }
  },
  "required": ["runId", "status"]
}