API Keys

Manage runtime API keys for apps

Get API keys

get

Returns the API keys for a specific app. API keys are used to authenticate requests to the Spice.ai runtime.

Authorizations

BearerAuth

AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters

appIdintegerRequired

The ID of the app

Responses

200

API keys for the app

application/json

api_keystring · nullableOptional

Primary API key

api_key_2string · nullableOptional

Secondary API key (for key rotation)

400

Invalid app ID

401

Unauthorized

403

Insufficient scope

404

App not found

500

Internal server error

get

/v1/apps/{appId}/api-keys

HTTPcURLJavaScriptPython

GET /v1/apps/{appId}/api-keys HTTP/1.1
Host: api.spice.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_key": "text",
  "api_key_2": "text"
}

Regenerate an API key

post

Regenerates an API key for the specified app. This invalidates the previous key. Use key_number to specify which key to regenerate (0 for both, 1 for primary, 2 for secondary).

Authorizations

BearerAuth

AuthorizationstringRequired

OAuth 2.0 access token obtained from the Spice.ai authentication service

Path parameters

appIdintegerRequired

The ID of the app

Body

application/json

key_numberinteger · enumOptional

Which API key to regenerate (0 = both, 1 = primary, 2 = secondary)

Default: 1Possible values:

Responses

200

API key regenerated successfully

application/json

api_keystring · nullableOptional

Primary API key

api_key_2string · nullableOptional

Secondary API key

regenerated_keyinteger · enumOptional

Which key was regenerated (0 = both, 1 = primary, 2 = secondary)

Possible values:

400

Invalid request body or app ID

401

Unauthorized

403

Insufficient scope

404

App not found

500

Internal server error

post

/v1/apps/{appId}/api-keys

HTTPcURLJavaScriptPython

POST /v1/apps/{appId}/api-keys HTTP/1.1
Host: api.spice.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "key_number": 1
}

{
  "api_key": "text",
  "api_key_2": "text",
  "regenerated_key": 0
}