Workspace · Support Assistant
Asks a support question.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Authentication
Headers
| Name | Type | Notes |
|---|---|---|
Idempotency-Key | string | Up to 255 charactersRetries with the same key return the original result. See Idempotency |
Request body
application/json, required
messagestringrequired1 to 10000 characters.
threadIdstringcontextobjectpostIdstringaccountIdstringprofileIdstringrequestIdstringUp to 128 characters. Matches
^[\w.-]{1,128}$.
maxCostUsdnumberDefault
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"
}'import { randomUUID } from "node:crypto";
const res = await fetch("https://api.pozy.ai/v1/support/runs", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Idempotency-Key": randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
message: "Hello from Pozy"
}),
});
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.post(
"https://api.pozy.ai/v1/support/runs",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"message": "Hello from Pozy",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
202 on success
runIdstringrequiredthreadIdstringrequiredstatusstringrequiredOne 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:
| 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 read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.