Get information about an API key, including name, status, permissions and users who created or modified this key.

get/v1/api-key

Request

Base URL: https://docs.x.ai (the document declares no server; this is the origin it was published from)
URL: https://docs.x.ai/v1/api-key
Auth: HTTP bearer

Success

aclsstring[] required

A list of ACLs authorized with the API key, e.g. "api-key:endpoint:*", "api-key:model:*".

api_key_blockedboolean required

Indicates whether the API key is blocked.

api_key_disabledboolean required

Indicates whether the API key is disabled.

api_key_idstring required

ID of the API key.

create_timestring required

Creation time of the API key in Unix timestamp.

modified_bystring required

User ID of the user who last modified the API key.

modify_timestring required

Last modification time of the API key in Unix timestamp.

namestring required

The name of the API key specified by user.

redacted_api_keystring required

The redacted API key.

team_blockedboolean required

Indicates whether the team that owns the API key.

team_idstring required

The team ID of the team that owns the API key.

user_idstring required

User ID the API key belongs to.

No recorded changes to this operation across all 1 revision of this API.