Search
Search
Start a new search job
Authorization
ApiKeyAuth X-Api-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/search" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"query": "string",
"page": 0,
"attempts": 0,
"results": [
{
"position": 0,
"title": "string",
"url": "string",
"snippet": "",
"thumbnail": "string",
"displayed_url": "string",
"source_host": "string"
}
],
"suggestions": [
"string"
],
"spelling_correction": "string"
}Empty
{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"error": "string",
"message": "string",
"details": {}
}Empty
{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"error": "string",
"message": "string",
"details": {}
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}Authorization
ApiKeyAuth X-Api-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/search" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{
"job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
"query": "string",
"page": 0,
"attempts": 0,
"results": [
{
"position": 0,
"title": "string",
"url": "string",
"snippet": "",
"thumbnail": "string",
"displayed_url": "string",
"source_host": "string"
}
],
"suggestions": [
"string"
],
"spelling_correction": "string"
}Empty
{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"error": "string",
"message": "string",
"details": {}
}Empty
{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}{
"error": "string",
"message": "string",
"details": {}
}{
"code": "string",
"message": "string",
"correlation_id": "string",
"retryable": true
}