Storing a provider key¶

Note

The Admin API requires no token. The Admin API is typically protected at the network level.

Send the request as POST to the path /admin/v1/gateways/{gateway_id}/keys.

Description¶

Stores an API key for a provider. The key is encrypted at rest and cannot be retrieved after creation.

The following parameters are available:

Parameter	In	Type	Required	Description
`gateway_id`	path	`string`	yes	ID of the gateway.

Example of the request body:

{
  "provider": "openai",
  "key": "sk-...",
  "alias": "default"
}

The endpoint answers the request with the following status codes:

Status code	Description
`201`	Key stored.
`400`	Invalid request body or missing required field (Admin API).