Skip to main content
GET
/
v1
/
workspaces
/
{workspace_id}
/
byok-keys
List BYOK keys
import requests

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

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

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

print(response.text)
{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "<string>",
      "name": "<string>",
      "key_prefix": "<string>",
      "is_default": true,
      "disabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "account_tier": "<string>",
      "last_validated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 123
}
Requires byok:read scope. Naturally idempotent.
Responses contain redacted metadata only — a masked key_prefix, never the provider secret. Submitted secrets can’t be retrieved through any endpoint.
Items may carry propagation_status: "pending" while a change to their provider takes effect (within about 5 minutes).
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

Query Parameters

​
provider
string

Filter by provider identifier

Response

OK

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
count
integer
required