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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.auriko.ai/v1/workspaces/{workspace_id}/byok-keys', 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}/byok-keys \
--header 'Authorization: Bearer <token>'{
"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,
"validation_status": "valid",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"account_tier": "<string>",
"account_tier_source": "auto_detected",
"last_validated_at": "2023-11-07T05:31:56Z",
"propagation_status": "pending"
}
],
"count": 123
}{
"error": {
"message": "API key is invalid.",
"type": "authentication_error",
"param": null,
"code": "invalid_api_key"
}
}BYOK
List BYOK keys
Lists a workspace’s BYOK keys as redacted metadata
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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.auriko.ai/v1/workspaces/{workspace_id}/byok-keys', 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}/byok-keys \
--header 'Authorization: Bearer <token>'{
"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,
"validation_status": "valid",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"account_tier": "<string>",
"account_tier_source": "auto_detected",
"last_validated_at": "2023-11-07T05:31:56Z",
"propagation_status": "pending"
}
],
"count": 123
}{
"error": {
"message": "API key is invalid.",
"type": "authentication_error",
"param": null,
"code": "invalid_api_key"
}
}Requires
All parameters, request/response schemas, and examples are auto-generated from the OpenAPI specification.
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).Authorizations
API key authentication.
Keys start with ak_ prefix.
Example: Authorization: Bearer ak_live_xxxxxxxxxxxx
Path Parameters
Workspace identifier
Query Parameters
Filter by provider identifier