Przejdź do treści
Dokumentacja API
Dokumentacja API

Tworzenie klucza API

Utwórz standardowy klucz API. Zapisz klucz w postaci jawnego tekstu zwrócony przez tę operację, ponieważ jest on wyświetlany tylko raz.

Zobacz Markdown

Utwórz standardowy klucz API. Zapisz klucz w postaci jawnego tekstu zwrócony przez tę operację, ponieważ jest on wyświetlany tylko raz.

Punkt końcowy

POST /api/v1/keys
Bazowy URL
https://runapi.ai
Wersja API
v1
Uwierzytelnianie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autoryzacja
Wymaga klucza API zarządzania na poziomie administratora konta. Nowy standardowy klucz API należy do osoby wywołującej.
02

Żądanie

Treść JSON

Wysyłaj wartości wyłącznie w podanej lokalizacji żądania.

Treść JSON7 pola
allowed_modelsarray | null
Opcjonalne

Opcjonalna lista dozwolonych identyfikatorów modeli.

credit_limit_centsinteger | null
Opcjonalne

Opcjonalny limit wydatków w centach USD.

credit_limit_reset_intervalstring | null
Opcjonalne

Opcjonalny cykl resetowania limitu wydatków klucza.

Dozwolone wartości: daily, weekly, monthly
credit_limit_windowsobject
Opcjonalne

Kroczące limity wydatków identyfikowane przez 1h, 1d lub 7d; każda wartość zawiera dodatnią liczbę całkowitą limit_cents.

enabledboolean
Opcjonalne

Czy żądania korzystające z tego klucza są akceptowane.

Domyślna wartość: true
guardrail_idstring
Opcjonalne

Opcjonalny prefiks identyfikatora mechanizmu kontrolnego do dołączenia podczas tworzenia.

namestring
Opcjonalne

Przyjazna nazwa klucza API.

03

Odpowiedź sukcesu

HTTP 201

POST /api/v1/keys

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": {
    "1d": {
      "limit_cents": 500
    },
    "1h": {
      "limit_cents": 100
    },
    "7d": {
      "limit_cents": 2000
    }
  },
  "enabled": true,
  "guardrail_id": "guardrail_123",
  "id": "token_123",
  "key": "runapi_plaintext_example",
  "last_used_at": null,
  "masked_token": "runapi_abc...wxyz",
  "name": "Production"
}
04

Odpowiedź błędu (401)

HTTP 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

Odpowiedź błędu (403)

HTTP 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

Odpowiedź błędu (403)

HTTP 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

Odpowiedź błędu (400)

HTTP 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

Odpowiedź błędu (422)

HTTP 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"
    ]
  }
}
09

Przykład cURL

CURL 
curl -X POST https://runapi.ai/api/v1/keys \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Production","credit_limit_cents":1000,"credit_limit_reset_interval":"daily","credit_limit_windows":{"1h":{"limit_cents":100},"1d":{"limit_cents":500},"7d":{"limit_cents":2000}},"allowed_models":["gpt-5.4"],"guardrail_id":"guardrail_123"}'