Skip to main content
Use the Guides tab for hosted tag installation, WebSocket orchestration, and integration walkthroughs. Use this tab for REST request and response schemas.

​
API surface

Search API

Use post_query, dynamic_cta, get_suggestions, and health to power Webless search experiences.

Data API

Use query-data to generate a pre-signed URL for analytics exports.
The REST endpoints below use Mintlify’s interactive API playground with prefilled examples, so users can send test requests directly from the docs.

​
Authentication

  • Search API requests use your provisioned company value in the request body.
  • Data API requests require x-api-key in the request headers.

​
Environment URLs

SurfaceProduction
Search REST APIhttps://api.webless.ai
Search WebSocketwss://api.webless.ai/ws
Data APIhttps://portal.webless.ai
If you are building your own UI, pair this reference with Build a custom frontend.
The interactive playground applies to the REST endpoints in this section. If you want the same kind of generated reference for /ws, the next step is to add an AsyncAPI schema for the WebSocket surface.