Naar inhoud springen
API-referentie
API-referentie

Een API-sleutel aanmaken

Maak een standaard API-sleutel aan. Sla de platte tekst op die door deze bewerking wordt geretourneerd, want deze wordt slechts eenmaal getoond.

Markdown bekijken

Maak een standaard API-sleutel aan. Sla de platte tekst op die door deze bewerking wordt geretourneerd, want deze wordt slechts eenmaal getoond.

Eindpunt

POST /api/v1/keys
Basis-URL
https://runapi.ai
API-versie
v1
Authenticatie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisatie
Vereist een Management API-sleutel met accountbeheerdersrechten. De nieuwe standaard API-sleutel is eigendom van de aanvrager.
02

Verzoek

JSON-body

Stuur waarden alleen op de vermelde verzoeklocatie.

JSON-body7 velden
allowed_modelsarray | null
Optioneel

Optionele toegestane lijst van modelidentificatoren.

credit_limit_centsinteger | null
Optioneel

Optioneel uitgavelimiet in USD-centen.

credit_limit_reset_intervalstring | null
Optioneel

Optionele resetcyclus voor het uitgavelimiet van de sleutel.

Toegestane waarden: daily, weekly, monthly
credit_limit_windowsobject
Optioneel

Doorlopende bestedingslimieten gekoppeld aan 1h, 1d of 7d; elke waarde bevat een positief geheel getal limit_cents.

enabledboolean
Optioneel

Of verzoeken met deze sleutel worden geaccepteerd.

Standaard: true
guardrail_idstring
Optioneel

Optioneel guardrail-prefix-ID om bij aanmaak te koppelen.

namestring
Optioneel

Vriendelijke naam voor de API-sleutel.

03

Succesvol antwoord

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

Foutrespons (401)

HTTP 401
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (403)

HTTP 403
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (403)

HTTP 403
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (400)

HTTP 400
Responsschema
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Leesbare foutmelding.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Leesbare validatiesamenvatting.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Responsvoorbeeld

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

Foutrespons (422)

HTTP 422
Responsschema
JSON 
{
  "properties": {
    "error": {
      "description": "Leesbare validatiesamenvatting.",
      "type": "string"
    },
    "errors": {
      "additionalProperties": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
      "type": "object"
    }
  },
  "required": [
    "error",
    "errors"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

cURL-voorbeeld

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