Endpoints
Scrape
Endpoints
Scrape
POST
/
scrape
curl --request POST \
--url https://gateway.allstream.ai/api/openapi/v1/scrape \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '""'{
"requestId": "68a93faa-c67b-4b15-9ce3-c2c5c1fd5834",
"code": 0,
"errorCode": 200,
"message": "Success",
"timestamp": 1732179933181,
"data": {
"sourceURL": "https://example.com/",
"taskId": "3136449291826527777",
"edgeId": "595fc46091487e8ce9211af635976803",
"status": 2,
"rawStatus": 200,
"html": "JTNDIWRvY3R5cGUlMjBodG1sJTNFJTBBJTNDaHRtbCUzRSUwQSUzQ2hlYWQlM0UlMEElMjAlMjAlMjAlMjAlM0N0aXRsZSUzRUV4YW1wbGUlMjBEb21haW4lM0MlMkZ0aXRsZSUzRSUwQSUwQSUyMCUyMCUyMCUyMCUzQ21ldGElMjBjaGFyc2V0JTNEJTIydXRmLTglMjIlMjAlMkYlM0UlMEElMjAlMjAlMjAlMjAlM0NtZXRhJTIwaHR0cC1lcXVpdiUzRCUyMkNvbnRlbnQtdHlwZSUyMiUyMGNvbnRlbnQlM0QlMjJ0ZXh0JTJGaHRtbCUzQiUyMGNoYXJzZXQlM0R1dGYtOCUyMiUyMCUyRiUzRSUwQSUyMCUyMCUyMCUyMCUzQ21ldGElMjBuYW1lJTNEJTIydmlld3BvcnQlMjIlMjBjb250ZW50JTNEJTIyd2lkdGglM0RkZXZpY2Utd2lkdGglMkMlMjBpbml0aWFsLXNjYWxlJTNEMSUyMiUyMCUyRiUzRSUwQSUyMCUyMCUyMCUyMCUzQ3N0eWxlJTIwdHlwZSUzRCUyMnRleHQlMkZjc3MlMjIlM0UlMEElMjAlMjAlMjAlMjBib2R5JTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwYmFja2dyb3VuZC1jb2xvciUzQSUyMCUyM2YwZjBmMiUzQiUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMG1hcmdpbiUzQSUyMDAlM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjBwYWRkaW5nJTNBJTIwMCUzQiUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMGZvbnQtZmFtaWx5JTNBJTIwLWFwcGxlLXN5c3RlbSUyQyUyMHN5c3RlbS11aSUyQyUyMEJsaW5rTWFjU3lzdGVtRm9udCUyQyUyMCUyMlNlZ29lJTIwVUklMjIlMkMlMjAlMjJPcGVuJTIwU2FucyUyMiUyQyUyMCUyMkhlbHZldGljYSUyME5ldWUlMjIlMkMlMjBIZWx2ZXRpY2ElMkMlMjBBcmlhbCUyQyUyMHNhbnMtc2VyaWYlM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMEElMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjBkaXYlMjAlN0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjB3aWR0aCUzQSUyMDYwMHB4JTNCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwbWFyZ2luJTNBJTIwNWVtJTIwYXV0byUzQiUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMHBhZGRpbmclM0ElMjAyZW0lM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjBiYWNrZ3JvdW5kLWNvbG9yJTNBJTIwJTIzZmRmZGZmJTNCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwYm9yZGVyLXJhZGl1cyUzQSUyMDAuNWVtJTNCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwYm94LXNoYWRvdyUzQSUyMDJweCUyMDNweCUyMDdweCUyMDJweCUyMHJnYmEoMCUyQzAlMkMwJTJDMC4wMiklM0IlMEElMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjBhJTNBbGluayUyQyUyMGElM0F2aXNpdGVkJTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwY29sb3IlM0ElMjAlMjMzODQ4OGYlM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjB0ZXh0LWRlY29yYXRpb24lM0ElMjBub25lJTNCJTBBJTIwJTIwJTIwJTIwJTdEJTBBJTIwJTIwJTIwJTIwJTQwbWVkaWElMjAobWF4LXdpZHRoJTNBJTIwNzAwcHgpJTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwZGl2JTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwbWFyZ2luJTNBJTIwMCUyMGF1dG8lM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjB3aWR0aCUzQSUyMGF1dG8lM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjAlM0MlMkZzdHlsZSUzRSUyMCUyMCUyMCUyMCUwQSUzQyUyRmhlYWQlM0UlMEElMEElM0Nib2R5JTNFJTBBJTNDZGl2JTNFJTBBJTIwJTIwJTIwJTIwJTNDaDElM0VFeGFtcGxlJTIwRG9tYWluJTNDJTJGaDElM0UlMEElMjAlMjAlMjAlMjAlM0NwJTNFVGhpcyUyMGRvbWFpbiUyMGlzJTIwZm9yJTIwdXNlJTIwaW4lMjBpbGx1c3RyYXRpdmUlMjBleGFtcGxlcyUyMGluJTIwZG9jdW1lbnRzLiUyMFlvdSUyMG1heSUyMHVzZSUyMHRoaXMlMEElMjAlMjAlMjAlMjBkb21haW4lMjBpbiUyMGxpdGVyYXR1cmUlMjB3aXRob3V0JTIwcHJpb3IlMjBjb29yZGluYXRpb24lMjBvciUyMGFza2luZyUyMGZvciUyMHBlcm1pc3Npb24uJTNDJTJGcCUzRSUwQSUyMCUyMCUyMCUyMCUzQ3AlM0UlM0NhJTIwaHJlZiUzRCUyMmh0dHBzJTNBJTJGJTJGd3d3LmlhbmEub3JnJTJGZG9tYWlucyUyRmV4YW1wbGUlMjIlM0VNb3JlJTIwaW5mb3JtYXRpb24uLi4lM0MlMkZhJTNFJTNDJTJGcCUzRSUwQSUzQyUyRmRpdiUzRSUwQSUzQyUyRmJvZHklM0UlMEElM0MlMkZodG1sJTNFJTBB"
}
}Authorizations
Body
application/json
The URL to scrape
Formats to include in the output. Available options: markdown, html
Headers to send with the request. Can be used to send cookies, user-agent, etc.
Timeout in milliseconds for the request
Response
200 - application/json
Success
Unique identifier for the request
Response code indicating the status of the request
ISO 8601 formatted timestamp of when the request was processed
Response data object, structure defined in the referenced schema
A unique identifier for the request.
The status code of the response.
The error code if an error occurred.
A human-readable message describing the response.
The time at which the response was generated.
Extracted data
A unique identifier for the task.
The current status of the task. values : 'completed', 'failed', 'delayed', 'active', 'waiting', 'waiting-children', 'unknown'.
A stack trace in case of an error, otherwise null.
Object containing error code details, if applicable
curl --request POST \
--url https://gateway.allstream.ai/api/openapi/v1/scrape \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '""'{
"requestId": "68a93faa-c67b-4b15-9ce3-c2c5c1fd5834",
"code": 0,
"errorCode": 200,
"message": "Success",
"timestamp": 1732179933181,
"data": {
"sourceURL": "https://example.com/",
"taskId": "3136449291826527777",
"edgeId": "595fc46091487e8ce9211af635976803",
"status": 2,
"rawStatus": 200,
"html": "JTNDIWRvY3R5cGUlMjBodG1sJTNFJTBBJTNDaHRtbCUzRSUwQSUzQ2hlYWQlM0UlMEElMjAlMjAlMjAlMjAlM0N0aXRsZSUzRUV4YW1wbGUlMjBEb21haW4lM0MlMkZ0aXRsZSUzRSUwQSUwQSUyMCUyMCUyMCUyMCUzQ21ldGElMjBjaGFyc2V0JTNEJTIydXRmLTglMjIlMjAlMkYlM0UlMEElMjAlMjAlMjAlMjAlM0NtZXRhJTIwaHR0cC1lcXVpdiUzRCUyMkNvbnRlbnQtdHlwZSUyMiUyMGNvbnRlbnQlM0QlMjJ0ZXh0JTJGaHRtbCUzQiUyMGNoYXJzZXQlM0R1dGYtOCUyMiUyMCUyRiUzRSUwQSUyMCUyMCUyMCUyMCUzQ21ldGElMjBuYW1lJTNEJTIydmlld3BvcnQlMjIlMjBjb250ZW50JTNEJTIyd2lkdGglM0RkZXZpY2Utd2lkdGglMkMlMjBpbml0aWFsLXNjYWxlJTNEMSUyMiUyMCUyRiUzRSUwQSUyMCUyMCUyMCUyMCUzQ3N0eWxlJTIwdHlwZSUzRCUyMnRleHQlMkZjc3MlMjIlM0UlMEElMjAlMjAlMjAlMjBib2R5JTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwYmFja2dyb3VuZC1jb2xvciUzQSUyMCUyM2YwZjBmMiUzQiUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMG1hcmdpbiUzQSUyMDAlM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjBwYWRkaW5nJTNBJTIwMCUzQiUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMGZvbnQtZmFtaWx5JTNBJTIwLWFwcGxlLXN5c3RlbSUyQyUyMHN5c3RlbS11aSUyQyUyMEJsaW5rTWFjU3lzdGVtRm9udCUyQyUyMCUyMlNlZ29lJTIwVUklMjIlMkMlMjAlMjJPcGVuJTIwU2FucyUyMiUyQyUyMCUyMkhlbHZldGljYSUyME5ldWUlMjIlMkMlMjBIZWx2ZXRpY2ElMkMlMjBBcmlhbCUyQyUyMHNhbnMtc2VyaWYlM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMEElMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjBkaXYlMjAlN0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjB3aWR0aCUzQSUyMDYwMHB4JTNCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwbWFyZ2luJTNBJTIwNWVtJTIwYXV0byUzQiUwQSUyMCUyMCUyMCUyMCUyMCUyMCUyMCUyMHBhZGRpbmclM0ElMjAyZW0lM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjBiYWNrZ3JvdW5kLWNvbG9yJTNBJTIwJTIzZmRmZGZmJTNCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwYm9yZGVyLXJhZGl1cyUzQSUyMDAuNWVtJTNCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwYm94LXNoYWRvdyUzQSUyMDJweCUyMDNweCUyMDdweCUyMDJweCUyMHJnYmEoMCUyQzAlMkMwJTJDMC4wMiklM0IlMEElMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjBhJTNBbGluayUyQyUyMGElM0F2aXNpdGVkJTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwY29sb3IlM0ElMjAlMjMzODQ4OGYlM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjB0ZXh0LWRlY29yYXRpb24lM0ElMjBub25lJTNCJTBBJTIwJTIwJTIwJTIwJTdEJTBBJTIwJTIwJTIwJTIwJTQwbWVkaWElMjAobWF4LXdpZHRoJTNBJTIwNzAwcHgpJTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwZGl2JTIwJTdCJTBBJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwJTIwbWFyZ2luJTNBJTIwMCUyMGF1dG8lM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjB3aWR0aCUzQSUyMGF1dG8lM0IlMEElMjAlMjAlMjAlMjAlMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjAlN0QlMEElMjAlMjAlMjAlMjAlM0MlMkZzdHlsZSUzRSUyMCUyMCUyMCUyMCUwQSUzQyUyRmhlYWQlM0UlMEElMEElM0Nib2R5JTNFJTBBJTNDZGl2JTNFJTBBJTIwJTIwJTIwJTIwJTNDaDElM0VFeGFtcGxlJTIwRG9tYWluJTNDJTJGaDElM0UlMEElMjAlMjAlMjAlMjAlM0NwJTNFVGhpcyUyMGRvbWFpbiUyMGlzJTIwZm9yJTIwdXNlJTIwaW4lMjBpbGx1c3RyYXRpdmUlMjBleGFtcGxlcyUyMGluJTIwZG9jdW1lbnRzLiUyMFlvdSUyMG1heSUyMHVzZSUyMHRoaXMlMEElMjAlMjAlMjAlMjBkb21haW4lMjBpbiUyMGxpdGVyYXR1cmUlMjB3aXRob3V0JTIwcHJpb3IlMjBjb29yZGluYXRpb24lMjBvciUyMGFza2luZyUyMGZvciUyMHBlcm1pc3Npb24uJTNDJTJGcCUzRSUwQSUyMCUyMCUyMCUyMCUzQ3AlM0UlM0NhJTIwaHJlZiUzRCUyMmh0dHBzJTNBJTJGJTJGd3d3LmlhbmEub3JnJTJGZG9tYWlucyUyRmV4YW1wbGUlMjIlM0VNb3JlJTIwaW5mb3JtYXRpb24uLi4lM0MlMkZhJTNFJTNDJTJGcCUzRSUwQSUzQyUyRmRpdiUzRSUwQSUzQyUyRmJvZHklM0UlMEElM0MlMkZodG1sJTNFJTBB"
}
}