Chat and runs

POST/v1/chat

Ask Panlytics a question about a shop. The answer comes back as a run.

What it does

Starts the same assistant the app has, counted against the shop's daily AI budget and the limit of 30 runs an hour per person. Read the run with GET /v1/runs/{id}, or follow it with GET /v1/runs/{id}/stream. Anything the assistant proposes to do waits for a person to approve it in the app: a key can never approve it. Send an Idempotency-Key header so a retry never starts a second run.

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
POST https://panlytics.net/api/v1/chat

Parameters

NameInTypeRequiredWhat it is
AuthorizationheaderstringYesBearer, a space, then the key.
Idempotency-KeyheaderstringNoAny string up to 255 characters, new for each new request. The same key with the same request within 24 hours answers with the first answer again and does nothing twice.

Body

Sent as application/json.

FieldTypeRequiredWhat it is
shopIdintegerYesThe shop the question is about. Its daily AI budget pays for the run.
promptstringYesThe question, in plain words.
categoryIdintegerNoA category of that shop, to ask about its newest report.
threadIdstring (UUID)NoA conversation to continue: any conversation in the company that the key's maker may open.

Example request

curl -X POST https://panlytics.net/api/v1/chat \
  -H "Authorization: Bearer $PANLYTICS_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "shopId": 12,
  "prompt": "Which drinks ran out most often last month?"
}'

Response

201: Created. The answer is what was made, as JSON.

FieldTypeAlways thereWhat it is
runIdstring (UUID)YesThe run's id. Read it with GET /v1/runs/{id}.
threadIdstring (UUID)YesThe conversation the run belongs to. Send it as threadId to ask a follow-up.
statusstring (always "queued")YesAlways queued: the run has been handed to the engine.

Example response

201
{
  "runId": "6f1c2b9e-2d4f-4f7e-9a51-0c3b8e7d1a20",
  "threadId": "0b9e4a3c-71d2-4c55-8f0e-3a6d2b1c9e47",
  "status": "queued"
}

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.
400bad_request.saidChange it and try 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.
403refused.saidAsk an owner of your company if you need this.
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.
409report.noneThere is no report yet to work from.Upload a report first, with POST /v1/shops/{id}/reports.
409store.noneNo shop is open in this session.Choose a shop from the switcher and try again.
409conflict.saidThe shop already has a supplier with that name.Use another name, or change the supplier that has it.
409api.idempotency_conflictThat Idempotency-Key was sent before with a different request.Send a new key with a new request, or send the first request again unchanged.
409api.idempotency_busyThe first request with that Idempotency-Key is still running.Wait a few seconds, then send it again.
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.
429api.ai_budgetThe shop has used today's AI budget. Retry-After holds the seconds until midnight UTC.Try again after midnight UTC, or ask an owner to raise the daily limit in AI settings.
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.
503agent.unreachableThe assistant is not answering right now.Everything else still works; try the assistant again in a few minutes.