TaskResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/scale-ai/json-schema/scale-ai-task-response-schema.json",
  "title": "TaskResponse",
  "description": "Task response model with optional related data based on relationships",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/scale-ai-tasks-api-openapi.yml#/components/schemas/TaskResponse",
  "properties": {
    "id": {
      "type": "string",
      "title": "Unique Task ID"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Unique name of the task"
    },
    "status": {
      "anyOf": [
        {
          "$ref": "#/$defs/TaskStatus"
        },
        {
          "type": "null"
        }
      ],
      "title": "The current status of the task"
    },
    "status_reason": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "The reason for the current task status"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "The timestamp when the task was created"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "The timestamp when the task was last updated"
    },
    "cleaned_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "The timestamp when the task's content was cleaned for retention compliance; null when active"
    },
    "params": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Task parameters"
    },
    "task_metadata": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Task metadata"
    },
    "agents": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/Agent"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Agents associated with this task (only populated when 'agent' view is requested)"
    }
  },
  "type": "object",
  "required": [
    "id"
  ],
  "$defs": {
    "ACPType": {
      "type": "string",
      "enum": [
        "sync",
        "async",
        "agentic"
      ],
      "title": "ACPType"
    },
    "Agent": {
      "properties": {
        "id": {
          "type": "string",
          "title": "Id",
          "description": "The unique identifier of the agent."
        },
        "name": {
          "type": "string",
          "title": "Name",
          "description": "The unique name of the agent."
        },
        "description": {
          "type": "string",
          "title": "Description",
          "description": "The description of the action."
        },
        "status": {
          "$ref": "#/$defs/AgentStatus",
          "description": "The status of the action, indicating if it's building, ready, failed, etc.",
          "default": "Unknown"
        },
        "acp_type": {
          "$ref": "#/$defs/ACPType",
          "description": "The type of the ACP Server (Either sync or async)"
        },
        "status_reason": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Status Reason",
          "description": "The reason for the status of the action."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "title": "Created At",
          "description": "The timestamp when the agent was created"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "title": "Updated At",
          "description": "The timestamp when the agent was last updated"
        },
        "registration_metadata": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Registration Metadata",
          "description": "The metadata for the agent's registration."
        },
        "registered_at": {
          "anyOf": [
            {
              "type": "string",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ],
          "title": "Registered At",
          "description": "The timestamp when the agent was last registered"
        },
        "agent_input_type": {
          "anyOf": [
            {
              "$ref": "#/$defs/AgentInputType"
            },
            {
              "type": "null"
            }
          ],
          "description": "The type of input the agent expects."
        },
        "production_deployment_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Production Deployment Id",
          "description": "ID of the current production deployment."
        }
      },
      "type": "object",
      "required": [
        "id",
        "name",
        "description",
        "acp_type",
        "created_at",
        "updated_at"
      ],
      "title": "Agent"
    },
    "AgentInputType": {
      "type": "string",
      "enum": [
        "text",
        "json"
      ],
      "title": "AgentInputType"
    },
    "AgentStatus": {
      "type": "string",
      "enum": [
        "Ready",
        "Failed",
        "Unknown",
        "Deleted",
        "Unhealthy",
        "BuildOnly"
      ],
      "title": "AgentStatus"
    },
    "TaskStatus": {
      "type": "string",
      "enum": [
        "CANCELED",
        "COMPLETED",
        "FAILED",
        "RUNNING",
        "INTERRUPTED",
        "TERMINATED",
        "TIMED_OUT",
        "DELETED"
      ],
      "title": "TaskStatus"
    }
  }
}