Workspace · Support Assistant

Ask a support question

Asks a support question.

POSThttps://api.pozy.ai/v1/support/runs
askSupportQuestion

Guide: Idempotency and safe retries

Request

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

Headers

NameTypeNotes
Idempotency-KeystringUp to 255 charactersRetries with the same key return the original result. See Idempotency

Request body

application/json, required

  • messagestringrequired

    1 to 10000 characters.

  • threadIdstring
  • contextobject
    • postIdstring
    • accountIdstring
    • profileIdstring
    • requestIdstring

      Up to 128 characters. Matches ^[\w.-]{1,128}$.

  • maxCostUsdnumber

    Default 3. 0.5 to 3.

Example

curl -X POST "https://api.pozy.ai/v1/support/runs" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "Hello from Pozy"
}'

Response

202 on success

  • runIdstringrequired
  • threadIdstringrequired
  • statusstringrequired

    One of queued.

  • pollAfterSecondsintegerrequired
202 response
{
  "runId": "6e3431a916a6bb08fe30481d",
  "threadId": "60186572e25ff711298bf12e",
  "status": "queued",
  "pollAfterSeconds": 1
}

Errors

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

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Support Assistant