Queue a palm reading

POST /api/v3/visual-readings/palm/jobs

Queue a palm reading

cURL

curl --request POST \
  --url https://api.astrom8.com/api/v3/visual-readings/palm/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "left_upload_id": "<string>",
  "right_upload_id": "<string>",
  "capture_handedness": {
    "left_upload": "<unknown>",
    "right_upload": "<unknown>",
    "mirrored_preview": true
  },
  "sku": "json",
  "locale": "en",
  "subject_label": "<string>",
  "brand_profile_id": "<string>"
}
'

import requests

url = "https://api.astrom8.com/api/v3/visual-readings/palm/jobs"

payload = {
    "left_upload_id": "<string>",
    "right_upload_id": "<string>",
    "capture_handedness": {
        "left_upload": "<unknown>",
        "right_upload": "<unknown>",
        "mirrored_preview": True
    },
    "sku": "json",
    "locale": "en",
    "subject_label": "<string>",
    "brand_profile_id": "<string>"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    left_upload_id: '<string>',
    right_upload_id: '<string>',
    capture_handedness: {left_upload: '<unknown>', right_upload: '<unknown>', mirrored_preview: true},
    sku: 'json',
    locale: 'en',
    subject_label: '<string>',
    brand_profile_id: '<string>'
  })
};

fetch('https://api.astrom8.com/api/v3/visual-readings/palm/jobs', 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/palm/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'left_upload_id' => '<string>',
    'right_upload_id' => '<string>',
    'capture_handedness' => [
        'left_upload' => '<unknown>',
        'right_upload' => '<unknown>',
        'mirrored_preview' => true
    ],
    'sku' => 'json',
    'locale' => 'en',
    'subject_label' => '<string>',
    'brand_profile_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.astrom8.com/api/v3/visual-readings/palm/jobs"

	payload := strings.NewReader("{\n  \"left_upload_id\": \"<string>\",\n  \"right_upload_id\": \"<string>\",\n  \"capture_handedness\": {\n    \"left_upload\": \"<unknown>\",\n    \"right_upload\": \"<unknown>\",\n    \"mirrored_preview\": true\n  },\n  \"sku\": \"json\",\n  \"locale\": \"en\",\n  \"subject_label\": \"<string>\",\n  \"brand_profile_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.astrom8.com/api/v3/visual-readings/palm/jobs")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"left_upload_id\": \"<string>\",\n  \"right_upload_id\": \"<string>\",\n  \"capture_handedness\": {\n    \"left_upload\": \"<unknown>\",\n    \"right_upload\": \"<unknown>\",\n    \"mirrored_preview\": true\n  },\n  \"sku\": \"json\",\n  \"locale\": \"en\",\n  \"subject_label\": \"<string>\",\n  \"brand_profile_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"left_upload_id\": \"<string>\",\n  \"right_upload_id\": \"<string>\",\n  \"capture_handedness\": {\n    \"left_upload\": \"<unknown>\",\n    \"right_upload\": \"<unknown>\",\n    \"mirrored_preview\": true\n  },\n  \"sku\": \"json\",\n  \"locale\": \"en\",\n  \"subject_label\": \"<string>\",\n  \"brand_profile_id\": \"<string>\"\n}"

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

202

{
  "job_id": "<string>",
  "status": "<unknown>",
  "credits_charged": 123,
  "credits_remaining": 123,
  "unlimited_credits": true,
  "replayed": true,
  "poll": "<string>"
}

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

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

{
  "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.

Headers

Idempotency-Key · string · required

Required string length: 1 - 128

Body

application/json

left_upload_id · string · required

Completed left-palm upload id.

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

right_upload_id · string · required

Completed right-palm upload id.

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

dominant_hand · enum<string> · required

Available options: left, right

capture_handedness · object · required

Show child attributes

sku · enum<string> · default: json

Available options: json, branded, premium

locale · enum<string> · default: en

Available options: th, en

subject_label · string

Maximum string length: 120

brand_profile_id · string

Optional reusable brand profile.

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

Response

202

application/json

Queued or idempotently replayed job.

job_id · string · required

Visual-reading job id.

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

status · any · required

credits_charged · integer · required

credits_remaining · integer · required

unlimited_credits · boolean · required

replayed · boolean · required

poll · string · required