Using Management API

Some enterprise users may prefer to manage their account details programmatically rather than manually through the xAI Console. For this reason, we have developed a Management API to enable enterprise users to efficiently manage their team details.

You can read the endpoint specifications and descriptions at Management API Reference.

You need to get a management key, which is separate from your API key, to use the management API. The management key can be obtained at xAI Console -> Settings -> Management Keys.

The base URL is at https://management-api.x.ai, which is also different from the inference API.

You can create, list, update and delete API keys via the management API.

You can also manage the access control lists (ACLs) associated with the API keys.

The available ACL types are:

api-key:model
api-key:endpoint

To enable all models and endpoints available to your team, use:

api-key:model:*
api-key:endpoint:*

Or if you need to specify the particular endpoint available to the API:

api-key:endpoint:chat for chat and vision models
api-key:endpoint:image for image generation models

And to specify models the API key has access to:

api-key:model:<model name such as grok-4>

Create an API key

An example to create an API key with all models and endpoints enabled, limiting requests to 5 queries per second and 100 queries per minute, without token number restrictions.

curl https://management-api.x.ai/auth/teams/{teamId}/api-keys \\
    -X POST \\
    -H "Authorization: Bearer <Your Management API Key>" \\
    -d '{
            "name": "My API key",
            "acls": ["api-key:model:*", "api-key:endpoint:*"],
            "qps": 5,
            "qpm": 100,
            "tpm": null
        }'

Specify tpm to any integer string to limit the number of tokens produced/consumed per minute. When the token rate limit is triggered, new requests will be rejected and in-flight requests will continue processing.

The newly-created API key will be returned in the "apiKey" field of the response object. The API Key ID is returned as "apiKeyId" in the response body as well, which is useful for updating and deleting operations.

List API keys

To retrieve a list of API keys from a team, you can run the following:

curl https://management-api.x.ai/auth/teams/{teamId}/api-keys?pageSize=10&paginationToken= \\
    -H "Authorization: Bearer <Your Management API Key>"

You can customize the query parameters such as pageSize and paginationToken.

Update an API key

You can update an API key after it has been created. For example, to update the qpm of an API key:

curl https://management-api.x.ai/auth/teams/{teamId}/api-keys \\
    -X PUT \\
    -d '{
            "apiKey": "<The apiKey Object with updated qpm>",
            "fieldMask": "qpm",
        }'

Or to update the name of an API key:

curl https://management-api.x.ai/auth/teams/{teamId}/api-keys \\
    -X PUT \\
    -d '{
            "apiKey": "<The apiKey Object with updated name>",
            "fieldMask": "name",
        }'

Delete an API key

You can also delete an API key with the following:

curl https://management-api.x.ai/auth/api-keys/{apiKeyId} \\
    -X DELETE \\
    -H "Authorization: Bearer <Your Management API Key>"

Check propagation status of API key across clusters

There could be a slight delay between creating an API key, and the API key being available for use across all clusters.

You can check the propagation status of the API key via API.

curl https://management-api.x.ai/auth/api-keys/{apiKeyId}/propagation \\
    -H "Authorization: Bearer <Your Management API Key>"

List all models available for the team

You can list all the available models for a team with our management API as well.

The model names in the output can be used with setting ACL string on an API key as api-key:model:<model-name>

curl https://management-api.x.ai/auth/teams/{teamId}/models \\
    -H "Authorization: Bearer <Your Management API Key>"

Access Control List (ACL) management

We also offer endpoint to list possible ACLs for a team. You can then apply the endpoint ACL strings to your API keys.

To view possible endpoint ACLs for a team’s API keys:

curl https://management-api.x.ai/auth/teams/{teamId}/endpoints \\
    -H "Authorization: Bearer <Your Management API Key>"

Key Information User Guide