Get API key

import requests

url = "https://api.auriko.ai/v1/workspaces/{workspace_id}/api-keys/{api_key_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.auriko.ai/v1/workspaces/{workspace_id}/api-keys/{api_key_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.auriko.ai/v1/workspaces/{workspace_id}/api-keys/{api_key_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key_prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "rate_limit_rpm": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "created_by_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "API key is invalid.",
    "type": "authentication_error",
    "param": null,
    "code": "invalid_api_key"
  }
}

{
  "error": {
    "message": "The requested resource was not found.",
    "type": "not_found_error",
    "param": null,
    "code": "resource_not_found"
  }
}

GET

workspaces

{workspace_id}

api-keys

{api_key_id}

Get API key

import requests

url = "https://api.auriko.ai/v1/workspaces/{workspace_id}/api-keys/{api_key_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.auriko.ai/v1/workspaces/{workspace_id}/api-keys/{api_key_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request GET \
  --url https://api.auriko.ai/v1/workspaces/{workspace_id}/api-keys/{api_key_id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key_prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "rate_limit_rpm": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "created_by_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "error": {
    "message": "API key is invalid.",
    "type": "authentication_error",
    "param": null,
    "code": "invalid_api_key"
  }
}

{
  "error": {
    "message": "The requested resource was not found.",
    "type": "not_found_error",
    "param": null,
    "code": "resource_not_found"
  }
}

Never returns raw key secrets. Requires keys:read scope. Naturally idempotent. All parameters, request/response schemas, and examples are auto-generated from the OpenAPI specification.

Authorizations

Authorization

string

header

required

API key authentication. Keys start with ak_ prefix. Example: Authorization: Bearer ak_live_xxxxxxxxxxxx

Path Parameters

workspace_id

string<uuid>

required

Workspace identifier

api_key_id

string<uuid>

required

API key identifier

Response

API key metadata (excludes the secret key value).

string<uuid>

required

Unique identifier for the API key

workspace_id

string<uuid>

required

Workspace this key belongs to

name

string

required

Human-readable name for the key

key_prefix

string

required

Key prefix for identification (e.g. "ak_live_abcdefgh")

profile

enum<string>

required

Key profile derived from granted scopes

Available options:

inference,

management,

mixed

scopes

string[]

required

Granted permission scopes

is_active

boolean

required

Whether the key is currently active

created_at

string<date-time>

required

When the key was created

rate_limit_rpm

integer | null

Per-key rate limit in requests per minute (null inherits workspace default)

expires_at

string<date-time> | null

Expiration timestamp (null means no expiration)

last_used_at

string<date-time> | null

When the key was last used (null if never used)

created_by_key_id

string<uuid> | null

ID of the API key that created this key (null if created via dashboard)

List API keys Get API key usage