On this page
runs.capacity
Read admission capacity per channel: configured limit and runs holding it
Request
GET /api/v1/runs/capacity
- MCP:
runs_capacity - SDK:
client.runs.capacity(SDK path arguments usepath; MCP usesparams). - Minimum API key role: viewer.
- Idempotency: none.
admission_enabled false, or no phone channel, means Cumulus staff must set call capacity and open admission for this environment.
Input schema
json
{
"parameters": [],
"requestBody": null
}
Responses
json
{
"200": {
"description": "Read admission capacity per channel: configured limit and runs holding it",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunsCapacityResponse200"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
json
{
"components": {
"schemas": {
"RunsCapacityResponse200": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"cloud",
"phone",
"web"
]
},
"active": {
"type": "integer",
"minimum": 0
},
"limit": {
"type": "integer",
"minimum": 0
},
"admission_enabled": {
"type": "boolean"
}
},
"required": [
"channel",
"active",
"limit",
"admission_enabled"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.
Related guides
Content version d1c3ff88Markdown source