/

/xAI's REST API

APIs
Generators
Stacks
Projects

Docs
History
Schema
Sources

Checked 45m ago · Updated 45m ago View markdown

x
xAI's REST API
getList all video generation models available to the authenticating API key with full information.

OpenAPI 3.1.02026-08-0843192209.2 KB

8f6014272113

v143

getGet information about an API key, including name, status, permissions and users who created or modified this key.
postCreate a chat response from text/image chat prompts. This is the endpoint for making requests to chat and image understanding models.
getTries to fetch a result for a previously-started deferred completion. Returns `200 Success` with the response body, if the request has been completed. Returns `202 Accepted` when the request is pending processing.
post(Legacy - Not supported by reasoning models) Create a text completion response. This endpoint is compatible with the Anthropic API.
post(Legacy - Not supported by reasoning models) Create a text completion response for a given prompt. Replaced by /v1/chat/completions.
postSearch for content related to the query within the given collections.
getList all embedding models available to the authenticating API key with full information. Additional information compared to /v1/models includes modalities, fingerprint and alias(es).
getGet full information about an embedding model with its model_id.
postCreate an embedding vector representation corresponding to the input text. This is the endpoint for making requests to embedding models.
getList files owned by the authenticated team, paginated. The response always returns a `pagination_token`; pass it back as a query parameter to fetch the next page. The end of the list is reached when the returned `data` array is shorter than `limit`.
postUpload a file to xAI's storage. Returns the file's metadata. Files can be referenced by ID anywhere a `file_id` is accepted (e.g. chat attachments). Maximum file size: 50 MB. Files are kept until you delete them, or until `expires_after` elapses if set at upload time.
getRetrieve metadata for a single file by ID. Errors with 404 if the file doesn't exist, has been deleted, or has passed its `expires_at`.
deleteDelete a file by ID. After this returns, the file no longer appears in `GET /v1/files`, content download returns 404, and the ID can no longer be referenced in chat attachments.
getDownload the contents of a file as a stream of raw bytes. The response `Content-Type` is `application/octet-stream`. Use this for the binary payload; use `GET /v1/files/{file_id}` for metadata only.
postCreate a permanent, unauthenticated public URL for an existing file. The underlying file is unaffected and can still be fetched through the authenticated content endpoint. Use this when you want to share a stored asset (image, video, PDF) outside your API-keyed environment. Public URLs can be revoked at any time via `POST /v1/files/{file_id}/public-url/revoke`.
postRevoke the active public URL for a file. The underlying file remains available through the authenticated content endpoint. Revoke is idempotent — calling it on a file without an active public URL returns `revoked: false` without an error.
getList all image generation models available to the authenticating API key with full information. Additional information compared to /v1/models includes modalities, fingerprint and alias(es).
getGet full information about an image generation model with its model_id.
postEdit an image based on a prompt. This is the endpoint for making edit requests to image generation models.
postGenerate an image based on a prompt. This is the endpoint for making generation requests to image generation models.
getList all chat and image understanding models available to the authenticating API key with full information. Additional information compared to /v1/models includes modalities, fingerprint and alias(es).
getGet full information about a chat or image understanding model with its model_id.
getGet information about the currently authenticated caller. Works with both API keys and OAuth tokens. Returns identity, team, and ZDR status.
postCreate a messages response. This endpoint is compatible with the Anthropic API.
getList all models available to the authenticating API key, including model names (ID), creation times, and pricing.
getGet information about a model with its model_id, including pricing.
postGenerates a response based on text or image prompts. The response ID can be used to retrieve the response later or to continue the conversation without repeating prior context. New responses will be stored for 30 days and then permanently deleted.
postCompacts a full Responses API input window into a shorter canonical window.
getRetrieve a previously generated response.
deleteDelete a previously generated response.
getList input items for a previously generated response.
get/v1/skills
post/v1/skills
get/v1/skills/{skill_id}
delete/v1/skills/{skill_id}
get/v1/skills/{skill_id}/content
postTokenize text with the specified model
getList all video generation models available to the authenticating API key with full information.
getGet full information about a video generation model with its model_id.
postEdit a video based on a prompt. This is an asynchronous operation that returns a request_id for polling.
postExtend a video by generating continuation content. This is an asynchronous operation that returns a request_id for polling.
postGenerate a video from a text prompt and optionally an image. This is an asynchronous operation that returns a request_id for polling.
getGet the result of a deferred video generation request.

v1

List all video generation models available to the authenticating API key with full information.

get/v1/video-generation-models

Response

Success