Mintlify Index
Get result contents
Retrieve content from Mintlify Index by result ID or result URL after searching.
POST
/
v1
/
contents
Get result contents
curl --request POST \
--url https://leaves.mintlify.com/api/universal-search/v1/contents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"nextjs:/docs/app/getting-started/caching-and-revalidating"
],
"query": "revalidate cached data",
"maxCharacters": 12000
}
'import requests
url = "https://leaves.mintlify.com/api/universal-search/v1/contents"
payload = {
"ids": ["nextjs:/docs/app/getting-started/caching-and-revalidating"],
"query": "revalidate cached data",
"maxCharacters": 12000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['nextjs:/docs/app/getting-started/caching-and-revalidating'],
query: 'revalidate cached data',
maxCharacters: 12000
})
};
fetch('https://leaves.mintlify.com/api/universal-search/v1/contents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://leaves.mintlify.com/api/universal-search/v1/contents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'nextjs:/docs/app/getting-started/caching-and-revalidating'
],
'query' => 'revalidate cached data',
'maxCharacters' => 12000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://leaves.mintlify.com/api/universal-search/v1/contents"
payload := strings.NewReader("{\n \"ids\": [\n \"nextjs:/docs/app/getting-started/caching-and-revalidating\"\n ],\n \"query\": \"revalidate cached data\",\n \"maxCharacters\": 12000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://leaves.mintlify.com/api/universal-search/v1/contents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"nextjs:/docs/app/getting-started/caching-and-revalidating\"\n ],\n \"query\": \"revalidate cached data\",\n \"maxCharacters\": 12000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://leaves.mintlify.com/api/universal-search/v1/contents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"nextjs:/docs/app/getting-started/caching-and-revalidating\"\n ],\n \"query\": \"revalidate cached data\",\n \"maxCharacters\": 12000\n}"
response = http.request(request)
puts response.read_body{
"requestId": "6bf694e4-76cb-4d31-a222-c94b2d9b198a",
"results": [
{
"id": "nextjs:/docs/app/getting-started/caching-and-revalidating",
"url": "https://nextjs.org/docs/app/getting-started/caching-and-revalidating",
"title": "Caching and revalidating",
"text": "# Caching and revalidating\n\nUse revalidation APIs to refresh cached data.",
"truncated": false,
"totalCharacters": 78,
"score": 0,
"source": "mintlify",
"siteName": "nextjs",
"breadcrumbs": [
"App Router",
"Getting started"
],
"publishedDate": null
}
],
"statuses": [
{
"id": "nextjs:/docs/app/getting-started/caching-and-revalidating",
"status": "success"
}
]
}{
"error": "A request may reference at most 20 items across urls and ids"
}{
"error": "Unauthorized"
}{
"error": "IP address is not allowed for this API key"
}{
"error": "Rate limit exceeded. Please try again later"
}{
"error": "<string>"
}Authorizations
Mintlify Index API key with the mint_us_ prefix.
Body
application/json
- Option 1
- Option 2
Provide at least one Mintlify result ID or result URL. You can combine both fields, with up to 20 items total.
Result URLs to retrieve. Use this field for web results.
Required array length:
1 - 20 elementsMintlify result IDs to retrieve.
Required array length:
1 - 20 elementsMinimum string length:
1Maximum number of content characters to return per result.
Required range:
x >= 1Query used to select the most relevant sections when content exceeds maxCharacters.
Minimum string length:
1Response
Content retrieval completed. Check each status to determine whether its item succeeded.
⌘I
Get result contents
curl --request POST \
--url https://leaves.mintlify.com/api/universal-search/v1/contents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"nextjs:/docs/app/getting-started/caching-and-revalidating"
],
"query": "revalidate cached data",
"maxCharacters": 12000
}
'import requests
url = "https://leaves.mintlify.com/api/universal-search/v1/contents"
payload = {
"ids": ["nextjs:/docs/app/getting-started/caching-and-revalidating"],
"query": "revalidate cached data",
"maxCharacters": 12000
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ids: ['nextjs:/docs/app/getting-started/caching-and-revalidating'],
query: 'revalidate cached data',
maxCharacters: 12000
})
};
fetch('https://leaves.mintlify.com/api/universal-search/v1/contents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://leaves.mintlify.com/api/universal-search/v1/contents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ids' => [
'nextjs:/docs/app/getting-started/caching-and-revalidating'
],
'query' => 'revalidate cached data',
'maxCharacters' => 12000
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://leaves.mintlify.com/api/universal-search/v1/contents"
payload := strings.NewReader("{\n \"ids\": [\n \"nextjs:/docs/app/getting-started/caching-and-revalidating\"\n ],\n \"query\": \"revalidate cached data\",\n \"maxCharacters\": 12000\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://leaves.mintlify.com/api/universal-search/v1/contents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"nextjs:/docs/app/getting-started/caching-and-revalidating\"\n ],\n \"query\": \"revalidate cached data\",\n \"maxCharacters\": 12000\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://leaves.mintlify.com/api/universal-search/v1/contents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"nextjs:/docs/app/getting-started/caching-and-revalidating\"\n ],\n \"query\": \"revalidate cached data\",\n \"maxCharacters\": 12000\n}"
response = http.request(request)
puts response.read_body{
"requestId": "6bf694e4-76cb-4d31-a222-c94b2d9b198a",
"results": [
{
"id": "nextjs:/docs/app/getting-started/caching-and-revalidating",
"url": "https://nextjs.org/docs/app/getting-started/caching-and-revalidating",
"title": "Caching and revalidating",
"text": "# Caching and revalidating\n\nUse revalidation APIs to refresh cached data.",
"truncated": false,
"totalCharacters": 78,
"score": 0,
"source": "mintlify",
"siteName": "nextjs",
"breadcrumbs": [
"App Router",
"Getting started"
],
"publishedDate": null
}
],
"statuses": [
{
"id": "nextjs:/docs/app/getting-started/caching-and-revalidating",
"status": "success"
}
]
}{
"error": "A request may reference at most 20 items across urls and ids"
}{
"error": "Unauthorized"
}{
"error": "IP address is not allowed for this API key"
}{
"error": "Rate limit exceeded. Please try again later"
}{
"error": "<string>"
}