WaQi

HTTP API Reference

Authentication, request shape, and response format for the Search API.

The Search API endpoint is located at https://api.search.waqitech.com/. It accepts a POST request with a JSON body and returns a JSON response containing a list of web results.

Authentication

All requests must include a bearer token issued from your WaQi account.

Required Headers:

  • Authorization: Bearer <YOUR_API_KEY>
  • Content-Type: application/json

Requests without a valid token return 401 Unauthorized.

Rate Limits

The API is rate limited to 40 requests per minute per API key. Requests above this threshold return 429 Too Many Requests.

Submit a query and receive a list of results.

Endpoint: POST https://api.search.waqitech.com/v0/search

Request Body:

{
  "query": "cloud browser automation",
  "language": "en"
}
FieldTypeRequiredDescription
querystringYesThe search query. Must be between 1 and 348 characters.
languagestringNoLanguage code used to bias results (e.g. "en", "fr"). Defaults to "en".

Response: 200 OK

{
  "results": [
    {
      "url": "https://example.com/article",
      "title": "An example result title",
      "snippet": "A short excerpt from the page describing its content."
    }
  ]
}

Each entry in results has the following shape:

FieldTypeDescription
urlstringCanonical URL of the result page.
titlestringPage title.
snippetstringShort text excerpt describing the page.

Results are ranked by relevance, and duplicate URLs are collapsed into a single entry.

Errors

StatusMeaning
400The request body did not match the schema (for example, query was empty or too long).
401Missing or invalid Authorization header.
429You exceeded the per-key rate limit. Retry after a short delay.
502The search backend temporarily failed to return results. Retrying is usually sufficient.

Apart from 400 (which returns a structured validation error), error responses use the shape { "error": string }.

Example

curl https://api.search.waqitech.com/v0/search \
  -H "Authorization: Bearer $WAQI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "cloud browser automation",
    "language": "en"
  }'

On this page