Repository Public
1<!-- source: https://docs.x.ai/developers/rest-api-reference/management/auth (from https://docs.x.ai/llms-full.txt, retrieved 2026-09-19T05:28:55Z) -->2#### Management API34# Accounts and Authorization56***78## POST /auth/teams/\{teamId}/api-keys910API keys are used to access the xAI API (https://api.x.ai). They are included on requests as a11HTTP Bearer token. API keys are bound to teams and are associated with the user who created12them.1314### Path Parameters1516* `teamId` (string, required) — ID of the team this API key belongs to. The team ID can be copied here:17 https://console.x.ai/team/default/settings/team.1819### Request Body2021* `name` (string, required) — Human-readable name for the API key. Should not be empty.2223* `acls` (array\<string>) — By default API keys don't have access to anything. In order to actually use an API key, you24 must grant it access to (1) endpoints and (2) models.2526 Access is granted via strings of the form \`api-key:endpoint:\[endpoint name]\` and27 \`api-key:model:\[model name]\` where \`endpoint name\` and \`model name\` can be retrieved via the28 \`/auth/teams/\{team\_id}/endpoints\` and \`/auth/teams/\{team\_id}/models\` endpoints respectively.2930 ACLs also support wildcards. If you want to create an API key that has access to all models and31 endpoints, then add the two ACLs \`api-key:endpoint:\*\` and \`api-key:model:\*\`.3233* `qps` (integer) — If set, the API key is limited to performing this number of queries per second.3435* `qpm` (integer) — If set, the API key is limited to performing this number of queries per minute.3637* `tpm` (string) — If set, the API key is limited to producing/consuming the set number of tokens per minute.38 The limiter engages when the limit is strictly exceeded. In-flight requests that cause the39 limit to get exceeded will not be aborted.4041* `expireTime` (string) — Expiration time for the API key. If set and in the past, the key is rejected.4243### Response Body4445* `redactedApiKey` (string) — A redacted API key. We don't expose the full key after it has been created.4647* `apiKey` (string) — Only set when the API key is created.4849* `userId` (string) — ID of the User who created this API key.5051* `name` (string) — Human-readable name for the API key.5253* `createTime` (string) — Timestamp when the API key was created.5455* `modifyTime` (string) — Timestamp when the API key was modified.5657* `teamId` (string) — ID of the team this API key belongs to.5859* `apiKeyId` (string) — The ID of the API key.6061* `disabled` (boolean) — If API is disabled (by the user) or not. Users can disable API keys to prevent them from making62 API calls.6364* `expireTime` (string) — Expiration time for the API key. If set and in the past, the key is rejected.6566* `qps` (integer) — If set, this API key can only perform the stated number of requests per second.6768* `qpm` (integer) — If set, this API key can only perform the stated number of requests per minute.6970* `tpm` (string) — If set, the API key is limited to producing/consuming the set number of tokens per minute.71 The limiter engages when the limit is strictly exceeded. In-flight requests that cause the72 limit to get exceeded will not be aborted.7374* `aclStrings` (array\<string>) — The permissions the API key has. By default, API keys don't have any permissions, which means75 all requests fail if this field is empty. There are two kind of permissions users can grant:76 (1) endpoints and (2) models via the \`api-key:endpoint:\[endpoint name]\` and77 \`api-key:model:\[model name]\` ACLs.7879 If you want to grant access to specific endpoints and ACLs, you can use the corresponding80 \`/endpoints\` and \`/models\` endpoints to retrieve possible values for \`endpoint name\` and81 \`model name\`.8283 If you want to create an API key that has access to all endpoints and models, you can use the84 wildcard ACLs \`api-key:endpoint:\*\` and \`api-key:model:\*\`.8586\*\*Request example:\*\*8788```json89{90 "name": "My API key",91 "acls": [92 "api-key:endpoint:*",93 "api-key:model:*"94 ]95}96```9798\*\*Response example:\*\*99100```json101{102 "redactedApiKey": "xai-...oYZ4",103 "apiKey": "xai-2xr2bnFV7lAbcdelZbqSxLd77pjlU6gcFmt3tPLSK3d7z7302htoH6mc4LlKlTY7nJtlU0lRXXQjoYZ4",104 "userId": "6ad994df-7963-45e0-96c8-96b1ba849d9b",105 "name": "My API key",106 "createTime": "2025-11-13T16:14:38.164829Z",107 "modifyTime": "2025-11-13T16:38:07.059039Z",108 "teamId": "c9a0c990-53e6-491e-8df7-b9f18e6983ac",109 "apiKeyId": "fe15b799-32e1-4d02-9e65-80236f9995f7",110 "disabled": false,111 "aclStrings": [112 "api-key:endpoint:*",113 "api-key:model:*"114 ]115}116```117118***119120## GET /auth/teams/\{teamId}/api-keys121122Lists API keys belonging to a user within a team. If the caller user is an admin, returns all123team API keys. If the caller user is a member, returns that user's API keys.124125### Path Parameters126127* `teamId` (string, required) — ID of the team whose API keys shall be listed.128129### Query Parameters130131* `pageSize` (integer) — Control page size for result. It None, result is returned as one page.132133* `paginationToken` (string) — Pagination token received from a previous call when using pagination. Set to \`undefined\` to134 retrieve the first page.135136* `aclFilters` (array\<string>) — Optional filter to only return API keys that match the given ACLs.137138* `activeOnly` (boolean) — If true, only return non-expired API keys. Defaults to false (return all keys).139140### Response Body141142* `apiKeys` (array\<object>) — API keys belonging to the team.143144 * `redactedApiKey` (string) — A redacted API key. We don't expose the full key after it has been created.145146 * `apiKey` (string) — Only set when the API key is created.147148 * `userId` (string) — ID of the User who created this API key.149150 * `name` (string) — Human-readable name for the API key.151152 * `createTime` (string) — Timestamp when the API key was created.153154 * `modifyTime` (string) — Timestamp when the API key was modified.155156 * `teamId` (string) — ID of the team this API key belongs to.157158 * `apiKeyId` (string) — The ID of the API key.159160 * `disabled` (boolean) — If API is disabled (by the user) or not. Users can disable API keys to prevent them from making161 API calls.162163 * `expireTime` (string) — Expiration time for the API key. If set and in the past, the key is rejected.164165 * `qps` (integer) — If set, this API key can only perform the stated number of requests per second.166167 * `qpm` (integer) — If set, this API key can only perform the stated number of requests per minute.168169 * `tpm` (string) — If set, the API key is limited to producing/consuming the set number of tokens per minute.170 The limiter engages when the limit is strictly exceeded. In-flight requests that cause the171 limit to get exceeded will not be aborted.172173 * `aclStrings` (array\<string>) — The permissions the API key has. By default, API keys don't have any permissions, which means174 all requests fail if this field is empty. There are two kind of permissions users can grant:175 (1) endpoints and (2) models via the \`api-key:endpoint:\[endpoint name]\` and176 \`api-key:model:\[model name]\` ACLs.177178 If you want to grant access to specific endpoints and ACLs, you can use the corresponding179 \`/endpoints\` and \`/models\` endpoints to retrieve possible values for \`endpoint name\` and180 \`model name\`.181182 If you want to create an API key that has access to all endpoints and models, you can use the183 wildcard ACLs \`api-key:endpoint:\*\` and \`api-key:model:\*\`.184185* `paginationToken` (string) — Include this token on a follow-up request to retrieve the next page. If \`undefined\`, this is186 the last page.187188\*\*Response example:\*\*189190```json191{192 "apiKeys": [193 {194 "redactedApiKey": "xai-a**b",195 "userId": "12106c22-fa54-4255-9887-6eb73c55787f",196 "apiKeyId": "faf5f6c2-5322-4793-9b74-23129addca0c",197 "teamId": "fef05426-f6a4-4242-b9a6-b1a0ea5dc5fd",198 "disabled": "false",199 "tpm": "100000",200 "acl_strings": [201 "api-key:endpoint:*",202 "api-key:model:*"203 ]204 }205 ]206}207```208209***210211## PUT /auth/api-keys/\{api\_key\_id}212213Selectively updates a subset of fields on an API key.214215### Path Parameters216217* `api_key_id` (string, required) — The ID of the API key.218219### Request Body220221* `apiKey` (object, required) — API key.222223 * `redactedApiKey` (string) — A redacted API key. We don't expose the full key after it has been created.224225 * `apiKey` (string) — Only set when the API key is created.226227 * `userId` (string) — ID of the User who created this API key.228229 * `name` (string) — Human-readable name for the API key.230231 * `createTime` (string) — Timestamp when the API key was created.232233 * `modifyTime` (string) — Timestamp when the API key was modified.234235 * `teamId` (string) — ID of the team this API key belongs to.236237 * `disabled` (boolean) — If API is disabled (by the user) or not. Users can disable API keys to prevent them from making238 API calls.239240 * `expireTime` (string) — Expiration time for the API key. If set and in the past, the key is rejected.241242 * `qps` (integer) — If set, this API key can only perform the stated number of requests per second.243244 * `qpm` (integer) — If set, this API key can only perform the stated number of requests per minute.245246 * `tpm` (string) — If set, the API key is limited to producing/consuming the set number of tokens per minute.247 The limiter engages when the limit is strictly exceeded. In-flight requests that cause the248 limit to get exceeded will not be aborted.249250 * `aclStrings` (array\<string>) — The permissions the API key has. By default, API keys don't have any permissions, which means251 all requests fail if this field is empty. There are two kind of permissions users can grant:252 (1) endpoints and (2) models via the \`api-key:endpoint:\[endpoint name]\` and253 \`api-key:model:\[model name]\` ACLs.254255 If you want to grant access to specific endpoints and ACLs, you can use the corresponding256 \`/endpoints\` and \`/models\` endpoints to retrieve possible values for \`endpoint name\` and257 \`model name\`.258259 If you want to create an API key that has access to all endpoints and models, you can use the260 wildcard ACLs \`api-key:endpoint:\*\` and \`api-key:model:\*\`.261262* `fieldMask` (string) — Field mask indicating which fields will be modified.263264### Response Body265266* `redactedApiKey` (string) — A redacted API key. We don't expose the full key after it has been created.267268* `apiKey` (string) — Only set when the API key is created.269270* `userId` (string) — ID of the User who created this API key.271272* `name` (string) — Human-readable name for the API key.273274* `createTime` (string) — Timestamp when the API key was created.275276* `modifyTime` (string) — Timestamp when the API key was modified.277278* `teamId` (string) — ID of the team this API key belongs to.279280* `apiKeyId` (string) — The ID of the API key.281282* `disabled` (boolean) — If API is disabled (by the user) or not. Users can disable API keys to prevent them from making283 API calls.284285* `expireTime` (string) — Expiration time for the API key. If set and in the past, the key is rejected.286287* `qps` (integer) — If set, this API key can only perform the stated number of requests per second.288289* `qpm` (integer) — If set, this API key can only perform the stated number of requests per minute.290291* `tpm` (string) — If set, the API key is limited to producing/consuming the set number of tokens per minute.292 The limiter engages when the limit is strictly exceeded. In-flight requests that cause the293 limit to get exceeded will not be aborted.294295* `aclStrings` (array\<string>) — The permissions the API key has. By default, API keys don't have any permissions, which means296 all requests fail if this field is empty. There are two kind of permissions users can grant:297 (1) endpoints and (2) models via the \`api-key:endpoint:\[endpoint name]\` and298 \`api-key:model:\[model name]\` ACLs.299300 If you want to grant access to specific endpoints and ACLs, you can use the corresponding301 \`/endpoints\` and \`/models\` endpoints to retrieve possible values for \`endpoint name\` and302 \`model name\`.303304 If you want to create an API key that has access to all endpoints and models, you can use the305 wildcard ACLs \`api-key:endpoint:\*\` and \`api-key:model:\*\`.306307\*\*Request example:\*\*308309```json310{311 "apiKey": {312 "tpm": "42"313 },314 "fieldMask": "tpm"315}316```317318\*\*Response example:\*\*319320```json321{322 "redactedApiKey": "xai-...oYZ4",323 "apiKey": "xai-2xr2bnFV7lAbcdelZbqSxLd77pjlU6gcFmt3tPLSK3d7z7302htoH6mc4LlKlTY7nJtlU0lRXXQjoYZ4",324 "userId": "6ad994df-7963-45e0-96c8-96b1ba849d9b",325 "name": "My API key",326 "createTime": "2025-11-13T16:14:38.164829Z",327 "modifyTime": "2025-11-13T16:38:07.059039Z",328 "teamId": "c9a0c990-53e6-491e-8df7-b9f18e6983ac",329 "apiKeyId": "fe15b799-32e1-4d02-9e65-80236f9995f7",330 "disabled": false,331 "aclStrings": [332 "api-key:endpoint:*",333 "api-key:model:*"334 ]335}336```337338***339340## POST /auth/api-keys/\{apiKeyId}/rotate341342!!CAUTION!! Rotates the secret of an existing API key, permanently invalidating the old one.343344### Path Parameters345346* `apiKeyId` (string, required) — ID of the API key whose secret should be rotated.347348### Request Body349350* `expireTime` (string) — If set, updates the expiration time of the new API key secret.351 If not set, the new secret inherits the old secret's expiration time.352353* `oldSecretExpireTime` (string) — The time at which the old secret stops being accepted.354 Defaults to 24 hours from now if not set for non-expired keys. Must not be more than 7 days from now.355356### Response Body357358* `redactedApiKey` (string) — A redacted API key. We don't expose the full key after it has been created.359360* `apiKey` (string) — Only set when the API key is created.361362* `userId` (string) — ID of the User who created this API key.363364* `name` (string) — Human-readable name for the API key.365366* `createTime` (string) — Timestamp when the API key was created.367368* `modifyTime` (string) — Timestamp when the API key was modified.369370* `teamId` (string) — ID of the team this API key belongs to.371372* `apiKeyId` (string) — The ID of the API key.373374* `disabled` (boolean) — If API is disabled (by the user) or not. Users can disable API keys to prevent them from making375 API calls.376377* `expireTime` (string) — Expiration time for the API key. If set and in the past, the key is rejected.378379* `qps` (integer) — If set, this API key can only perform the stated number of requests per second.380381* `qpm` (integer) — If set, this API key can only perform the stated number of requests per minute.382383* `tpm` (string) — If set, the API key is limited to producing/consuming the set number of tokens per minute.384 The limiter engages when the limit is strictly exceeded. In-flight requests that cause the385 limit to get exceeded will not be aborted.386387* `aclStrings` (array\<string>) — The permissions the API key has. By default, API keys don't have any permissions, which means388 all requests fail if this field is empty. There are two kind of permissions users can grant:389 (1) endpoints and (2) models via the \`api-key:endpoint:\[endpoint name]\` and390 \`api-key:model:\[model name]\` ACLs.391392 If you want to grant access to specific endpoints and ACLs, you can use the corresponding393 \`/endpoints\` and \`/models\` endpoints to retrieve possible values for \`endpoint name\` and394 \`model name\`.395396 If you want to create an API key that has access to all endpoints and models, you can use the397 wildcard ACLs \`api-key:endpoint:\*\` and \`api-key:model:\*\`.398399\*\*Response example:\*\*400401```json402{403 "redactedApiKey": "xai-...oYZ4",404 "apiKey": "xai-2xr2bnFV7lAbcdelZbqSxLd77pjlU6gcFmt3tPLSK3d7z7302htoH6mc4LlKlTY7nJtlU0lRXXQjoYZ4",405 "userId": "6ad994df-7963-45e0-96c8-96b1ba849d9b",406 "name": "My API key",407 "createTime": "2025-11-13T16:14:38.164829Z",408 "modifyTime": "2025-11-13T16:38:07.059039Z",409 "teamId": "c9a0c990-53e6-491e-8df7-b9f18e6983ac",410 "apiKeyId": "fe15b799-32e1-4d02-9e65-80236f9995f7",411 "disabled": false,412 "aclStrings": [413 "api-key:endpoint:*",414 "api-key:model:*"415 ]416}417```418419***420421## DELETE /auth/api-keys/\{apiKeyId}422423!!CAUTION!! Permanently and irrevocably deletes an API key.424425### Path Parameters426427* `apiKeyId` (string, required) — ID of the API key to delete.428429\*\*Response example:\*\*430431```json432{}433```434435***436437## GET /auth/api-keys/\{apiKeyId}/propagation438439Checks if an API key has successfully been propagated.440441### Path Parameters442443* `apiKeyId` (string, required) — ID of the API whose propagation status shall be checked.444445### Response Body446447* `icPropagation` (object) — Map from the Inference Cluster address to a flag indicating if the API key has propagated.448449\*\*Response example:\*\*450451```json452{453 "icPropagation": {454 "cloud9.api.x.ai": true,455 "us-east-1.api.x.ai": true456 }457}458```459460***461462## GET /auth/teams/\{teamId}/models463464Lists all models that are accessible by a team.465466### Path Parameters467468* `teamId` (string, required) — ID of the team whose models shall be retrieved.469470### Response Body471472* `clusterConfigs` (array\<object>) — Contains the models accessible via the individual inference clusters.473474 * `languageModels` (array\<object>) — Available language models.475476 * `name` (string) — The name under which the model is available in the API.477478 * `version` (string) — The version number of this model. Sometimes models get updated in-place (i.e. they keep their479 name but an updated version of the same model is deployed).480481 * `inputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of input modalities the model supports.482483 * `outputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of output modalities the model supports.484485 * `promptTextTokenPrice` (string) — The price (in USD cents) per 100 million text prompt tokens.486487 * `promptImageTokenPrice` (string) — The price (in USD cents) per 100 million image prompt tokens.488489 * `promptTextTokenPriceLongContext` (string) — The price to charge per prompt-token if the request is a long context request. This apply to ALL the tokens of the490 request. The price is stored as 1/100,000,000th of a USD cent.491492 * `cachedPromptTokenPrice` (string) — The price (in USD cents) per 100 million cached prompt tokens.493494 * `cachedPromptTokenPriceLongContext` (string) — The price (in USD cents) per 100 million cached prompt tokens for long-context requests.495496 * `completionTextTokenPrice` (string) — The price (in USD cents) per 100 million text completion token.497498 * `completionTokenPriceLongContext` (string) — The price to charge per completions tokens if the request is a long context request. This apply to ALL the tokens499 of the request. The price is stored as 1/100,000,000th of a USD cent.500501 * `searchPrice` (string) — The price (in USD cents) per 1000 search.502503 * `rps` (string) — Max requests-per-second allowed for this team.504505 * `rpm` (string) — Max requests-per-minute if configured.506507 * `tpm` (string) — How many tokens-per-minute are allowed. If 0, limits are NOT applied.508509 * `rph` (string) — Max requests-per-hour if configured.510511 * `rpd` (string) — Max requests-per-day if configured.512513 * `cluster` (string) — Name of the cluster on which the model is available.514515 * `maxPromptLength` (integer) — Maximum length of the prompt/input (this includes tokens of all kinds).516517 * `aliases` (array\<string>) — Other names under which the model is available.518519 * `features` (object)520521 * `functionCalling` (boolean)522523 * `structuredOutputs` (boolean)524525 * `reasoning` (boolean)526527 * `algorithm` (string) — The name of the prompting algorithm to use.528529 * `longContextThreshold` (string) — Threshold after which a request is considered as long context. If not set, never apply the long context prices.530531 * `rateLimits` (object)532533 * `queryOffset` (string)534535 * `queryBaseRate` (string)536537 * `queryMultiplier` (string)538539 * `tokenOffset` (string)540541 * `tokenBaseRate` (string)542543 * `tokenMultiplier` (string)544545 * `batchDiscountPercent` (integer)546547 * `provisionedThroughput` (object) — Per-model Provisioned Throughput configuration.548549 * `tokensPerInputUnit` (string) — Conversion rate: tokens per input unit per minute.550551 * `tokensPerOutputUnit` (string) — Conversion rate: tokens per output unit per minute.552553 * `tier` (integer) — Effective integer rate-limiting tier for this team+model.554555 * `embeddingModels` (array\<object>) — Available embedding models.556557 * `name` (string) — The name under which the model is available in the API.558559 * `version` (string) — The version number of this model. Sometimes models get updated in-place (i.e. they keep their560 name but an updated version of the same model is deployed).561562 * `inputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of input modalities the model supports.563564 * `promptTextTokenPrice` (string) — The price (in USD cents) per 100 million text prompt tokens.565566 * `promptImageTokenPrice` (string) — The price (in USD cents) per 100 million image prompt tokens.567568 * `rps` (string) — Max requests-per-second allowed for this team.569570 * `rpm` (string) — Max requests-per-minute if configured.571572 * `tpm` (string) — How many tokens-per-minute are allowed. If 0, limits are NOT applied.573574 * `rph` (string) — Max requests-per-hour if configured.575576 * `rpd` (string) — Max requests-per-day if configured.577578 * `cluster` (string) — Name of the cluster on which the model is available.579580 * `aliases` (array\<string>) — Other names under which the model is available.581582 * `rateLimits` (object)583584 * `queryOffset` (string)585586 * `queryBaseRate` (string)587588 * `queryMultiplier` (string)589590 * `tokenOffset` (string)591592 * `tokenBaseRate` (string)593594 * `tokenMultiplier` (string)595596 * `tier` (integer) — Effective integer rate-limiting tier for this team+model.597598 * `imageGenerationModels` (array\<object>) — Available image generation models.599600 * `name` (string) — The name under which the model is available in the API.601602 * `version` (string) — The version number of this model. Sometimes models get updated in-place (i.e. they keep their603 name but an updated version of the same model is deployed).604605 * `inputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of input modalities the model supports.606607 * `outputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of output modalities the model supports.608609 * `imagePrice` (string) — \[DEPRECATED] The flat price per image. Use resolution\_pricing instead.610611 * `rps` (string) — Max requests-per-second allowed for this team.612613 * `rpm` (string) — Max requests-per-minute if configured.614615 * `tpm` (string) — How many tokens-per-minute are allowed. If 0, limits are NOT applied.616617 * `rph` (string) — Max requests-per-hour if configured.618619 * `rpd` (string) — Max requests-per-day if configured.620621 * `cluster` (string) — Name of the cluster on which the model is available.622623 * `aliases` (array\<string>) — Other names under which the model is available.624625 * `resolutionPricing` (array\<object>) — Resolution-based pricing tiers.626627 * `resolution` ("IMAGE\_RESOLUTION\_UNSPECIFIED" | "IMAGE\_RESOLUTION\_1K" | "IMAGE\_RESOLUTION\_2K" | "IMAGE\_RESOLUTION\_4K") — Image resolution options for pricing.628629  \- IMAGE\_RESOLUTION\_1K: ~1024x1024630  \- IMAGE\_RESOLUTION\_2K: ~2048x2048631  \- IMAGE\_RESOLUTION\_4K: ~4096x4096632633 * `pricePerImage` (string) — Price per image at this resolution (in 1/100,000,000th of a USD cent).634635 * `pricePerInputImage` (string) — Price per input image (in 1/100,000,000th of a USD cent).636637 * `rateLimits` (object)638639 * `queryOffset` (string)640641 * `queryBaseRate` (string)642643 * `queryMultiplier` (string)644645 * `tokenOffset` (string)646647 * `tokenBaseRate` (string)648649 * `tokenMultiplier` (string)650651 * `audioModels` (array\<object>) — Available audio models.652653 * `name` (string) — The name under which the model is available in the API.654655 * `version` (string) — The version number of this model. Sometimes models get updated in-place (i.e. they keep their656 name but an updated version of the same model is deployed).657658 * `inputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of input modalities the model supports.659660 * `outputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of output modalities the model supports.661662 * `promptTokenPrice` (string) — The price (in USD cents) per 100 million prompt tokens.663664 * `completionTokenPrice` (string) — The price (in USD cents) per 100 million completion tokens.665666 * `supportedClients` (array\<object>) — Supported clients. For example, this is something you can pass as the667 query parameter to the model websocket endpoint as "?client=...".668669 * `clientName` (string) — Short ID-like string describing this client in the API.670671 * `description` (string) — Human readable description for this type of client.672673 * `rps` (string) — Max requests-per-second allowed for this team.674675 * `rpm` (string) — Max requests-per-minute if configured.676677 * `tpm` (string) — How many tokens-per-minute are allowed. If 0, limits are NOT applied.678679 * `rph` (string) — Max requests-per-hour if configured.680681 * `rpd` (string) — Max requests-per-day if configured.682683 * `cluster` (string) — Name of the cluster on which the model is available.684685 * `aliases` (array\<string>) — Other names under which the model is available.686687 * `rateLimits` (object)688689 * `queryOffset` (string)690691 * `queryBaseRate` (string)692693 * `queryMultiplier` (string)694695 * `tokenOffset` (string)696697 * `tokenBaseRate` (string)698699 * `tokenMultiplier` (string)700701 * `videoGenerationModels` (array\<object>) — Available video generation models.702703 * `name` (string) — The name under which the model is available in the API.704705 * `version` (string) — The version number of this model. Sometimes models get updated in-place (i.e. they keep their706 name but an updated version of the same model is deployed).707708 * `inputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of input modalities the model supports (e.g. TEXT, IMAGE for image-to-video).709710 * `outputModalities` (array\<"INVALID" | "TEXT" | "IMAGE" | "AUDIO" | "VIDEO">) — The kind of output modalities the model supports.711712 * `rps` (string) — Max requests-per-second allowed for this team.713714 * `rpm` (string) — Max requests-per-minute if configured.715716 * `tpm` (string) — How many tokens-per-minute are allowed. If 0, limits are NOT applied.717718 * `rph` (string) — Max requests-per-hour if configured.719720 * `rpd` (string) — Max requests-per-day if configured.721722 * `cluster` (string) — Name of the cluster on which the model is available.723724 * `aliases` (array\<string>) — Other names under which the model is available.725726 * `resolutionPricing` (array\<object>) — Resolution-based pricing tiers.727728 * `resolution` ("VIDEO\_RESOLUTION\_UNSPECIFIED" | "VIDEO\_RESOLUTION\_480P" | "VIDEO\_RESOLUTION\_720P" | "VIDEO\_RESOLUTION\_1080P") — Video resolution options for pricing.729730 * `pricePerSecond` (string) — Price per second of video at this resolution (in 1/100,000,000th of a USD cent).731732 * `pricePerInputImage` (string) — Price per input image (in 1/100,000,000th of a USD cent).733734 * `pricePerInputVideoSecond` (string) — Price per input video second (in 1/100,000,000th of a USD cent).735736 * `rateLimits` (object)737738 * `queryOffset` (string)739740 * `queryBaseRate` (string)741742 * `queryMultiplier` (string)743744 * `tokenOffset` (string)745746 * `tokenBaseRate` (string)747748 * `tokenMultiplier` (string)749750 * `clusterName` (string) — Name of the inference cluster, e.g. 'us-east-1'.751752\*\*Response example:\*\*753754```json755{756 "clusterConfigs": [757 {758 "languageModels": [759 {760 "name": "grok-2-vision-1212",761 "version": "1.0",762 "inputModalities": [763 "TEXT",764 "IMAGE"765 ],766 "outputModalities": [767 "TEXT"768 ],769 "promptTextTokenPrice": "20000",770 "promptImageTokenPrice": "20000",771 "promptTextTokenPriceLongContext": "0",772 "cachedPromptTokenPrice": "0",773 "completionTextTokenPrice": "100000",774 "completionTokenPriceLongContext": "0",775 "searchPrice": "0",776 "rps": "10",777 "rpm": "600",778 "tpm": "0",779 "cluster": "us-east-1",780 "maxPromptLength": 32768,781 "aliases": [782 "grok-2-vision",783 "grok-2-vision-latest"784 ],785 "features": {786 "functionCalling": true,787 "structuredOutputs": true,788 "reasoning": false789 },790 "algorithm": "MultimodalV1"791 },792 {793 "name": "grok-code-fast-1",794 "version": "1.0",795 "inputModalities": [796 "TEXT"797 ],798 "outputModalities": [799 "TEXT"800 ],801 "promptTextTokenPrice": "2000",802 "promptImageTokenPrice": "0",803 "promptTextTokenPriceLongContext": "0",804 "cachedPromptTokenPrice": "200",805 "completionTextTokenPrice": "15000",806 "completionTokenPriceLongContext": "0",807 "searchPrice": "0",808 "rps": "8",809 "rpm": "480",810 "tpm": "2000000",811 "cluster": "us-east-1",812 "maxPromptLength": 256000,813 "aliases": [814 "grok-code-fast",815 "grok-code-fast-1-0825"816 ],817 "features": {818 "functionCalling": true,819 "structuredOutputs": true,820 "reasoning": true821 },822 "algorithm": "grok4Code"823 },824 {825 "name": "grok-2-1212",826 "version": "1.0",827 "inputModalities": [828 "TEXT"829 ],830 "outputModalities": [831 "TEXT"832 ],833 "promptTextTokenPrice": "20000",834 "promptImageTokenPrice": "0",835 "promptTextTokenPriceLongContext": "0",836 "cachedPromptTokenPrice": "0",837 "completionTextTokenPrice": "100000",838 "completionTokenPriceLongContext": "0",839 "searchPrice": "0",840 "rps": "15",841 "rpm": "900",842 "tpm": "0",843 "cluster": "us-east-1",844 "maxPromptLength": 131072,845 "aliases": [846 "grok-2",847 "grok-2-latest"848 ],849 "features": {850 "functionCalling": true,851 "structuredOutputs": true,852 "reasoning": false853 },854 "algorithm": "MultimodalV1"855 },856 {857 "name": "grok-3-mini",858 "version": "1.0",859 "inputModalities": [860 "TEXT"861 ],862 "outputModalities": [863 "TEXT"864 ],865 "promptTextTokenPrice": "3000",866 "promptImageTokenPrice": "0",867 "promptTextTokenPriceLongContext": "0",868 "cachedPromptTokenPrice": "750",869 "completionTextTokenPrice": "5000",870 "completionTokenPriceLongContext": "0",871 "searchPrice": "2500",872 "rps": "8",873 "rpm": "480",874 "tpm": "0",875 "cluster": "us-east-1",876 "maxPromptLength": 131072,877 "aliases": [878 "grok-3-mini-latest",879 "grok-3-mini-beta",880 "grok-3-mini-fast",881 "grok-3-mini-fast-latest",882 "grok-3-mini-fast-beta"883 ],884 "features": {885 "functionCalling": true,886 "structuredOutputs": true,887 "reasoning": true888 },889 "algorithm": "grok3Reasoning"890 },891 {892 "name": "grok-4-0709",893 "version": "1.0",894 "inputModalities": [895 "TEXT"896 ],897 "outputModalities": [898 "TEXT"899 ],900 "promptTextTokenPrice": "30000",901 "promptImageTokenPrice": "30000",902 "promptTextTokenPriceLongContext": "60000",903 "cachedPromptTokenPrice": "7500",904 "completionTextTokenPrice": "150000",905 "completionTokenPriceLongContext": "300000",906 "searchPrice": "2500",907 "rps": "8",908 "rpm": "480",909 "tpm": "2000000",910 "cluster": "us-east-1",911 "maxPromptLength": 256000,912 "aliases": [913 "grok-4",914 "grok-4-latest"915 ],916 "features": {917 "functionCalling": true,918 "structuredOutputs": true,919 "reasoning": true920 },921 "algorithm": "grok4",922 "longContextThreshold": "128000"923 },924 {925 "name": "grok-3",926 "version": "1.0",927 "inputModalities": [928 "TEXT"929 ],930 "outputModalities": [931 "TEXT"932 ],933 "promptTextTokenPrice": "30000",934 "promptImageTokenPrice": "0",935 "promptTextTokenPriceLongContext": "0",936 "cachedPromptTokenPrice": "7500",937 "completionTextTokenPrice": "150000",938 "completionTokenPriceLongContext": "0",939 "searchPrice": "2500",940 "rps": "10",941 "rpm": "600",942 "tpm": "0",943 "cluster": "us-east-1",944 "maxPromptLength": 131072,945 "aliases": [946 "grok-3-latest",947 "grok-3-beta",948 "grok-3-fast",949 "grok-3-fast-latest",950 "grok-3-fast-beta"951 ],952 "features": {953 "functionCalling": true,954 "structuredOutputs": true,955 "reasoning": false956 },957 "algorithm": "grok3"958 }959 ],960 "embeddingModels": [],961 "imageGenerationModels": [962 {963 "name": "grok-2-image-1212",964 "version": "1.0",965 "inputModalities": [966 "TEXT",967 "IMAGE"968 ],969 "outputModalities": [970 "IMAGE"971 ],972 "imagePrice": "700000000",973 "rps": "5",974 "rpm": "300",975 "tpm": "0",976 "cluster": "us-east-1",977 "aliases": [978 "grok-2-image",979 "grok-2-image-latest"980 ]981 }982 ],983 "audioModels": [],984 "clusterName": "us-east-1"985 },986 {987 "languageModels": [988 {989 "name": "grok-2-1212",990 "version": "1.0",991 "inputModalities": [992 "TEXT"993 ],994 "outputModalities": [995 "TEXT"996 ],997 "promptTextTokenPrice": "20000",998 "promptImageTokenPrice": "0",999 "promptTextTokenPriceLongContext": "0",1000 "cachedPromptTokenPrice": "0",1001 "completionTextTokenPrice": "100000",1002 "completionTokenPriceLongContext": "0",1003 "searchPrice": "0",1004 "rps": "50",1005 "tpm": "0",1006 "cluster": "eu-west-1",1007 "maxPromptLength": 131072,1008 "aliases": [1009 "grok-2",1010 "grok-2-latest"1011 ],1012 "features": {1013 "functionCalling": true,1014 "structuredOutputs": true,1015 "reasoning": false1016 },1017 "algorithm": "MultimodalV1"1018 },1019 {1020 "name": "grok-2-vision-1212",1021 "version": "1.0",1022 "inputModalities": [1023 "TEXT",1024 "IMAGE"1025 ],1026 "outputModalities": [1027 "TEXT"1028 ],1029 "promptTextTokenPrice": "20000",1030 "promptImageTokenPrice": "20000",1031 "promptTextTokenPriceLongContext": "0",1032 "cachedPromptTokenPrice": "0",1033 "completionTextTokenPrice": "100000",1034 "completionTokenPriceLongContext": "0",1035 "searchPrice": "0",1036 "rps": "50",1037 "tpm": "0",1038 "cluster": "eu-west-1",1039 "maxPromptLength": 32768,1040 "aliases": [1041 "grok-2-vision",1042 "grok-2-vision-latest"1043 ],1044 "features": {1045 "functionCalling": true,1046 "structuredOutputs": true,1047 "reasoning": false1048 },1049 "algorithm": "MultimodalV1"1050 }1051 ],1052 "embeddingModels": [],1053 "imageGenerationModels": [],1054 "audioModels": [],1055 "clusterName": "eu-west-1"1056 }1057 ]1058}1059```10601061***10621063## GET /auth/teams/\{teamId}/endpoints10641065Lists all the endpoint ACLs that can be used on API keys.10661067### Path Parameters10681069* `teamId` (string, required) — ID of the team whose accessible endpoints shall be received.10701071### Response Body10721073* `acls` (array\<object>) — List of ACLs that can be assigned to an API key.10741075 * `acl` (string) — The acl key to be used on an Api key.10761077 * `description` (string) — A description indicating what this ACL does.10781079 * `namespace` (string) — The ACL namespace.10801081 * `key` (string) — The ACL key.10821083 * `value` (string) — The ACL value (optional).10841085\*\*Response example:\*\*10861087```json1088{1089 "acls": [1090 {1091 "acl": "api-key:endpoint:chat",1092 "description": "Grants access to use a specific endpoint with an API Key.",1093 "namespace": "api-key",1094 "key": "endpoint",1095 "value": "chat"1096 },1097 {1098 "acl": "api-key:endpoint:embed",1099 "description": "Grants access to use a specific endpoint with an API Key.",1100 "namespace": "api-key",1101 "key": "endpoint",1102 "value": "embed"1103 },1104 {1105 "acl": "api-key:endpoint:image",1106 "description": "Grants access to use a specific endpoint with an API Key.",1107 "namespace": "api-key",1108 "key": "endpoint",1109 "value": "image"1110 },1111 {1112 "acl": "api-key:endpoint:models",1113 "description": "Grants access to use a specific endpoint with an API Key.",1114 "namespace": "api-key",1115 "key": "endpoint",1116 "value": "models"1117 },1118 {1119 "acl": "api-key:endpoint:sample",1120 "description": "Grants access to use a specific endpoint with an API Key.",1121 "namespace": "api-key",1122 "key": "endpoint",1123 "value": "sample"1124 },1125 {1126 "acl": "api-key:endpoint:tokenize",1127 "description": "Grants access to use a specific endpoint with an API Key.",1128 "namespace": "api-key",1129 "key": "endpoint",1130 "value": "tokenize"1131 },1132 {1133 "acl": "api-key:endpoint:documents",1134 "description": "Grants access to use a specific endpoint with an API Key.",1135 "namespace": "api-key",1136 "key": "endpoint",1137 "value": "documents"1138 }1139 ]1140}1141```11421143***11441145## GET /auth/management-keys/validation11461147API endpoint for GET requests to /auth/management-keys/validation.11481149### Response Body11501151* `apiKeyId` (string) — ID of this key.11521153* `teamId` (string) — \[DEPRECATED] Use scope and scope\_id instead.1154 ID of the team on whose behalf the key can act.11551156* `scope` ("SCOPE\_UNSPECIFIED" | "SCOPE\_TEAM" | "SCOPE\_ORGANIZATION") — Scope the key is associated with.11571158* `scopeId` (string) — ID of the scope the key is associated with.11591160* `ownerUserId` (string) — ID of the user who owns this key.11611162* `createTime` (string) — Time when the key was created.11631164* `modifyTime` (string) — Time when the key was last modified.11651166* `name` (string) — Name of this key (Just for humans).11671168* `acls` (array\<string>) — ACLs of this key (controls what APIs can be accessed using the key).11691170* `apiKey` (string) — Only set when the key is created.11711172* `redactedApiKey` (string) — A shorted version of the actual key.11731174* `ipRanges` (object)11751176 * `ipRanges` (array\<object>) — A list of IP ranges.11771178 * `address` (object)11791180 * `ipv4` (string)11811182 * `ipv6` (string)11831184 * `prefixLength` (integer)11851186\*\*Response example:\*\*11871188```json1189{1190 "apiKeyId": "b86ba29d-9f47-4b3a-a6ae-e69432d5f0dc",1191 "teamId": "65c1e471-205f-4566-9c5a-07198badf4ce",1192 "scope": "SCOPE_TEAM",1193 "scopeId": "65c1e471-205f-4566-9c5a-07198badf4ce",1194 "ownerUserId": "4d52c406-6ec6-4361-9b7c-40dc7e8ff284",1195 "createTime": "2025-12-10T23:17:49.460374Z",1196 "modifyTime": "2025-12-10T23:17:49.460374Z",1197 "name": "test key",1198 "acls": [1199 "team-token:endpoint:ListApiKeys",1200 "team-token:endpoint:CheckApiKeyPropagation",1201 "team-token:endpoint:ListPossibleEndpointAcls"1202 ],1203 "reactedApiKey": "xai-...r42q",1204 "ipRanges": null1205}1206```1207