Chat and runs

GET/v1/runs/{id}

One run: its state, its answer, and the proposals that wait for a person.

What it does

A run this key's maker started, in the app or with any key. Poll it every few seconds until the status is done, failed or cancelled.

Who may call it

A key whose maker's role holds agents (ask the agents and approve what they do), after the fence, for the shop or category it names.

Request

HTTP

GET https://panlytics.net/api/v1/runs/{id}

Parameters

Name	In	Type	Required	What it is
`id`	path	string (UUID)	Yes	The run's id, as POST /v1/chat answered it.
`Authorization`	header	string	Yes	Bearer, a space, then the key.

Example request

curl https://panlytics.net/api/v1/runs/6f1c2b9e-2d4f-4f7e-9a51-0c3b8e7d1a20 \
  -H "Authorization: Bearer $PANLYTICS_KEY"

import os

import requests

response = requests.get(
    "https://panlytics.net/api/v1/runs/6f1c2b9e-2d4f-4f7e-9a51-0c3b8e7d1a20",
    headers={"Authorization": f"Bearer {os.environ['PANLYTICS_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://panlytics.net/api/v1/runs/6f1c2b9e-2d4f-4f7e-9a51-0c3b8e7d1a20", {
  headers: {
    Authorization: `Bearer ${process.env.PANLYTICS_KEY}`,
  },
});
if (!response.ok) throw new Error(`Panlytics answered ${response.status}`);
console.log(await response.json());

Response

200: The answer, as JSON.

Field	Type	Always there	What it is
`id`	string (UUID)	Yes	The run's id.
`threadId`	string (UUID)	Yes	The conversation the run belongs to.
`status`	string: queued, running, awaiting_approval, done, failed, cancelled	Yes	Where the run stands. done, failed and cancelled are final.
`answer`	string or null	Yes	The assistant's answer. Null until it has one.
`error`	object or null	Yes	Why the run did not finish, as a code and its sentence.
`error.code`	string	Yes	A stable code from the Errors page.
`error.error`	string	Yes	The code's sentence.
`steps`	integer	Yes	How many steps the run has taken.
`costEur`	number	Yes	What the run has spent of the shop's AI budget, in euros.
`startedAt`	string (ISO 8601)	Yes	When the run started, in UTC.
`endedAt`	string (ISO 8601) or null	Yes	When the run ended, in UTC. Null while it runs.
`waitingForPerson[]`	object[]	Yes	Proposals that wait for a person to approve them in the app. A key can never approve them.
`waitingForPerson[].id`	string	Yes	The proposal's id.
`waitingForPerson[].tool`	string	Yes	What the assistant proposes to do.
`waitingForPerson[].reason`	string or null	Yes	Why, in the assistant's words, or null.
`waitingForPerson[].createdAt`	string (ISO 8601)	Yes	When it was proposed, in UTC.

Example response

200

{
  "id": "6f1c2b9e-2d4f-4f7e-9a51-0c3b8e7d1a20",
  "threadId": "0b9e4a3c-71d2-4c55-8f0e-3a6d2b1c9e47",
  "status": "done",
  "answer": "Sparkling water ran out on 3 days.",
  "error": null,
  "steps": 2,
  "costEur": 0.004,
  "startedAt": "2026-10-25T09:00:00.000Z",
  "endedAt": "2026-10-25T09:00:09.000Z",
  "waitingForPerson": []
}

Errors

A refusal is JSON with a code, a sentence in error, and a requestId when the fault is ours. Read the code, not the sentence. Every code is listed on Errors.

Status	Code	When	What to do
400	`api.invalid`	A path id, a query parameter, a header or a body field is missing or not valid. `detail` names the field.	Read that endpoint in the API reference, correct the field and call again.
401	`api.key_missing`	The call had no Authorization header.	Send the key in the Authorization header as Bearer, then call again.
401	`api.key_refused`	The key is wrong, revoked, past its end, or its maker or company no longer allows it (developer mode off, the maker removed or switched off, or the maker's role lost the developer ability).	Ask the person who gave you the key to make a new one.
401	`api.wrong_key_kind`	This key does not open these endpoints.	Use the key these endpoints were made for, or ask the person who gave you the key.
403	`refused`	The key's maker may not do this here: their role lacks the ability, or the shop or category is outside their reach.	Ask the CEO for a role that allows it, or call it for a shop or category the role reaches.
403	`auth.not_fresh`	This step needs you to prove it is you.	Confirm your password or passkey, then try again.
404	`not_found.said`	Nothing with that id in the key's company. An id of another company answers the same.	Check the id. List the shop or category it belongs to and take the id from there.
429	`api.rate_limited`	The key made more than 120 calls in this minute. Wait the seconds in Retry-After.	Wait the seconds in Retry-After, then call again.
500	`server`	Something failed on our side. The answer carries a requestId to quote.	Try again in a minute; if it keeps happening, report it.
503	`developer.unavailable`	API keys are not set up on this deployment yet.	Report it, and we will switch them on.