Ask API
ask-apiAsk API lookup for natural language website list queries. OpenAI requests are served as preview results and do not commit full reports.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"query": "<query>"
},
"name": "ask-api"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| meta | No | Set to true to include metadata in the results | |
| query | Yes | The natural language query (e.g. 'Magento websites in Spain') | |
| commit | No | Ignored for OpenAI/ChatGPT requests; preview mode is always used there | |
| nextOffset | No | Pagination offset from the previous response's NextOffset |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| count | Yes | ||
| query | Yes | ||
| sites | Yes | ||
| committed | Yes | ||
| nextOffset | No | ||
| openAiPreview | Yes | ||
| requestedCommit | Yes |