Skip to main content
POST
Build implementation context

Authorizations

Authorization
string
header
required

Mintlify Index API key with the mint_us_ prefix.

Body

application/json
query
string
required

Implementation question to research.

Minimum string length: 1
format
enum<string>
required

Format of the response string. txt returns Markdown sections. json returns a serialized JSON object containing result items.

Available options:
txt,
json
product
string

Product or company name to use as an additional retrieval hint.

Minimum string length: 1
includeDomains
string[]

Domains to include in retrieval.

Minimum array length: 1
Minimum string length: 1
excludeDomains
string[]

Domains to exclude from retrieval.

Minimum array length: 1
Minimum string length: 1
tokenBudget
integer
default:3000

Maximum number of output tokens.

Required range: 1 <= x <= 6000

Response

Context assembled successfully.

requestId
string
required

Unique identifier for the request.

query
string
required

Original query from the request.

response
string
required

Assembled source content. The value is Markdown for txt requests and serialized JSON for json requests. The string can be empty when no content fits within the token budget.

resultsCount
integer
required

Number of source snippets included in the response.

Required range: x >= 0
outputTokens
integer
required

Number of tokens in the assembled response.

Required range: x >= 0