Skip to content

Read

Every request goes to your tenant’s own host, https://<tenant id>.atlanticagenticlabs.com, and is scoped to that tenant by row-level security. The examples read AAL_TENANT, AAL_KEY and your Access service token from the environment: see Authentication.

GET /api/v1/agent-map

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/agent-map" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/agent-requests

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/agent-requests" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/agents

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/agents" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/agents/{agent_id}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
agent_id path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/agents/AGENT_ID" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/agents/graph

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/agents/graph" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/agents/last-runs

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/agents/last-runs" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/attention

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/attention" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/audit

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/audit" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/budgets

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/budgets" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/change-requests

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/change-requests" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/change-requests

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
201 Created: the new resource, as JSON.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/change-requests" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
DELETE /api/v1/connections/{cid}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
cid path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X DELETE "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connections/CID" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/connections/{cid}/health

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
cid path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connections/CID/health" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
PUT /api/v1/connections/{cid}/outbound

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
cid path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X PUT "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connections/CID/outbound" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/connections/{cid}/sync

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
cid path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connections/CID/sync" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/connectors

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/connectors/{connector}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
connector path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors/CONNECTOR" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/connectors/{connector}/approval

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
connector path string yes
Status Meaning
201 Created: the new resource, as JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors/CONNECTOR/approval" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/connectors/{connector}/device

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
connector path string yes
Status Meaning
201 Created: the new resource, as JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors/CONNECTOR/device" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/connectors/{connector}/token

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
connector path string yes
Status Meaning
201 Created: the new resource, as JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors/CONNECTOR/token" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/connectors/callback

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors/callback" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/connectors/device/{user_code}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
user_code path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/connectors/device/USER_CODE" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/evals

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/evals" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/evidence

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/evidence" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/forecast

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/forecast" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/grounding

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/grounding" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/health

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/health" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/kills

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/kills" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/knowledge-bases

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/knowledge-bases" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/knowledge-bases/{index}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
index path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/knowledge-bases/INDEX" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/models

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/models" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/models/picker

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/models/picker" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
PUT /api/v1/models/picker

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the request was carried out. The answer is JSON.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X PUT "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/models/picker" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
PUT /api/v1/models/residency

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the request was carried out. The answer is JSON.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X PUT "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/models/residency" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/preapprovals

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/preapprovals" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/recommendations

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/recommendations" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/refusals

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/refusals" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/releases

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/releases" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/reports/{kind}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
kind path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/reports/KIND" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/retrieval

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/retrieval" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/run-targets

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/run-targets" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
PUT /api/v1/run-targets

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the request was carried out. The answer is JSON.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X PUT "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/run-targets" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/run-targets/hosted-requests

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/run-targets/hosted-requests" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
POST /api/v1/run-targets/hosted-requests

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
201 Created: the new resource, as JSON.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X POST "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/run-targets/hosted-requests" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
DELETE /api/v1/run-targets/hosted-requests/{rid}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
rid path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X DELETE "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/run-targets/hosted-requests/RID" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/run-targets/stack

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/run-targets/stack" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/runs

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/runs" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/runs/{run_id_hash}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
run_id_hash path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/runs/RUN_ID_HASH" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/runs/{run_id_hash}/map

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
run_id_hash path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/runs/RUN_ID_HASH/map" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/runs/{run_id_hash}/trace

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
run_id_hash path string yes
Status Meaning
200 OK: the JSON document this route reads.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/runs/RUN_ID_HASH/trace" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/runs/active

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.

200 response:

{
"as_of": "2026-10-30T09:00:00Z",
"stall_after_s": 300,
"live": {
"available": true,
"deployments": [
{
"deployment": "example-air-prod",
"live": true,
"last_live_at": "2026-10-30T08:59:58Z"
}
],
"needs": {
"engine": "0.34.0",
"revision": "1.12"
}
},
"runs": [
{
"run_id_hash": "3f9a0c1e",
"agent": "research:summary",
"pack": "research",
"card": "summary",
"deployment": "example-air-prod",
"started_at": "2026-10-30T08:58:10Z",
"last_seen_at": "2026-10-30T08:59:55Z",
"elapsed_ms": 110000,
"state": "running",
"status": null,
"attempt": 1,
"trigger": "schedule",
"by_hash": null,
"current_step": {
"name": "summarise",
"kind": "model_call",
"span": "a1b2",
"started_at": "2026-10-30T08:59:40Z"
},
"steps": {
"started": 4,
"finished": 3
},
"tokens": {
"input": 5210,
"output": 840,
"cache_read": 4096,
"cache_write": 0
},
"cost_usd": 0.0213,
"estimated": false,
"calls": 3,
"approvals_waiting": 0
}
]
}
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/runs/active" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/runs/active/stream

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/runs/active/stream" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/setup

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/setup" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
PUT /api/v1/setup/{step}

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Parameter In Type Required
step path string yes
Status Meaning
200 OK: the request was carried out. The answer is JSON.
400 Bad request, bad_query: a path or query parameter, or a body field, is missing or not valid.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl -X PUT "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/setup/STEP" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"
GET /api/v1/usage

Authentication: A person’s session, or a machine key with your Access service token, as the route’s role allows. A route that approves, decides, pays or changes a limit refuses a machine key (person_required).

Status Meaning
200 OK: the JSON document this route reads.
4XX Refused: {error, message} with a fixed error code, listed under Errors.
Terminal window
curl "https://$AAL_TENANT.atlanticagenticlabs.com/api/v1/usage" \
-H "Authorization: Bearer $AAL_KEY" \
-H "CF-Access-Client-Id: $CF_ACCESS_CLIENT_ID" \
-H "CF-Access-Client-Secret: $CF_ACCESS_CLIENT_SECRET"