REST API
POST/ api/ v1/ keys
Создать персональный API-ключ на 90 дней.
| Поле | Значение |
|---|---|
| URL | POST |
| Доступ | Cookie кабинета |
| Scope для ключей | ключи не принимаются – только кабинет (403 CREDENTIAL_) |
| Свежий вход | не старше 10 минут |
| operationId | keysCreate |
Описание#
Создать персональный API-ключ на 90 дней. secret показывается только в этом ответе. Без scopes выдаются course: и profile:; progress: и tutor: включаются отдельно и явно.
Auth: сессия кабинета (cookie). Fresh auth ≤10 минут. Scope: не требуется.
Path: параметров нет.
Query: нет объявленных полей.
Body: application/, ApiKeyCreateRequest. Все вложенные поля и варианты – по ссылке.
| Поле | Тип | Обязательно | Ограничения |
|---|---|---|---|
name | string | да | длина ≥ 1; длина ≤ 64; pattern см. полную схему |
scopes | ( | нет | элементов ≥ 1; элементов ≤ 4 |
Ответ · статус и структура
Ответ: 200 application/, ApiKeyCreated.
Краткая форма: {.
Пример JSON; значения демонстрационные.
{
"key": {
"id": "3f6a1c2e-9b4d-4e7f-8a1b-2c3d4e5f6a7b",
"name": "MacBook · Claude Code",
"prefix": "aos3.sk_EXAMPL",
"scopes": [
"course:read",
"profile:read"
],
"createdAt": "2026-11-10T09:00:00Z",
"expiresAt": "2027-02-08T09:00:00Z",
"lastUsedAt": null,
"revokedAt": null,
"status": "active"
},
"secret": "aos3.sk_EXAMPLE_not-a-real-key_0123456789abcdefghij"
}Ошибки: 401 , 403 , 503 , 429 , 403 , 422 , 403 , 401 , 409 , 429 ; общие ошибки.
Лимиты: До 3 активных персональных ключей; до 10 созданий за день МСК (включая rotation).
Запрос · JSON
{
"name": "MacBook · Claude Code",
"scopes": [
"course:read",
"profile:read"
]
}Пример · curl
curl -sS -i -X POST https://aos.edgelab.space/api/v1/keys \
--cookie '__Host-aos_sess=SESSION_PLACEHOLDER' \
-H 'Origin: https://aos.edgelab.space' \
-H 'Content-Type: application/json' \
-d '{"name":"MacBook · Claude Code","scopes":["course:read","profile:read"]}'Ответы по контракту#
Тело запроса: ApiKeyCreateRequest.
| Статус | Тип | Схема | Описание |
|---|---|---|---|
| 200 | application/json | ApiKeyCreated | Успех |
| ошибка | application/json | ErrorBody | Ошибка; коды: UNAUTHENTICATED, NO_ENTITLEMENT, ENTITLEMENT_UNAVAILABLE, RATE_LIMITED, ORIGIN_REJECTED, VALIDATION_FAILED, CREDENTIAL_NOT_ALLOWED, REAUTH_REQUIRED, KEY_LIMIT, KEY_RATE |
Машиночитаемый контракт: openapi.json, операция keysCreate.