Search documentation - Mintlify

POST

/

search

/

{domain}

Search documentation

curl --request POST \
  --url https://api-dsc.mintlify.com/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'

import requests

url = "https://api-dsc.mintlify.com/v1/search/{domain}"

payload = {
    "query": "<string>",
    "pageSize": 10,
    "filter": {
        "version": "<string>",
        "language": "<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,
    filter: {version: '<string>', language: '<string>'}
  })
};

fetch('https://api-dsc.mintlify.com/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-dsc.mintlify.com/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,
    'filter' => [
        'version' => '<string>',
        'language' => '<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-dsc.mintlify.com/v1/search/{domain}"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"pageSize\": 10,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<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-dsc.mintlify.com/v1/search/{domain}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"pageSize\": 10,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-dsc.mintlify.com/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  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]

Autorizaciones

Authorization

string

header

requerido

The Authorization header expects a Bearer token. See the Assistant API Key documentation for details on how to get your API key.

Parámetros de ruta

domain

string

requerido

The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.

Cuerpo

application/json

query

string

requerido

The search query to execute against your documentation content.

pageSize

number

predeterminado:10

Number of search results to return. Defaults to 10 if not specified.

filter

object

Optional filtering parameters to narrow search results.

Show child attributes

Respuesta

200 - application/json

Search results

content

string

The matching content from your documentation.

path

string

The path or URL to the source document.

metadata

object

Additional metadata about the search result, including relevance scoring and other contextual information.

Assistant messageGenerates a response message from the assistant for the specified domain.

Search documentation

curl --request POST \
  --url https://api-dsc.mintlify.com/v1/search/{domain} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pageSize": 10,
  "filter": {
    "version": "<string>",
    "language": "<string>"
  }
}
'

import requests

url = "https://api-dsc.mintlify.com/v1/search/{domain}"

payload = {
    "query": "<string>",
    "pageSize": 10,
    "filter": {
        "version": "<string>",
        "language": "<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,
    filter: {version: '<string>', language: '<string>'}
  })
};

fetch('https://api-dsc.mintlify.com/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-dsc.mintlify.com/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,
    'filter' => [
        'version' => '<string>',
        'language' => '<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-dsc.mintlify.com/v1/search/{domain}"

	payload := strings.NewReader("{\n  \"query\": \"<string>\",\n  \"pageSize\": 10,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<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-dsc.mintlify.com/v1/search/{domain}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"<string>\",\n  \"pageSize\": 10,\n  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-dsc.mintlify.com/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  \"filter\": {\n    \"version\": \"<string>\",\n    \"language\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

[
  {
    "content": "<string>",
    "path": "<string>",
    "metadata": {}
  }
]