Rechercher dans la documentation
Effectuez des recherches sémantiques et par mots-clés dans votre documentation, avec un filtrage et une pagination configurables.
curl --request POST \
--url https://api.mintlify.com/discovery/v1/search/{domain} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"pageSize": 10,
"scoreThreshold": 0.5,
"filter": {
"version": "<string>",
"language": "<string>",
"tag": "<string>"
}
}
'import requests
url = "https://api.mintlify.com/discovery/v1/search/{domain}"
payload = {
"query": "<string>",
"pageSize": 10,
"scoreThreshold": 0.5,
"filter": {
"version": "<string>",
"language": "<string>",
"tag": "<string>"
}
}
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({
query: '<string>',
pageSize: 10,
scoreThreshold: 0.5,
filter: {version: '<string>', language: '<string>', tag: '<string>'}
})
};
fetch('https://api.mintlify.com/discovery/v1/search/{domain}', 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://api.mintlify.com/discovery/v1/search/{domain}",
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([
'query' => '<string>',
'pageSize' => 10,
'scoreThreshold' => 0.5,
'filter' => [
'version' => '<string>',
'language' => '<string>',
'tag' => '<string>'
]
]),
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://api.mintlify.com/discovery/v1/search/{domain}"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"scoreThreshold\": 0.5,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\",\n \"tag\": \"<string>\"\n }\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://api.mintlify.com/discovery/v1/search/{domain}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"scoreThreshold\": 0.5,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\",\n \"tag\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintlify.com/discovery/v1/search/{domain}")
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 \"query\": \"<string>\",\n \"pageSize\": 10,\n \"scoreThreshold\": 0.5,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\",\n \"tag\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body[
{
"content": "<string>",
"path": "<string>",
"metadata": {}
}
]Limites de débit
- 10 000 requêtes par organisation Mintlify par heure
Autorisations
Paramètres de chemin
L’identifiant de domaine extrait de votre URL domain.mintlify.site. Il se trouve à la fin de l’URL de votre Dashboard. Par exemple, dans dashboard.mintlify.com/organization/domain, l’identifiant de domaine est domain.
Corps
La requête de recherche à exécuter sur le contenu de votre documentation.
Nombre de résultats de recherche à retourner. Doit être compris entre 1 et 50. La valeur par défaut est 10 si aucune valeur n’est spécifiée.
1 <= x <= 50Score de pertinence minimal pour les résultats. Seuls les résultats ayant un score supérieur ou égal à ce seuil sont renvoyés. Doit être compris entre 0 et 1.
0 <= x <= 1Paramètres de filtrage optionnels permettant de restreindre les résultats de recherche.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?
curl --request POST \
--url https://api.mintlify.com/discovery/v1/search/{domain} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"pageSize": 10,
"scoreThreshold": 0.5,
"filter": {
"version": "<string>",
"language": "<string>",
"tag": "<string>"
}
}
'import requests
url = "https://api.mintlify.com/discovery/v1/search/{domain}"
payload = {
"query": "<string>",
"pageSize": 10,
"scoreThreshold": 0.5,
"filter": {
"version": "<string>",
"language": "<string>",
"tag": "<string>"
}
}
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({
query: '<string>',
pageSize: 10,
scoreThreshold: 0.5,
filter: {version: '<string>', language: '<string>', tag: '<string>'}
})
};
fetch('https://api.mintlify.com/discovery/v1/search/{domain}', 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://api.mintlify.com/discovery/v1/search/{domain}",
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([
'query' => '<string>',
'pageSize' => 10,
'scoreThreshold' => 0.5,
'filter' => [
'version' => '<string>',
'language' => '<string>',
'tag' => '<string>'
]
]),
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://api.mintlify.com/discovery/v1/search/{domain}"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"scoreThreshold\": 0.5,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\",\n \"tag\": \"<string>\"\n }\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://api.mintlify.com/discovery/v1/search/{domain}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"pageSize\": 10,\n \"scoreThreshold\": 0.5,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\",\n \"tag\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintlify.com/discovery/v1/search/{domain}")
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 \"query\": \"<string>\",\n \"pageSize\": 10,\n \"scoreThreshold\": 0.5,\n \"filter\": {\n \"version\": \"<string>\",\n \"language\": \"<string>\",\n \"tag\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body[
{
"content": "<string>",
"path": "<string>",
"metadata": {}
}
]