AlterLabAPI Reference
Auto-generated
Search
API reference for search endpoints.
Auto-generated
This page was generated from the OpenAPI spec. Run
make generate-docs to refresh after spec changes.POST /api/v1/search
POST
/api/v1/searchSearch the web
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| query | string | Required | Search terms (max 500 characters) |
| domain | string | Optional | domain |
| num_results | integer | Optional | Number of results to return (1-30)Default: 10 |
| page | integer | Optional | Result page number (1-indexed). Page 2 returns results 11-20, etc.Default: 1 |
| country | string | Optional | country |
| language | string | Optional | language |
| time_range | "hour" | "day" | "week" | "month" | "year" | Optional | time_range |
| safe_search | boolean | Optional | Enable safe search filtering (default: true). When false, disables DDG Lite's adult content filter (sends p=-1 instead of p=-2).Default: True |
| scrape_results | boolean | Optional | If true, scrape each result page and include content in responseDefault: False |
| formats | string[] | Optional | formats |
| extraction_schema | object | Optional | extraction_schema |
Request Example
Bash
curl -X POST https://api.alterlab.io/api/v1/search \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "example_query",
"num_results": 10,
"page": 1
}'Response Example
JSON
{
"search_id": "example",
"query": "example",
"results_requested": 0,
"results_count": 0,
"credits_used": 0,
"cost_breakdown": "example"
}GET /api/v1/search/{search_id}
GET
/api/v1/search/{search_id}Get search status
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| search_id | string | Required | search_id |
Request Example
Bash
curl -X GET https://api.alterlab.io/api/v1/search/<search_id> \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json"Response Example
JSON
{
"search_id": "example",
"query": "example",
"status": "example",
"results_requested": 0,
"results_count": 0,
"completed": 0
}