GET Images

This API is used to obtain all the images which are ready after processing by Spyne

GEThttps://api.spyne.ai/api/pv1/sku/get-ready-images/v2/
AuthBearer token

Prefer ReadMe's own explorer? Open it here.

Query parameters

ParameterTypeRequiredDescription
auth_keystringOptionalThe authentication key of the user
sku_idstringOptionalThe ID of the sku to be fetched Default: b5479027.

Sample request

curl --request GET \
  --url 'https://api.spyne.ai/api/pv1/sku/get-ready-images/v2/' \
  --header 'Authorization: Bearer YOUR_API_KEY'
import requests

url = "https://api.spyne.ai/api/pv1/sku/get-ready-images/v2/"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(url, headers=headers)
print(response.status_code, response.json())
const response = await fetch("https://api.spyne.ai/api/pv1/sku/get-ready-images/v2/", {
  method: "GET",
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
  },
});
console.log(response.status, await response.json());

Sample response

{
  "project_id": "86c02457ba5247aa8d33fcd467c2a17a",
  "sku_status": "Done",
  "sku_id": "6684b0237719475cafac526997bc8956",
  "sku_meta_data": {},
  "sku_name": "saka___257___TEST___outside05___7f5cf96e",
  "user_id": "BcR2jzEC",
  "total_frame_count": 1,
  "image_data": [
    {
      "image_id": "img-0a751dbf-8bf9-439f-b593-f4d193c930be",
      "image_name": "f523093e-5250-479d-913f-a25a06b490d0",
      "image_category": "",
      "frame_no": "1",
      "lowres_output": "null",
      "background_id": "24",
      "status": "failed",
      "image_meta_data": {},
      "is_reshoot": 0,
      "reject_reason": "Blank_BG",
      "input_image": "https://files.autokuva.com/backup/spyne/saka___257___TEST___outside05___7f5cf96e.jpg",
      "output_image": "null"
    }
  ],
  "signature": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9qZWN0X2lkIjoiODZjMDI0NTdiYTUyNDdhYThkMzNmY2Q0NjdjMmExN2EiLCJza3VfaWQiOiI2Njg0YjAyMzc3MTk0NzVjYWZhYzUyNjk5N2JjODk1NiIsImlhdCI6MTczMDcyMzk0MSwiZXhwIjoxNzYxNDgyMzQxfQ.jw1B68gYsDA9a-kPKpGmeeTsVQLIoiSaqdo9T5wNdI0",
  "VIN": "saka___257___TEST___outside05___7f5cf96e"
}
{
  "message": "Data Not found"
}
{
  "status": "401",
  "message": "Invalid Auth key"
}

Response parameters (200)

FieldTypeDescription
project_idstringExample: 86c02457ba5247aa8d33fcd467c2a17a.
sku_statusstringExample: Done.
sku_idstringExample: 6684b0237719475cafac526997bc8956.
sku_meta_dataobject
sku_namestringExample: saka___257___TEST___outside05___7f5cf96e.
user_idstringExample: BcR2jzEC.
total_frame_countintegerDefault: 0. Example: 1.
image_dataobject[]
image_data[].image_idstringExample: img-0a751dbf-8bf9-439f-b593-f4d193c930be.
image_data[].image_namestringExample: f523093e-5250-479d-913f-a25a06b490d0.
image_data[].image_categorystringExample: ``.
image_data[].frame_nostringExample: 1.
image_data[].lowres_outputstringExample: null.
image_data[].background_idstringExample: 24.
image_data[].statusstringExample: failed.
image_data[].image_meta_dataobject
image_data[].is_reshootintegerDefault: 0. Example: 0.
image_data[].reject_reasonstringExample: Blank_BG.
image_data[].input_imagestringExample: https://files.autokuva.com/backup/spyne/saka___257___TEST___outside05___7f5cf96e.jpg.
image_data[].output_imagestringExample: null.
signaturestringExample: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9qZWN0X2lkIjoiODZjMDI0NTdiYTUyNDdhYThkMzNmY2Q0NjdjMmExN2EiLCJza3VfaWQiOiI2Njg0YjAyMzc3MTk0NzVjYWZhYzUyNjk5N2JjODk1NiIsImlhdCI6MTczMDcyMzk0MSwiZXhwIjoxNzYxNDgyMzQxfQ.jw1B68gYsDA9a-kPKpGmeeTsVQLIoiSaqdo9T5wNdI0.
VINstringExample: saka___257___TEST___outside05___7f5cf96e.

Errors

StatusMeaningWhen it happens
400Bad Request400
401Unauthorized401

Did this page help you?