Workspace · API Keys
Creates a key.
https://api.pozy.ai/v1/api-keysGuides: Authentication, Security, Per-customer API keys
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Authentication
Request body
application/json, required
namestringrequiredexpiresInintegerscopestringOne of
full,profiles. Defaultfull.profileIdsarray of stringpermissionstringOne of
read-write,read. Defaultread-write.disabledResourceGroupsarray of stringEach item: one of
publishing,engagement,messages,contacts,analytics,ads,telephony,accounts,billing,webhooks,commerce,creator_campaigns,money,calendar,files.
Example
curl -X POST "https://api.pozy.ai/v1/api-keys" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme"
}'const res = await fetch("https://api.pozy.ai/v1/api-keys", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Acme"
}),
});
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/api-keys",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"name": "Acme",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
201 on success
messagestringapiKeyobject11 child fields
idstringnamestringkeyPreviewstringexpiresAtstring (date-time)createdAtstring (date-time)keystringscopestringOne of
full,profiles. Defaultfull.profileIdsarray of object3 child fields
_idstringnamestringcolorstring
permissionstringOne of
read-write,read. Defaultread-write.disabledResourceGroupsarray of stringEach item: one of
publishing,engagement,messages,contacts,analytics,ads,telephony,accounts,billing,webhooks,commerce,creator_campaigns,money,calendar,files.createdByobjectCan be null.
2 child fields
idstringemailstring
{
"message": "Hello from Pozy",
"apiKey": {
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"keyPreview": "string",
"expiresAt": "2026-10-02T09:00:00.000Z",
"createdAt": "2026-10-02T09:00:00.000Z",
"key": "string",
"scope": "full",
"profileIds": [
{
"_id": "635d87e261ae344ef27fd1df",
"name": "Acme",
"color": "string"
}
],
"permission": "read-write",
"disabledResourceGroups": [
"publishing"
],
"createdBy": {
"id": "6bfebd43ddc270f6d2c56fc5",
"email": "alex@example.com"
}
}
}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.