VAvapiai
Traffic Allocations

Get traffic allocation

Changed on

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

get/traffic-allocations/{id}

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

idstring required

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

orgIdstring required
assistantIdstring

The assistant this allocation splits calls for.

allocationIntent'follow-latest' | 'explicit' required

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

createdAtstring date-time required

When this allocation was created, which is also when it took effect.

actorType'user' | 'api-key' | 'system' required

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

actorIdstring

The user id or API key id that created this allocation. Absent for system rows.

actorEmailstring

Email of the user who created this allocation, as of that time.

descriptionstring

The note given when this allocation was created, if any.

Changes

Some revisions have not been checked yet.