Chat and runs

GET/v1/runs/{id}/stream

Follow one run live, as server-sent events.

What it does

The same events the app's own conversation reads: state first, then delta for text as it is written, event for each step, and ended last. Each event is one JSON object on a data: line. Reconnect with ?from= set to the last offset you saw and nothing is missed. The stream closes when the run ends or the key ends; a key that is revoked stops its runs too, within one 15 second ping. One key keeps at most 3 streams open at once: a fourth answers 429 with Retry-After.

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}/stream

Parameters

NameInTypeRequiredWhat it is
idpathstring (UUID)YesThe run's id, as POST /v1/chat answered it.
fromqueryintegerNoThe offset to start from.
AuthorizationheaderstringYesBearer, a space, then the key.

Example request

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

Response

200, as text/event-stream. Each event is a data: line holding one JSON object, with these fields:

FieldTypeAlways thereWhat it is
tstringYesWhich kind of event: state, delta, event or ended.

Example response

200
data: {"t":"state","status":"running","code":null}

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.

StatusCodeWhenWhat to do
400api.invalidA 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.
401api.key_missingThe call had no Authorization header.Send the key in the Authorization header as Bearer, then call again.
401api.key_refusedThe 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.
401api.wrong_key_kindThis key does not open these endpoints.Use the key these endpoints were made for, or ask the person who gave you the key.
403refusedThe 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.
403auth.not_freshThis step needs you to prove it is you.Confirm your password or passkey, then try again.
404not_found.saidNothing 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.
429api.rate_limitedThe key made more than 120 calls in this minute. Wait the seconds in Retry-After.Wait the seconds in Retry-After, then call again.
429net.rate_limitedThe key's maker started 30 runs in the last hour.Wait a few minutes, then start the run again. The answer carries limit: 30.
500serverSomething failed on our side. The answer carries a requestId to quote.Try again in a minute; if it keeps happening, report it.
503developer.unavailableAPI keys are not set up on this deployment yet.Report it, and we will switch them on.