Poll an async report job

GET /api/v3/jobs/{id}

Poll an async report job

cURL

curl --request GET \
  --url https://api.astrom8.com/api/v3/jobs/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.astrom8.com/api/v3/jobs/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.astrom8.com/api/v3/jobs/{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.astrom8.com/api/v3/jobs/{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 => [
    "Authorization: Bearer <token>"
  ],
]);

$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.astrom8.com/api/v3/jobs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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.astrom8.com/api/v3/jobs/{id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astrom8.com/api/v3/jobs/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "job_id": "<string>",
  "report_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "result": {
    "url": "<string>",
    "expires_at": "<string>"
  },
  "error": "<string>",
  "credits_refunded": 123
}

Authorizations

Authorization · string · header · required

Use the raw API key as the Bearer token, or send X-API-Key instead.

Path Parameters

id · string · required

Job id returned by the enqueue response.

Response

200

application/json

Job status. result is present when status=succeeded; error and credits_refunded when status=failed.

job_id · string · required

report_type · string · required

Example:

"natal_pdf"

status · enum<string> · required

Available options: queued, running, succeeded, failed

created_at · string<date-time>

result · object

Show child attributes

error · string

Safe, user-facing failure message (status=failed). Internal error details are never exposed here.

credits_refunded · integer

error_code · enum<string>

Stable machine-readable failure class (status=failed).

Available options: generation_interrupted, invalid_job_payload, unknown_report_type, llm_unavailable, pdf_failed, job_failed