Poll or delete a visual-reading job

GET /api/v3/visual-readings/jobs/{jobId}

Poll or delete a visual-reading job

cURL

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

import requests

url = "https://api.astrom8.com/api/v3/visual-readings/jobs/{jobId}"

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/visual-readings/jobs/{jobId}', 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/visual-readings/jobs/{jobId}",
  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/visual-readings/jobs/{jobId}"

	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/visual-readings/jobs/{jobId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.astrom8.com/api/v3/visual-readings/jobs/{jobId}")

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>",
    "credits": 123,
    "credits_refunded": 123,
    "error_code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z"
  },
  "artifacts": {
    "json": {
      "status": "<string>",
      "url": "<string>",
      "valid_for_seconds": 123
    },
    "hosted": {
      "status": "<string>",
      "url": "<string>",
      "valid_for_seconds": 123
    },
    "pdf": {
      "status": "<string>",
      "url": "<string>",
      "valid_for_seconds": 123
    }
  }
}

{
  "error": "<string>",
  "message": "<string>",
  "code": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

jobId · string · required

Visual-reading job id.

Pattern: ^vrj_[a-f0-9]{24}$

Response

200

application/json

Job status and signed JSON, hosted HTML, or PDF artifacts where purchased and ready.

job · object · required

Show child attributes

artifacts · object · required

Show child attributes