Dokumentacja API
Aktualizuj Klucz API
Zaktualizuj istniejący standardowy Klucz API i pobierz jego bieżące podsumowanie użycia.
Zaktualizuj istniejący standardowy Klucz API i pobierz jego bieżące podsumowanie użycia.
Punkt końcowy
- Bazowy URL
https://runapi.ai- Wersja API
v1- Uwierzytelnianie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
02
Treść JSONŻądanie
Wysyłaj wartości wyłącznie w podanej lokalizacji żądania.
Parametry ścieżki1 pole
idstring
Wymagane
Prefiks ID klucza API, na przykład token_123.
Treść JSON6 pola
allowed_modelsarray | null
Opcjonalne
Zastępcza lista dozwolonych modeli; null lub pusta tablica czyści ją.
credit_limit_centsinteger | null
Opcjonalne
Limit wydatków w centach USD; null usuwa limit i interwał resetowania.
credit_limit_reset_intervalstring | null
Opcjonalne
Częstotliwość resetowania limitu wydatków.
Dozwolone wartości:daily, weekly, monthly
credit_limit_windowsobject
Opcjonalne
Zastępcze kroczące limity wydatków identyfikowane przez 1h, 1d lub 7d; pusty obiekt usuwa wszystkie kroczące limity.
enabledboolean
Opcjonalne
Czy żądania korzystające z tego klucza są akceptowane.
namestring
Opcjonalne
Zastępcza przyjazna nazwa klucza API.
03
HTTP 200Odpowiedź sukcesu
PATCH /api/v1/keys/:id
JSON
{
"allowed_models": [
"gpt-5.4"
],
"created_at": "2026-07-27T10:00:00.000Z",
"credit_limit_cents": 1000,
"credit_limit_reset_interval": "daily",
"credit_limit_windows": {},
"credit_usage_cents_by_model": {
"gpt-5.4": 250
},
"credit_usage_cents_this_month": 250,
"credit_usage_cents_this_week": 100,
"credit_usage_cents_today": 25,
"credit_usage_cents_total": 250,
"enabled": true,
"guardrail_id": "guardrail_123",
"id": "token_123",
"last_used_at": null,
"masked_token": "runapi_abc...wxyz",
"name": "Production primary"
}
04
HTTP 401Odpowiedź błędu (401)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Authentication required"
}
05
HTTP 403Odpowiedź błędu (403)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Management API key required"
}
06
HTTP 403Odpowiedź błędu (403)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Account admin required"
}
07
HTTP 400Odpowiedź błędu (400)
Schemat odpowiedzi
JSON
{
"oneOf": [
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
},
{
"properties": {
"error": {
"description": "Czytelne dla człowieka podsumowanie walidacji.",
"type": "string"
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Komunikaty walidacyjne identyfikowane przez publiczne pole żądania, z tablicą czytelnych dla człowieka ciągów znaków dla każdego pola.",
"type": "object"
}
},
"required": [
"error",
"errors"
],
"type": "object",
"unevaluatedProperties": false
}
]
}
Przykład odpowiedzi
JSON
{
"error": "page must be an integer"
}
08
HTTP 404Odpowiedź błędu (404)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelny dla człowieka komunikat o błędzie.",
"type": "string"
}
},
"required": [
"error"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Resource not found"
}
09
HTTP 422Odpowiedź błędu (422)
Schemat odpowiedzi
JSON
{
"properties": {
"error": {
"description": "Czytelne dla człowieka podsumowanie walidacji.",
"type": "string"
},
"errors": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"description": "Komunikaty walidacyjne identyfikowane przez publiczne pole żądania, z tablicą czytelnych dla człowieka ciągów znaków dla każdego pola.",
"type": "object"
}
},
"required": [
"error",
"errors"
],
"type": "object",
"unevaluatedProperties": false
}
Przykład odpowiedzi
JSON
{
"error": "Validation failed",
"errors": {
"base": [
"Validation failed"
]
}
}
10
Przykład cURL
CURL
curl -X PATCH https://runapi.ai/api/v1/keys/token_123 \
-H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"name":"Production primary","enabled":true,"credit_limit_windows":{}}'