Workspace · Support Assistant

Get a support answer

Fetches a support answer.

GEThttps://api.pozy.ai/v1/support/runs/{runId}

getSupportAnswer

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Authentication

Path parameters

Name	Type	Notes
`runId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/support/runs/6e3431a916a6bb08fe30481d" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/support/runs/6e3431a916a6bb08fe30481d", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/support/runs/6e3431a916a6bb08fe30481d",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

runIdstringrequired
threadIdstringrequired
statusstringrequired
One of queued, running, completed, needs_human, failed.
stopReasonstringrequired
One of answered, human_review, cost_cap, deadline, max_iterations, error, expired. Can be null.
questionstringrequired
Can be null.
answerstringrequired
Can be null.
diagnosisobjectrequired
One of:
Support Run Diagnosis (5 fields)
- categorystringrequired
  One of account_connection, content_rejected, rate_limited, platform_issue, pozy_issue, billing, configuration, how_to, other.
- causestringrequired
  Can be null.
- fixStepsarray of stringrequired
- docsLinksarray of stringrequired
- whoMustActstringrequired
  One of integrator, end_user, pozy, platform, none.
usageobjectrequired
- inputTokensintegerrequired
- outputTokensintegerrequired
- cacheReadTokensintegerrequired
- cacheWriteTokensintegerrequired
costUsdnumberrequired
maxCostUsdnumberrequired
createdAtstring (date-time)required
startedAtstring (date-time)required
Can be null.
finishedAtstring (date-time)required
Can be null.
supportTicketobjectrequired
Can be null.
- openedAtstring (date-time)required
pollAfterSecondsinteger

200 response

{
  "runId": "6e3431a916a6bb08fe30481d",
  "threadId": "60186572e25ff711298bf12e",
  "status": "queued",
  "stopReason": "answered",
  "question": "string",
  "answer": "string",
  "diagnosis": {
    "category": "account_connection",
    "cause": "string",
    "fixSteps": [
      "string"
    ],
    "docsLinks": [
      "string"
    ],
    "whoMustAct": "integrator"
  },
  "usage": {
    "inputTokens": 1,
    "outputTokens": 1,
    "cacheReadTokens": 1,
    "cacheWriteTokens": 1
  },
  "costUsd": 12.5,
  "maxCostUsd": 12.5,
  "createdAt": "2026-10-02T09:00:00.000Z",
  "startedAt": "2026-10-02T09:00:00.000Z",
  "finishedAt": "2026-10-02T09:00:00.000Z",
  "supportTicket": {
    "openedAt": "2026-10-02T09:00:00.000Z"
  },
  "pollAfterSeconds": 1
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Support Assistant

GETList a thread's support answers POSTAsk a support question