Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pratyay360/searchapi/llms.txt

Use this file to discover all available pages before exploring further.

SearchAPI includes three utility endpoints that are not part of the search functionality. The root endpoint (/) confirms the service is running. The health endpoint (/health) returns a minimal status response suitable for load balancers and uptime monitors. The user agent endpoint (/useragent/) returns a random browser user agent string generated by the fake-useragent library, which is useful for testing or building scraping tools.

GET /

Returns a status message confirming the API is online and provides the MCP server path.

Request

GET /

Parameters

None.

Example

curl "http://localhost:8000/"
Response
{
  "message": "DataOrchestra API is online and ready to use!",
  "mcp server": "/mcp"
}

GET /health

Returns a simple {"status": "ok"} response. Use this endpoint for health checks from load balancers, container orchestrators (such as Kubernetes or Docker Swarm), and uptime monitoring services.

Request

GET /health

Parameters

None.

Example

curl "http://localhost:8000/health"
Response
{ "status": "ok" }

GET /useragent/

Returns a single random user agent string generated by the fake-useragent library. The string represents a realistic browser user agent, useful for testing HTTP clients, building scraping tools, or populating request headers.

Request

GET /useragent/

Parameters

None.

Example

curl "http://localhost:8000/useragent/"
Response
"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36"
The response is a JSON string, not an object. Parse it with response.json() rather than response.json()["user_agent"].

Error response

500
{ "error": "Failed to generate user agent string" }

Build docs developers (and LLMs) love