Inspect Photon shared project or dedicated numbers for channel setup

POST/api/chat-endpoints/{endpointId}/photon/inspect
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Inspect Photon shared project or dedicated numbers for channel setup.

Requires a member with connection-management access. The project secret is write-only input. Returns the project's actual allocation and eligibility for shared DMs or dedicated lines, never project secrets or minted line tokens. Responses are not cached. Inspection alone does not activate the channel.

Authorization

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.

Path parameters

endpointIdstring (uuid)RequiredThe endpoint's id.

Request body

application/json · required

projectIdstringRequired1–128 characterspattern: ^[a-zA-Z0-9_-]+$
projectSecretstringRequired1–4096 characters

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
429Photon request limit reached; retry laterToo many requests; wait for Retry-After seconds.
502Photon returned an invalid response; inspect provider health
503Photon temporarily unavailable; retry laterA dependency is unavailable; retry with backoff.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Chat channels