Zum Inhalt springen
API-Referenz
API-Referenz

Einen API-Schlüssel erstellen

Erstellen Sie einen Standard-API-Schlüssel. Speichern Sie den von dieser Operation zurückgegebenen Klartext-Schlüssel, da er nur einmal angezeigt wird.

Markdown anzeigen

Erstellen Sie einen Standard-API-Schlüssel. Speichern Sie den von dieser Operation zurückgegebenen Klartext-Schlüssel, da er nur einmal angezeigt wird.

Endpunkt

POST /api/v1/keys
Basis-URL
https://runapi.ai
API-Version
v1
Authentifizierung
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisierung
Erfordert einen Management-API-Schlüssel mit Kontoadministrator-Rechten. Der neue Standard-API-Schlüssel gehört dem Aufrufer.
02

Anfrage

JSON-Body

Werte nur am angegebenen Anfrage-Speicherort senden.

JSON-Body7 Felder
allowed_modelsarray | null
Optional

Optionale Zulassungsliste von Modellbezeichnern.

credit_limit_centsinteger | null
Optional

Optionales Ausgabelimit in USD-Cent.

credit_limit_reset_intervalstring | null
Optional

Optionaler Zurücksetz-Rhythmus für das Schlüsselausgabelimit.

Zulässige Werte: daily, weekly, monthly
credit_limit_windowsobject
Optional

Rollierende Ausgabenlimits nach 1h, 1d oder 7d; jeder Wert enthält eine positive ganzzahlige limit_cents.

enabledboolean
Optional

Ob Anfragen mit diesem Schlüssel akzeptiert werden.

Standard: true
guardrail_idstring
Optional

Optionale Guardrail-Präfix-ID, die bei der Erstellung angehängt wird.

namestring
Optional

Anzeigename für den API-Schlüssel.

03

Erfolgsantwort

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

Fehlerantwort (401)

HTTP 401
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Authentication required"
}
05

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Management API key required"
}
06

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Account admin required"
}
07

Fehlerantwort (400)

HTTP 400
Antwort-Schema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Für Menschen lesbare Fehlermeldung.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Menschenlesbare Validierungszusammenfassung.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validierungsmeldungen nach öffentlichem Anforderungsfeld gegliedert, mit einem Array menschenlesbarer Zeichenketten für jedes Feld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Antwortbeispiel

JSON 
{
  "error": "page must be an integer"
}
08

Fehlerantwort (422)

HTTP 422
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Menschenlesbare Validierungszusammenfassung.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Validierungsmeldungen nach öffentlichem Anforderungsfeld gegliedert, mit einem Array menschenlesbarer Zeichenketten für jedes Feld.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Validation failed",
  "errors": {
    "base": [
      "Validation failed"
    ]
  }
}
09

cURL-Beispiel

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"}'