POST
/
extractTask
/
batch
/
maps
curl --request POST \
  --url https://gateway.allstream.ai/api/openapi/v1/extractTask/batch/maps \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "querys": [
    "chatgpt",
    "gpt4all"
  ],
  "ll": "@46.423669,-122.176129,3z",
  "hl": "en",
  "start": 0,
  "num": 100,
  "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": {
        "querys": [
          "chatgpt",
          "gpt4all"
        ],
        "ll": "@46.423669,-122.176129,3z",
        "hl": "en",
        "timeout": 25000,
        "webhook": "https://www.example.com/webhook"
      },
      "opts": {
        "attempts": 5,
        "removeOnComplete": 300000,
        "removeOnFail": 100000,
        "backoff": {
          "type": "fixed",
          "delay": 1000
        }
      },
      "id": "8",
      "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

​
ll
string
default:
@46.423669,-122.176129,3z

Latitude and longitude with zoom level

​
hl
string
default:
en

Host language

​
start
integer
default:
0

Start index for pagination

​
num
integer
default:
100

Number of results to return for each query

​
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

Extract Search Maps