curl --request GET \
--url https://api.parse.bot/dispatch/tasks/{task_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.parse.bot/dispatch/tasks/{task_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.parse.bot/dispatch/tasks/{task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parse.bot/dispatch/tasks/{task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.parse.bot/dispatch/tasks/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.parse.bot/dispatch/tasks/{task_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parse.bot/dispatch/tasks/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"task": "<string>",
"status": "queued",
"iteration": 123,
"user_input_prompt": {},
"result_scraper_id": "<string>",
"result_marketplace_id": "<string>",
"error": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"completed_at": "<string>",
"parent_task_id": "<string>",
"extends_scraper_id": "<string>",
"revision_type": "<string>",
"auth_enabled": false,
"source": "built",
"contributes_to_marketplace": true,
"progress": {},
"marketplace_apis": {},
"existing_marketplace_apis": {},
"generated_api": {
"marketplace_id": "<string>",
"scraper_id": "<string>",
"name": "<string>",
"description": "<string>",
"source_url": "<string>",
"execution_base_url": "<string>",
"endpoints": [
{
"method": "<string>",
"endpoint_name": "<string>",
"description": "<string>",
"input_params": {},
"return_schema": {},
"initiates_session": true
}
]
}
}Get task detail
Get full details for a dispatch task, including the generated API spec with endpoint definitions and execution URLs when completed.
curl --request GET \
--url https://api.parse.bot/dispatch/tasks/{task_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.parse.bot/dispatch/tasks/{task_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.parse.bot/dispatch/tasks/{task_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.parse.bot/dispatch/tasks/{task_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.parse.bot/dispatch/tasks/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.parse.bot/dispatch/tasks/{task_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parse.bot/dispatch/tasks/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"url": "<string>",
"task": "<string>",
"status": "queued",
"iteration": 123,
"user_input_prompt": {},
"result_scraper_id": "<string>",
"result_marketplace_id": "<string>",
"error": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"completed_at": "<string>",
"parent_task_id": "<string>",
"extends_scraper_id": "<string>",
"revision_type": "<string>",
"auth_enabled": false,
"source": "built",
"contributes_to_marketplace": true,
"progress": {},
"marketplace_apis": {},
"existing_marketplace_apis": {},
"generated_api": {
"marketplace_id": "<string>",
"scraper_id": "<string>",
"name": "<string>",
"description": "<string>",
"source_url": "<string>",
"execution_base_url": "<string>",
"endpoints": [
{
"method": "<string>",
"endpoint_name": "<string>",
"description": "<string>",
"input_params": {},
"return_schema": {},
"initiates_session": true
}
]
}
}Authorizations
API key for programmatic access. Create one in the Parse dashboard at https://parse.bot (Settings → API Keys). Keys start with 'pmx_'.
Path Parameters
Response
Task detail
Task lifecycle state. Poll until it reaches a terminal state: completed, failed, or cancelled.
queued, running, needs_input, completed, failed, cancelled Present when status is 'needs_input' — the question(s) the agent needs answered. Respond via POST /dispatch/{task_id}.
Set on completion — the scraper_id used to execute endpoints.
Set when status is 'failed'.
True if this API was built against a site that requires login.
How the user acquired this API.
built, subscribed, forked Live build progress while status is 'running' (stage, headline, per-endpoint status, log).
Show child attributes
Show child attributes
Was this page helpful?