Fly a bird with optional proxy and bird-options
A bird (automation) can run for 250 seconds continuously. If you want to run a bird for more than 250 seconds, you might want to split them into multiple birds.
curl --location --request POST 'https://runner.browserbird.xyz/fly/bird' \
--header 'Authorization: Apikey xxx-apikey-xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"birdId": "xxxxxx",
"variables": {
"var1": "var1-value"
},
"proxy": "user:[email protected]:port"
}'
var myHeaders = new Headers();
myHeaders.append("Authorization", "Apikey xxx-apikey-xxx");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({
"birdId": "xxxxxx",
"variables": {
"var1": "var1-value"
},
"proxy": "user:[email protected]:port"
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://runner.browserbird.xyz/fly/bird", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
Headers
Headers of the request.
Header | Value | Description |
---|---|---|
Authorization | Apikey {{api_key_from_the_dashboard}} | Get the Apikey from the dashboard |
Body
Body parameters of the request.
Parameter | Required | Type | Description |
---|---|---|---|
birdId | true | string | ID of the bird to fly. You can copy it from the app -> birds section. |
variables | false | object | Variables of a bird. |
proxy | false | string | Proxy to use while flying a Bird. This has to be in the following format. (this will override any proxy setting of a bird) |
Success Response
{
"status": "ok",
"message": "Bird fly completed",
"data": {
"results": {
"result1": "result_value1",
"result2": "result_value2"
},
"credits_used": 4, // number of credits used
"bird_data": {
"id": "xxxxxx",
"name": "My test Bird"
}
}
}
Error Response
{
"status": "error",
"code": "BIRD__BIRD_CRASHED",
"message": "Reason for the crash",
"error": {}
}
Bird Concurrent Executions
Each plan has a limit on how many birds can fly concurrently. However, you can fly a bird once at a time in the free plan.
Logs
Logs for each bird fly can be seen in the dashboard under each bird