POST
/
extractTask
/
batch
/
search
curl --request POST \
  --url https://gateway.allstream.ai/api/openapi/v1/extractTask/batch/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "querys": [
    "chatgpt",
    "gpt4all"
  ],
  "start": 0,
  "num": 100,
  "hl": "en",
  "gl": "US",
  "cr": "US",
  "lr": "en",
  "timeout": 3000,
  "webhook": "https://www.example.com/webhook"
}'
{
  "requestId": "54a96d90-3b22-4cb4-ba94-aca41fddfac5",
  "code": 0,
  "errorCode": 200,
  "message": "Success",
  "timestamp": 1732087136396,
  "data": [
    {
      "name": "extract",
      "data": {
        "url": "https://www.google.com/maps/place/Danny's+Construction+Co/@41.610615,-87.374627,17z/data=!3m1!4b1!4m6!3m5!1s0x8811c2d7913ae0fb:0xe42462317b2501dd!8m2!3d41.610615!4d-87.374627!16s%2Fg%2F1wb8v8_f?hl=en&entry=ttu&g_ep=EgoyMDI0MTAyOS4wIKXMDSoASAFQAw%3D%3D",
        "timeout": 25000,
        "webhook": "http://127.0.0.1:40922/",
        "type": "google-maps"
      },
      "opts": {
        "attempts": 5,
        "removeOnComplete": 300000,
        "removeOnFail": 100000,
        "backoff": {
          "type": "fixed",
          "delay": 1000
        }
      },
      "id": "7",
      "progress": 0,
      "returnvalue": null,
      "stacktrace": null,
      "priority": 0,
      "attemptsStarted": 0,
      "attemptsMade": 0,
      "timestamp": 1732087136155,
      "queueQualifiedName": "bull:openapi"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Body

application/json
querys
string[]
required

List of search queries

webhook
string
required

Webhook URL to send results to

start
integer
default:
0

Start index for pagination

num
integer
default:
100

Number of results to return for each query

hl
string
default:
en

Host language

gl
string
default:
US

Geolocation

cr
string

Country restrict

lr
string

Language restrict

timeout
integer
default:
25000

Timeout in milliseconds for each query

Response

200 - application/json
Success
requestId
string
required

Unique identifier for the request

code
integer
required

Response code indicating the status of the request

timestamp
integer
required

ISO 8601 formatted timestamp of when the request was processed

data
object[]
required

Array of batch published task details

errorCode
integer

Error code details, if applicable

message
string

Response message