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 Documents API

The Documents API from xAI — 1 operation(s) for documents.

xAI Documents 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 Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 15 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.

1 operations 1 paths 15 schemas 1 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 Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 1
POST
/v1/documents/search
Search for content related to the query within the given collections
handle_document_search_request_v2 body → 200400

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are SearchRequest (8 properties), SearchMatch (7 properties), ReciprocalRankFusion (3 properties), DocumentsSource (2 properties). Each schema is shown below with its type and property counts.

HybridRetrieval
object
Document search using a combination of keyword and semantic search.
2 properties
KeywordRetrieval
object
Document search using keyword matching (sparse embeddings).
1 property
GroupBy
object
Group search results by metadata key(s) and keep top-k per group.
2 properties 1 required
RagPipeline
string
RankingMetric
string
Deprecated: Metric now comes from collection creation.
SearchMatch
object
SearchMatch defines a single match from a search request.
7 properties 6 required
RetrievalMode
Retrieval mode configuration for document search.
SearchRequest
object
SearchRequest defines the request to search for documents.
8 properties 2 required
GroupByAggregate
Aggregation function to apply within each group.
RerankerModel
object
Configuration for model-based reranking.
2 properties
HybridReranker
Reranker configuration for hybrid retrieval.
DocumentsSource
object
DocumentsSource defines the source of documents to search over.
2 properties 1 required
ReciprocalRankFusion
object
Configuration for reciprocal rank fusion (RRF) reranking.
3 properties
SemanticRetrieval
object
Document search using semantic similarity (dense embeddings).
1 property
SearchResponse
object
SearchResponse defines the response to a search request.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xai-documents-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 Embedding Models API
xAI Embeddings API
xAI Files API
xAI Image Generation Models API
xAI Images API
xAI Language Models API
xAI Messages API
xAI Models API
Where this information came from

This is an independent, third-party profile of xAI Documents 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.