Naar inhoud springen
API-referentie
API-referentie

Een API-sleutel bijwerken

Werk een bestaande standaard API-sleutel bij en haal de huidige gebruikssamenvatting op.

Markdown bekijken

Werk een bestaande standaard API-sleutel bij en haal de huidige gebruikssamenvatting op.

Eindpunt

PATCH /api/v1/keys/:id
Basis-URL
https://runapi.ai
API-versie
v1
Authenticatie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisatie
Vereist een Management API-sleutel met accountbeheerdersrechten en staat alleen sleutels toe die eigendom zijn van de bijbehorende gebruiker.
02

Verzoek

JSON-body

Stuur waarden alleen op de vermelde verzoeklocatie.

JSON-body7 velden
allowed_modelsarray | null
Optioneel

Vervangende toegestane modellenlijst; null of een lege array wist de lijst.

credit_limit_centsinteger | null
Optioneel

Uitgavenplafond in USD-centen; null wist het plafond en het resetinterval.

credit_limit_reset_intervalstring | null
Optioneel

Herstellingscyclus voor het bestedingsplafond.

Toegestane waarden: daily, weekly, monthly
credit_limit_windowsobject
Optioneel

Vervangende doorlopende bestedingslimieten gekoppeld aan 1h, 1d of 7d; een leeg object wist alle doorlopende limieten.

enabledboolean
Optioneel

Of verzoeken met deze sleutel worden geaccepteerd.

namestring
Optioneel

Vervangende gebruiksvriendelijke naam voor de API-sleutel.

tagsarray
Optioneel

Vervangende key:value-strings; weglaten behoudt tags. Hetzelfde formaat en dezelfde limiet van 20 tags als bij aanmaken. Ontbrekend usage wordt usage:developer; een lege array herstelt usage:developer.

Padparameters1 veld
idstring
Verplicht

Prefix-ID van de API-sleutel, bijvoorbeeld token_123.

03

Succesvol antwoord

HTTP 200

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",
  "tags": [
    "usage:service",
    "env:production",
    "dept:ml"
  ]
}
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 (404)

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

Responsvoorbeeld

JSON 
{
  "error": "Resource not found"
}
09

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"
    ]
  }
}
10

cURL-voorbeeld

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","tags":["usage:service","env:production","dept:ml"],"enabled":true,"credit_limit_windows":{}}'