> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# 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](https://arize.com/docs/ax/rest-reference#api-version-stages).
## OpenAPI
````yaml https://api.arize.com/v2/spec.yaml get /v2/api-keys
openapi: 3.0.3
info:
title: Arize REST API
version: 2.0.0
description: |
API specification for the backend data server. The API is hosted globally
at https://api.arize.com/v2 or in your own environment.
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- description: Global
url: https://api.arize.com
- description: Regional
url: https://api.{region}.arize.com
variables:
region:
default: eu-west-1a
enum:
- eu-west-1a
- ca-central-1a
- description: Custom Host
url: https://{host}
variables:
host:
default: api.arize.com
security:
- bearerAuth: []
tags:
- name: AI Integrations
description: |
AI integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
entire account, a specific organization, or a specific space.
- name: Annotation Configs
description: >
Annotation configs allow you to define consistent annotation schemas that
can be reused across your workspace, ensuring evaluations are structured
and
comparable over time.
- name: Annotation Queues
description: >
Annotation queues help you organize and manage human evaluation workflows.
Use queues to assign spans or examples to annotators for review and
labeling.
- name: API Keys
description: >
API keys are used to authenticate requests to the Arize API. List your
keys
to view metadata; the raw secret is never returned after creation.
- name: Datasets
description: |
Datasets are structured, version-controlled example collections you use to
run, evaluate, and track LLM experiments.
- name: Evaluators
description: >
Evaluators are reusable evaluation configurations used to assess the
quality
of LLM outputs. They can be template-based (using LLM judges) or
code-based.
- name: Experiments
description: >
Experiments let you systematically test prompt/model changes using
datasets,
tasks, and evaluators.
- name: Integrations
description: >
Integrations configure access to external LLM providers (e.g. OpenAI,
Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
PagerDuty, Slack), and
your own agents. Integrations can be scoped to the entire account, a
specific
organization, or a specific space.
- name: Organizations
description: >
Organizations are top-level containers within an Arize AX account for
grouping spaces.
- name: Projects
description: |
Projects represent LLM applications being monitored in Arize where you can
observe traces and spans.
- name: Prompts
description: >
Prompts are reusable, versioned templates for LLM interactions. Use
prompts
to standardize and manage how you interact with LLMs across your
application.
- name: Resource Restrictions
description: |
Endpoints for restricting and unrestricting resources (projects, models).
- name: Role Bindings
description: |
Role bindings assign a role to a user on a resource. REST currently
supports space- and project-scoped bindings.
- name: Roles
description: >
Roles define sets of permissions that can be assigned to users within an
account. Create custom roles to tailor access control to your team's
needs.
- name: Spaces
description: >
Spaces are containers within an organization for grouping related
projects,
datasets, and experiments, enabling collaboration or isolated
experimentation
with role-based access control.
- name: Spans
description: |
Spans represent individual operations within a trace. A span captures the
timing, status, and attributes of a single operation in your application.
- name: Tasks
description: |
Tasks are configurable units of work that tie one or more evaluators to a
data source (project or dataset). Use tasks to automate evaluation of LLM
outputs, with support for continuous evaluation and backfill runs.
- name: Users
description: >
Users represent members of an account. The Users endpoints allow creating,
listing, updating (display name), and removing users from the account
programmatically.
paths:
/v2/api-keys:
get:
tags:
- API Keys
summary: List API keys
description: >
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](https://arize.com/docs/ax/rest-reference#api-version-stages).
operationId: api_keys_list
parameters:
- $ref: '#/components/parameters/ApiKeyTypeQueryParam'
- $ref: '#/components/parameters/ApiKeyStatusQueryParam'
- $ref: '#/components/parameters/SpaceIdQueryParam'
- $ref: '#/components/parameters/UserIdQueryParam'
- $ref: '#/components/parameters/LimitQueryParamMax100'
- $ref: '#/components/parameters/CursorQueryParam'
responses:
'200':
$ref: '#/components/responses/ApiKeyList'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'429':
$ref: '#/components/responses/RateLimitExceeded'
components:
parameters:
ApiKeyTypeQueryParam:
name: key_type
in: query
required: false
description: |
Filter by API key type.
- user - Key associated with a specific user.
- service - Key associated with a bot user for service authentication.
schema:
$ref: '#/components/schemas/ApiKeyType'
example: user
ApiKeyStatusQueryParam:
name: status
in: query
required: false
description: |
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`.
schema:
$ref: '#/components/schemas/ApiKeyStatus'
example: active
SpaceIdQueryParam:
name: space_id
in: query
description: Filter search results to a particular space ID
schema:
$ref: '#/components/schemas/Id'
example: U3BhY2U6MTIzNDU=
UserIdQueryParam:
name: user_id
in: query
required: false
description: >
Filter results by user (base64 global user ID). When provided, only
records
associated with this user are returned. Access requirements vary by
endpoint —
some endpoints restrict this filter to account admins.
schema:
$ref: '#/components/schemas/Id'
example: VXNlcjoxMjM0NQ==
LimitQueryParamMax100:
name: limit
in: query
description: Maximum items to return
schema:
type: integer
minimum: 1
maximum: 100
default: 50
CursorQueryParam:
name: cursor
in: query
description: |
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.
schema:
type: string
responses:
ApiKeyList:
description: >-
Returns a list of API keys matching the request filters. The raw key
secret is never returned.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyListResponse'
example:
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
BadRequest:
description: Invalid request
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 400
title: Invalid request parameters
detail: The 'name' field is required and must be a non-empty string.
instance: /resource
type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
Unauthorized:
description: Authentication is required
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 401
title: Authentication required
detail: You must be authenticated to access this resource.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#authentication-required
Forbidden:
description: Insufficient permissions to access this resource
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 403
title: Access forbidden
detail: You do not have permission to access this resource.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
NotFound:
description: Not found
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 404
title: Resource not found
detail: The requested resource with ID '12345' was not found.
instance: /resource/12345
type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
RateLimitExceeded:
description: Rate limit exceeded
headers:
Retry-After:
description: |
When throttled (429), how long to wait before retrying. Value is
either a delta-seconds integer.
schema:
type: integer
minimum: 0
example: 42
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
example:
status: 429
title: Rate limit exceeded
detail: >-
You have exceeded the allowed number of requests. Please try again
later.
instance: /resource
type: >-
https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
schemas:
ApiKeyType:
type: string
enum:
- user
- service
description: |
Type of the API key.
- user - Key associated with a specific user.
- service - Key associated with a bot user for service authentication.
ApiKeyStatus:
type: string
enum:
- active
- revoked
description: |
Current status of the API key.
- active - The key is valid for use.
- revoked - The key has been revoked and is no longer valid.
Id:
type: string
description: A universally unique identifier (base64-encoded opaque string).
example: RW50aXR5OjEyMzQ1
ApiKeyListResponse:
type: object
required:
- api_keys
- pagination
properties:
api_keys:
type: array
items:
$ref: '#/components/schemas/ApiKey'
description: API keys matching the request filters.
pagination:
$ref: '#/components/schemas/PaginationMetadata'
description: Pagination metadata for cursor-based navigation.
additionalProperties: false
Problem:
type: object
description: RFC 9457 Problem Details
properties:
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
description: >-
The HTTP status code generated by the origin server for this
occurrence of the problem
type:
type: string
format: uri-reference
description: A URI reference that identifies the problem type
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
instance:
type: string
format: uri-reference
description: >-
A URI reference that identifies the specific occurrence of the
problem
required:
- title
- status
additionalProperties: false
ApiKey:
type: object
required:
- id
- name
- key_type
- status
- redacted_key
- created_at
- created_by_user_id
properties:
id:
type: string
description: Unique identifier for the API key.
name:
type: string
description: User-defined name for the API key.
description:
type: string
description: Optional user-defined description for the API key.
key_type:
$ref: '#/components/schemas/ApiKeyType'
status:
$ref: '#/components/schemas/ApiKeyStatus'
redacted_key:
type: string
description: >-
Redacted version of the key suitable for display (e.g.,
"ak-abc...xyz").
created_at:
type: string
format: date-time
description: Timestamp when the key was created.
expires_at:
type: string
format: date-time
description: Optional timestamp when the key will expire.
created_by_user_id:
type: string
description: ID of the user who created the key.
last_used_at:
type: string
format: date-time
description: >-
Approximate timestamp when the key was last used for authentication.
This value is periodically updated and may not reflect the most
recent usage.
additionalProperties: false
PaginationMetadata:
required:
- has_more
type: object
properties:
next_cursor:
type: string
description: >
Opaque cursor for fetching the next page. Treat as an unreadable
token.
Present when `has_more` is true; omitted when `has_more` is false.
has_more:
type: boolean
description: True if another page of results is available.
description: |
Cursor-based pagination metadata. Use `next_cursor` in the subsequent
request's `cursor` query parameter.
additionalProperties: false
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat:
description: >
Most Arize AI endpoints require authentication. For those endpoints that
require authentication, include your API key in the request header using
the format
``` Authorization: Bearer
```
````