Skip to main content
GET
/
v1
/
openclaw
/
draft-roa
/
status
/
{job_id}
Poll Draft Status
curl --request GET \
  --url https://api.abigail.app/v1/openclaw/draft-roa/status/{job_id} \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.abigail.app/v1/openclaw/draft-roa/status/{job_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.abigail.app/v1/openclaw/draft-roa/status/{job_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.abigail.app/v1/openclaw/draft-roa/status/{job_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.abigail.app/v1/openclaw/draft-roa/status/{job_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.abigail.app/v1/openclaw/draft-roa/status/{job_id}")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.abigail.app/v1/openclaw/draft-roa/status/{job_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
{
  "job_id": "roa_abc123def456",
  "status": "in_progress",
  "progress": 45,
  "current_step": "Drafting claim amendments"
}
Poll this endpoint to check the progress of an ROA drafting job.

​
Status values

StatusMeaningdownload_url present?
queuedJob is waiting for a workerNo
in_progressJob is actively generating the documentNo
completeDocument is ready for downloadYes
failedJob failed (see error_message)No

​
Polling strategy

Poll every 5 seconds. Typical drafting jobs complete in 30-120 seconds. 
import time
import httpx

def wait_for_draft(base_url, job_id, api_key, timeout=300):
    headers = {"X-API-Key": api_key}
    start = time.time()
    while time.time() - start < timeout:
        resp = httpx.get(
            f"{base_url}/v1/openclaw/draft-roa/status/{job_id}",
            headers=headers,
        )
        data = resp.json()
        if data["status"] == "complete":
            return data["download_url"]
        if data["status"] == "failed":
            raise Exception(f"Draft failed: {data.get('error_message')}")
        time.sleep(5)
    raise TimeoutError("Draft did not complete within timeout")

​
Download URL

The download_url is a signed URL that includes a JWT token. It expires after 1 hour. If it expires, re-poll this endpoint to get a fresh URL.
Polling this endpoint is free and not billed.

Authorizations

​
X-API-Key
string
header
required

API key for paid endpoints. Create in your account Settings at https://abigail.app

Headers

​
X-API-Key
string
required

Path Parameters

​
job_id
string
required

Response

200 - application/json

Job status

​
job_id
string
​
status
enum<string>
Available options:
queued,
in_progress,
complete,
failed
​
progress
integer
Required range: 0 <= x <= 100
​
current_step
string | null
​
download_url
string | null

Signed download URL. Only present when status is complete. Valid for 1 hour.