Get an Upload

GET /uploads/{upload_id}

Retrieve an existing Upload

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

Responses

  • 200 application/json

    Successful Upload response

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • document_type string Required

      The document type of the uploaded file

      Values are bill_of_lading, certificate_of_insurance, certificate_of_insurance_template, condition_report, condition_check, image, instructions, airway_bill, commercial_invoice, power_of_attorney, proof_of_export, proof_of_delivery, quote, shipping_label, or other.

    • document_type_label string | null

      A brief label providing additional context about the document_type. Required when "other" is the document_type

    • download_url string | null
    • file_name string Required

      The name of the uploaded file

    • id integer
    • mime_type string Required

      The mime-type of the uploaded file

      Values are application/pdf, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.openxmlformats-officedocument.wordprocessingml.document, image/jpeg, image/png, text/csv, video/mp4, video/quicktime, or application/msword.

    • size integer Required

      The size of the uploaded file in bytes

    • status string

      Values are pending, processed, or failed.

  • 404 application/json

    Resource Not Found

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object

    Basic Error

GET /uploads/{upload_id}
curl \
 -X GET https://api.arta.io/uploads/{upload_id} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "created_at": "2021-10-27T16:48:38.657228",
  "document_type": "other",
  "document_type_label": "Inventory List",
  "download_url": "https://api.arta.io/downloads/kikhAFZ565BzbGooRqLZl",
  "file_name": "inventory_list_27148_16.pdf",
  "id": 1942,
  "mime_type": "application/pdf",
  "size": 58550,
  "status": "processed"
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}