API Keys

Create an API key

Changed on

Create a new API key for the authenticated user.

  • Choose key_type: "USER" for a personal key that authenticates as you, or key_type: "SERVICE" for an automated service account key. The field is required.
  • For service keys, supply at least one space via the organizations array. The service account is granted membership in each specified space. Multiple organizations and multiple spaces per organization are supported.
  • For USER keys, the key inherits the authenticated user's own permissions.
  • You may only assign roles at or below your own privilege level. Attempting to assign a role higher than your own returns 422 Unprocessable Entity.
  • All roles default to minimum privilege when omitted: space roles default to MEMBER, organization roles default to READ_ONLY, and account_role defaults to MEMBER.

Authorization:

  • User keys: The authenticated user may create personal keys for themselves.
  • Service keys: Requires the SERVICE_KEY_CREATE permission in the target space (space member or above).

When developer access is disabled for an account, users cannot create user keys or service keys. Existing service keys remain active with their assigned roles.

Account key lifetime limit: Your account may limit the maximum lifetime of API keys. The limit applies to both user keys and service keys. When it is set and expires_at is omitted, the key expires at the maximum lifetime from now. An expires_at beyond the maximum is rejected with 422 Unprocessable Entity.

The full API key value (key) is only returned once in the creation response. Store it securely — it cannot be retrieved again. Use the redacted_key field on subsequent reads.

<Note>This endpoint is in beta, read more here.</Note>

post/v2/api-keys

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/api-keys
  • Auth
    HTTP bearer

Request body

OR

Example request

{
  "name": "My dev key",
  "description": "Used for local development.",
  "expires_at": "2026-01-01T00:00:00Z"
}

Response

API key successfully created or refreshed. The raw key is only returned once.

OR

Changes

  • 5fe718826d43Revision changes
    • warning

      added the new MEMBER_UI_ONLY enum value to the ////////////////// response property for the response status

    • warning

      added the new MEMBER_UI_ONLY enum value to the /////////////// response property for the response status

    • info

      added the new MEMBER_UI_ONLY enum value to the request property /////////////

  • 02f159248661Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status

    • info

      removed from the /// response property allOf list for the response status