Skip to main content
POST
Create API Key

Authorizations

next-auth.session-token
string
cookie
required

Signed-in OpenLIT browser session.

Body

application/json
name
string
required
Minimum string length: 3
Example:

"production-sdk"

scopes
enum<string>[]

Features the key may use. Omit for full access. Must contain at least one feature when provided.

Minimum array length: 1

A feature an API key can use: ingest (OTLP telemetry ingestion), telemetry (/api/telemetry/*, /api/metrics/*), prompts (/api/prompt/*), vault (/api/vault/*), rule_engine (/api/rule-engine/*), evaluation (/api/evaluation/*), chat (/api/chat/*), controller (/api/controller/*), db_config (/api/db-config*).

Available options:
ingest,
telemetry,
prompts,
vault,
rule_engine,
evaluation,
chat,
controller,
db_config
Example:

Response

The created key, including the secret value.

id
string
Example:

"cmuybwm0s0051dmipjv6jd3hm"

apiKey
string

The secret key. Shown only once.

Example:

"openlit-3kJ9…"

databaseConfigId
string
organisationId
string | null
projectId
string | null
environment
string
Example:

"production"