Read background document-analysis status

GET

/uploads/{uploadId}/status

const url = 'https://api.invogi.com/v1/uploads/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.invogi.com/v1/uploads/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

uploadId

required

string format: uuid

Responses

200

Upload processing status

application/json

object

upload_id

required

string format: uuid

status

required

string

Allowed values: UPLOADED QUEUED FAILED COMPLETE

invoice_id

string | null format: uuid

error

string | null

Example

{
  "status": "UPLOADED"
}

401

Missing or invalid API key

application/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Resource not found

application/json

object

error

required

object

code

required

string

Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "NOT_FOUND"
  }
}