APIAPI reference
Ask an operator to approve a higher request rate
POST /v1/rate-limit-requests
POST /v1/rate-limit-requests
Owner/admin with limits:manage. One pending request per workspace; one submission per hour. Submitting a request does not change limits. Only an operator review can approve the override.
Authorization
This operation requires a bearer credential. The description defines additional role, scope or first-party-session restrictions; an API key does not grant those permissions by itself.
Request body
| Property | Type | Required | Details |
|---|---|---|---|
requested_rpm | integer | yes | Must exceed the current effective rate. |
reason | string | yes |
Full schema: RateLimitIncrease
{
"properties": {
"requested_rpm": {
"type": "integer",
"maximum": 1000000,
"minimum": 1,
"title": "Requested Rpm",
"description": "Must exceed the current effective rate."
},
"reason": {
"type": "string",
"maxLength": 2000,
"minLength": 10,
"title": "Reason"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"requested_rpm",
"reason"
],
"title": "RateLimitIncrease"
}Responses
| HTTP | Details | Type |
|---|---|---|
| 201 | Successful Response | application/json: RateLimitRequest |
| 401 | Unauthorized | application/problem+json: ProblemDetails |
| 403 | Forbidden | application/problem+json: ProblemDetails |
| 404 | Not Found | application/problem+json: ProblemDetails |
| 409 | Conflict | application/problem+json: ProblemDetails |
| 413 | Request Entity Too Large | application/problem+json: ProblemDetails |
| 422 | Unprocessable Entity | application/problem+json: ProblemDetails |
Response: RateLimitRequest
| Property | Type | Required | Details |
|---|---|---|---|
id | string | yes | |
requested_rpm | integer | yes | |
reason | string | yes | |
status | "pending" ∣ "approved" ∣ "rejected" | yes | |
created_at | string | yes | |
reviewed_at | string ∣ null | yes | |
review_note | string ∣ null | yes |
Full schema
{
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"requested_rpm": {
"type": "integer",
"title": "Requested Rpm"
},
"reason": {
"type": "string",
"title": "Reason"
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"rejected"
],
"title": "Status"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"reviewed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reviewed At"
},
"review_note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Review Note"
}
},
"type": "object",
"required": [
"id",
"requested_rpm",
"reason",
"status",
"created_at",
"reviewed_at",
"review_note"
],
"title": "RateLimitRequest"
}This page is generated from OpenAPI; examples are schemas, not a fabricated successful response.