List API keys

curl --request GET \
  --url https://api.arize.com/v2/api-keys \
  --header 'Authorization: Bearer <token>'

{
  "api_keys": [
    {
      "id": "QXBp1001",
      "name": "My API Key",
      "description": "My API Key description",
      "key_type": "user",
      "status": "active",
      "redacted_key": "ak-xxx...yyy",
      "created_by_user_id": "Usr1001",
      "created_at": "2024-01-15T10:30:00Z",
      "expires_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "QXBp1002",
      "name": "My API Key 2",
      "description": "My API Key 2 description",
      "key_type": "service",
      "status": "active",
      "redacted_key": "ak-aaa...bbb",
      "created_by_user_id": "Usr1001",
      "created_at": "2024-01-10T08:00:00Z",
      "expires_at": "2025-01-10T08:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "cursor_12345",
    "has_more": true
  }
}

API Keys

List API keys

List API keys. Returns metadata for each key (id, name, description, key_type, status, redacted_key, created_at, expires_at, created_by_user_id). The raw key secret is never returned after creation.

Results can be filtered by key type, status, space, and creator. Responses are paginated; use limit and cursor and the response pagination.next_cursor for subsequent pages.

Service keys (key_type=service): Provide space_id to return all service keys for that space. When key_type is omitted alongside space_id, service keys are returned implicitly. Requires the SERVICE_KEY_READ permission in the space (or account/space admin). Optionally combine with user_id to filter service keys by their creator — available to any caller with space access (not admin-gated).

User keys (key_type=user): Returned by default (no space_id). Provide user_id to view keys belonging to a specific user — account admins only; non-admins receive 403.

Authorization: Requires the developer user permission flag or account admin role. Returns 403 when neither condition is met.

This endpoint is in alpha, read more here.

GET

api-keys

List API keys

curl --request GET \
  --url https://api.arize.com/v2/api-keys \
  --header 'Authorization: Bearer <token>'

{
  "api_keys": [
    {
      "id": "QXBp1001",
      "name": "My API Key",
      "description": "My API Key description",
      "key_type": "user",
      "status": "active",
      "redacted_key": "ak-xxx...yyy",
      "created_by_user_id": "Usr1001",
      "created_at": "2024-01-15T10:30:00Z",
      "expires_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "QXBp1002",
      "name": "My API Key 2",
      "description": "My API Key 2 description",
      "key_type": "service",
      "status": "active",
      "redacted_key": "ak-aaa...bbb",
      "created_by_user_id": "Usr1001",
      "created_at": "2024-01-10T08:00:00Z",
      "expires_at": "2025-01-10T08:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "cursor_12345",
    "has_more": true
  }
}

Authorizations

Authorization

string

header

required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Query Parameters

key_type

enum<string>

Filter by API key type.

user - Key associated with a specific user.
service - Key associated with a bot user for service authentication.

Type of the API key.

user - Key associated with a specific user.
service - Key associated with a bot user for service authentication.

Available options:

user,

service

status

enum<string>

Filter by API key status.

active - Only return keys that are valid for use.
deleted - Only return keys that have been deleted.

When not specified, defaults to active.

Current status of the API key.

active - The key is valid for use.
deleted - The key has been deleted by a user.

Available options:

active,

deleted

space_id

string

Filter search results to a particular space ID A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

user_id

string

Filter API keys by the user who created them (base64 identifier (base64)). When used with space_id, filters service keys by creator — available to any user with space access. When used without space_id, filters user keys by creator — account admins only (non-admins receive 403). Can be combined with key_type to further narrow results by key type.

A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

limit

integer

default:50

Maximum items to return

Required range: 1 <= x <= 100

cursor

string

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

Returns a list of API keys matching the request filters. The raw key secret is never returned.

api_keys

object[]

required

API keys matching the request filters.

Show child attributes

pagination

object

required

Pagination metadata for cursor-based navigation.

Show child attributes

Assign users to a record Create an API key

⌘I