APIСправочник API
Запрос повышения частоты
POST /v1/rate-limit-requests
POST /v1/rate-limit-requests
Владелец или администратор с limits:manage. Допускается один ожидающий запрос на пространство и одна отправка в час. Запрос сам по себе не меняет лимит: исключение утверждает оператор.
Доступ
Требуется bearer-авторизация. Описание операции задаёт дополнительные права, роли и ограничения для сессий кабинета. Сам по себе API-ключ их не предоставляет.
Тело запроса
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
requested_rpm | integer | да | Должно превышать действующий лимит частоты. |
reason | string | да |
Полная схема: 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"
}Ответы
| HTTP | Описание | Тип |
|---|---|---|
| 201 | Успешный ответ | application/json: RateLimitRequest |
| 401 | Требуется авторизация | application/problem+json: ProblemDetails |
| 403 | Доступ запрещён | application/problem+json: ProblemDetails |
| 404 | Не найдено | application/problem+json: ProblemDetails |
| 409 | Конфликт | application/problem+json: ProblemDetails |
| 413 | Превышен размер запроса | application/problem+json: ProblemDetails |
| 422 | Ошибка входных данных | application/problem+json: ProblemDetails |
Ответ: RateLimitRequest
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
id | string | да | |
requested_rpm | integer | да | |
reason | string | да | |
status | "pending" ∣ "approved" ∣ "rejected" | да | |
created_at | string | да | |
reviewed_at | string ∣ null | да | |
review_note | string ∣ null | да |
Полная схема
{
"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"
}Эта страница генерируется из OpenAPI. Примеры показывают схемы, а не вымышленные успешные ответы.