PUT /users/me/limits
https://api.voygr.tech/users/me/limits
Overview
Raise (or lower) how many calls this key may have in flight at once. Use this to recover from a 409 concurrent_call_not_allowed: read your ceiling from max_concurrent_calls_ceiling on GET /users/me, then PUT a value up to it. A value above the ceiling is refused with 403 (nothing is changed). A new key starts at 1, so raise it here when you need parallel dialing.
Authentication
- API key in header
X-API-Key: Your customer API key (pk_live_...), sent on every request. Self-serve at https://api.voygr.tech/checkout.
Request body
required
application/json
Schema: SetLimitsRequest
Raise the in-flight cap to 1
{
"max_concurrent_calls": 1
}Responses
200
The new limit, echoed with the ceiling it was checked against.
application/json
Schema: LimitsResponse
set
{
"max_concurrent_calls": 1,
"max_concurrent_calls_ceiling": 1
}401
Missing or invalid X-API-Key.
application/json
X-API-Key header absent
{
"detail": {
"error": "API key required"
}
}X-API-Key doesn't resolve to an active key
{
"detail": {
"error": "invalid API key"
}
}403
Requested value exceeds the admin-set ceiling on this key - nothing was changed.
application/json
ceilingexceeded
{
"detail": {
"error": "max_concurrent_calls_ceiling_exceeded",
"requested": 5,
"max_allowed": 1
}
}422
Body failed validation (e.g. max_concurrent_calls below 1, or above the service hard maximum).
application/json
toolow
{
"detail": [
{
"type": "greater_than_equal",
"loc": [
"body",
"max_concurrent_calls"
],
"msg": "Input should be greater than or equal to 1"
}
]
}Schemas
SetLimitsRequest
Type: object
Body for PUT /users/me/limits. Raise (or lower) the number of calls this key may have in flight at once.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
max_concurrent_calls | integer | required | How many calls this key may have in flight simultaneously (scheduled / dialing / in_progress count as in-flight). Required, with no default. Must be at least 1, and no more than the admin-set ceiling on the key (max_concurrent_calls_ceiling on GET /users/me) - a higher value is refused with 403. min 1 Example: 1 |
LimitsResponse
Type: object
PUT /users/me/limits success body: the new in-flight cap and the admin ceiling it was checked against.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
max_concurrent_calls | integer | required | The value now in effect for this key. Example: 1 |
max_concurrent_calls_ceiling | integer | required | Admin-set upper bound for this key. max_concurrent_calls can never exceed it. Example: 1 |
On this page
