Skip to navigation
Traffic Allocations

Get traffic allocation

Returns a single allocation by id, including its targets and actor attribution.

Authentication

AuthorizationBearer

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the Authorization header as Bearer <token>. Keep private API keys out of client-side code and public repositories.

Path parameters

idstringRequired

Response

idstring
Unique identifier. The most recently created allocation for an assistant is the one in effect.
orgIdstring
allocationIntentenum

‘explicit’ splits calls across this allocation’s targets. ‘follow-latest’ sends every call to the newest published version.

Allowed values:
createdAtdatetime
When this allocation was created, which is also when it took effect.
actorTypeenum

Who created this allocation. ‘system’ means Vapi created it automatically, for example when a publish advances a follow-latest allocation.

Allowed values:
targetslist of objects

The versions this allocation splits calls across, in position order. Empty for follow-latest allocations.

assistantIdstringOptional
The assistant this allocation splits calls for.
actorIdstringOptional
The user id or API key id that created this allocation. Absent for system rows.
actorEmailstringOptional
Email of the user who created this allocation, as of that time.
descriptionstringOptional
The note given when this allocation was created, if any.

Errors

403
Forbidden Error
404
Not Found Error