How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xAI Responses API

The Responses API from xAI — 2 operation(s) for responses.

xAI Responses API is one of 17 APIs that xAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Responses. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 3 operations across 2 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against the base URL https://api.x.ai/v1.

3 operations 2 paths 51 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.x.ai/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

xAI Responses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Responses 3
POST
/v1/responses
Generates a response based on text or image prompts.
handle_generic_model_request body → 200400422
GET
/v1/responses/{response_id}
Retrieve a previously generated response
handle_get_stored_completion_request 1 param → 200400404
DELETE
/v1/responses/{response_id}
Delete a previously generated response
handle_delete_stored_completion_request 1 param → 200400404

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are ModelResponse (32 properties), ModelRequest (26 properties), ModelUsage (10 properties), McpCall (8 properties). Each schema is shown below with its type and property counts.

ShellCallOutputResult
object
The content of a shell tool call output that was emitted.
3 properties 1 required
CodeInterpreterOutput
ModelInputContentItem
TopLogProb
object
3 properties 2 required
ModelRequest
object
The request body for /v1/responses endpoint.
26 properties 1 required
ModelResponseConfiguration
object
1 property
IncompleteDetails
Details about why a response is incomplete.
ReasoningConfiguration
object
3 properties
FunctionDefinition
object
Definition of the tool call made available to the model.
4 properties 2 required
CodeInterpreterCall
object
The output of a code interpreter tool call.
5 properties 2 required
SummaryText
object
2 properties 2 required
ServerSideToolUsageDetails
object
6 properties 6 required
WebSearchAction
DeleteStoredCompletionResponse
object
Response to delete a stored completion.
3 properties 3 required
FileSearchResult
object
4 properties 3 required
ModelInputPart
Reasoning
object
The reasoning done by the model.
6 properties 2 required
CustomToolCall
object
The output of a custom tool call.
6 properties 4 required
WebSearchOptions
object
3 properties
ModelInput
Content of the input passed to a /v1/response request.
TokenLogProb
object
4 properties 3 required
ModelResponseFormat
Response format parameter for structured outputs.
SearchSource
ShellEnvironment
object
The environment configuration for a shell tool.
2 properties 1 required
OutputMessage
object
An output message from the model.
5 properties 3 required
WebSearchSource
object
2 properties 1 required
ModelResponse
object
The response body for /v1/responses endpoint.
32 properties 18 required
ModelUsage
object
10 properties 7 required
CompactionOutputItem
object
A compaction item from a previous /v1/responses/compact call. Accepted as input in /v1/responses calls. Clients must treat encryptedcontent as opaque — do not…
3 properties 2 required
OutputMessageContent
McpCall
object
The output of a MCP tool call.
8 properties 5 required
ModelInputContent
ModelTool
Definition of one tool that the model can call.
SearchParameters
object
Parameters to control realtime data.
6 properties
InputTokensDetails
object
1 property 1 required
FunctionToolCallOutput
object
The output of a function tool call.
3 properties 3 required
FunctionToolCall
object
A tool call to run a function.
6 properties 4 required
WebSearchCall
object
The output of a web search tool call.
4 properties 2 required
ModelOutput
WebSearchUserLocation
object
5 properties 1 required
LocalShellSkill
object
A skill available in the local shell environment.
3 properties 3 required
ShellCallOutput
object
The output of a shell tool call, sent by the client after local execution.
4 properties 3 required
ModelToolChoice
Parameter to control how model chooses the tools.
FileSearchCall
object
The output of a web search tool call.
5 properties 3 required
WebSearchFilters
object
2 properties
ShellCallAction
object
The shell commands and limits that describe how to run the tool call.
4 properties 1 required
ShellCallOutcome
The outcome of a shell command execution.
Annotation
object
5 properties 2 required
ReasoningText
object
2 properties 2 required
OutputTokensDetails
object
1 property 1 required
ShellCall
object
A shell command call emitted by the model for local execution.
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xai-responses-api-openapi.yml Raw ↑

Other APIs xAI publishes across the network.

xAI Api Key API
xAI Chat API
xAI Complete API
xAI Completions API
xAI Documents API
xAI Embedding Models API
xAI Embeddings API
xAI Files API
xAI Image Generation Models API
xAI Images API
xAI Language Models API
xAI Messages API
Where this information came from

This is an independent, third-party profile of xAI Responses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.