Skip to content

Save Openrouter Key

PUT
/v1/settings/openrouter-key
curl --request PUT \
--url https://example.com/v1/settings/openrouter-key \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "key": "example" }'

Check the key with OpenRouter and save it for the organisation.

Media typeapplication/json
OpenRouterKey
object
key
required
Key
string

Example generated

{
"key": "example"
}

Successful Response

Media typeapplication/json
Settings
object
openrouter_key
required
Any of:
string
Allowed values: environment saved
mode
required
Mode

local: one person on their own machine. hosted: shared, with sign-in.

string
Allowed values: local hosted
server_files
required
Server Files

Whether datasets can be added from, and exported to, paths on the server.

boolean

Example

{
"openrouter_key": "environment",
"mode": "local"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}