Skip to content
AdiosDocumentation
Browse documentation

Agent plans API

Inspect saved plans and their steps.

Use API authentication for protected requests. Examples use your own resource IDs and a temporary token; saved response examples are synthetic.

MethodPathOperation
GET/v1/agent_planList agent plans
GET/v1/agent_plan/{id}Get agent plan
GET/v1/agent_plan_stepList agent plan steps
GET/v1/agent_plan_step/{id}Get agent plan step

List agent plans

GET /v1/agent_plan

Returns a paginated list of AgentPlan

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pagequerynoPage number
per_pagequerynoItems per page

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_plan" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

List of AgentPlan

Response fields

FieldTypeDescription
dataarray
data[].agent_plan_idstring
data[].agent_run_idstring
data[].agent_session_idstring
data[].created_atinteger(Unix timestamp)
data[].deleted_atinteger(Unix timestamp)
data[].metadataobject
data[].statusstringAllowed: pending, running, blocked, complete, failed, cancelled.
data[].summaryobject
data[].team_idstring
data[].titlestring
data[].updated_atinteger(Unix timestamp)
data[].workspace_idstring
paginationobject
pagination.pageintegerCurrent page number
pagination.per_pageintegerNumber of items per page
pagination.totalintegerTotal number of items

Illustrative example; not a live response:

{
  "data": [
    {
      "agent_plan_id": "000000000000000000000000001",
      "agent_run_id": "",
      "agent_session_id": "000000000000000000000000001",
      "created_at": 1791072000,
      "deleted_at": 0,
      "metadata": {},
      "status": "pending",
      "summary": "",
      "team_id": "000000000000000000000000001",
      "title": "Agent plan",
      "updated_at": 1791072000,
      "workspace_id": ""
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Get agent plan

GET /v1/agent_plan/{id}

Returns a single AgentPlan

Set agent_plan_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_plan/${ADIOS_AGENT_PLAN_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

AgentPlan

Response fields

FieldTypeDescription
agent_plan_idstring
agent_run_idstring
agent_session_idstring
created_atinteger(Unix timestamp)
deleted_atinteger(Unix timestamp)
metadataobject
statusstringAllowed: pending, running, blocked, complete, failed, cancelled.
summaryobject
team_idstring
titlestring
updated_atinteger(Unix timestamp)
workspace_idstring

Illustrative example; not a live response:

{
  "agent_plan_id": "000000000000000000000000001",
  "agent_run_id": "",
  "agent_session_id": "000000000000000000000000001",
  "created_at": 1791072000,
  "deleted_at": 0,
  "metadata": {},
  "status": "pending",
  "summary": "",
  "team_id": "000000000000000000000000001",
  "title": "Agent plan",
  "updated_at": 1791072000,
  "workspace_id": ""
}

List agent plan steps

GET /v1/agent_plan_step

Returns a paginated list of AgentPlanStep

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pagequerynoPage number
per_pagequerynoItems per page

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_plan_step" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

List of AgentPlanStep

Response fields

FieldTypeDescription
dataarray
data[].agent_plan_idstring
data[].agent_plan_step_idstring
data[].agent_version_idstring
data[].child_agent_run_idstring
data[].completed_atinteger(Unix timestamp)
data[].created_atinteger(Unix timestamp)
data[].deleted_atinteger(Unix timestamp)
data[].dependenciesobject
data[].descriptionobject
data[].errorobject
data[].execution_task_idstring
data[].metadataobject
data[].positioninteger
data[].role_keystring
data[].specialist_rolestringAllowed: lead, security, code_quality, test_verification.
data[].started_atinteger(Unix timestamp)
data[].statusstringAllowed: pending, running, passed, failed, blocked, skipped.
data[].team_idstring
data[].titlestring
data[].tool_namestring
data[].updated_atinteger(Unix timestamp)
paginationobject
pagination.pageintegerCurrent page number
pagination.per_pageintegerNumber of items per page
pagination.totalintegerTotal number of items

The schema-derived collection illustration is omitted here because it does not satisfy the published response schema. Use the field contract above.

Get agent plan step

GET /v1/agent_plan_step/{id}

Returns a single AgentPlanStep

Set agent_plan_step_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/agent_plan_step/${ADIOS_AGENT_PLAN_STEP_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

AgentPlanStep

Response fields

FieldTypeDescription
agent_plan_idstring
agent_plan_step_idstring
agent_version_idstring
child_agent_run_idstring
completed_atinteger(Unix timestamp)
created_atinteger(Unix timestamp)
deleted_atinteger(Unix timestamp)
dependenciesobject
descriptionobject
errorobject
execution_task_idstring
metadataobject
positioninteger
role_keystring
specialist_rolestringAllowed: lead, security, code_quality, test_verification.
started_atinteger(Unix timestamp)
statusstringAllowed: pending, running, passed, failed, blocked, skipped.
team_idstring
titlestring
tool_namestring
updated_atinteger(Unix timestamp)

The schema-derived collection illustration is omitted here because it does not satisfy the published response schema. Use the field contract above.