Search documentation

Performs a hybrid search combining semantic understanding and keyword matching across all indexed documentation pages.

curl -X GET "https://api.documentationai.app/api/v1/search?q=example_string&limit=42&semanticRatio=3.14" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://api.documentationai.app/api/v1/search?q=example_string&limit=42&semanticRatio=3.14"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://api.documentationai.app/api/v1/search?q=example_string&limit=42&semanticRatio=3.14", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.documentationai.app/api/v1/search?q=example_string&limit=42&semanticRatio=3.14", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.documentationai.app/api/v1/search?q=example_string&limit=42&semanticRatio=3.14')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

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

{
  "results": [
    {
      "title": "example_string",
      "path": "example_string",
      "url": "example_string",
      "content": "example_string",
      "relevanceScore": 3.14
    }
  ],
  "query": "example_string",
  "count": 10
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}