Updated on Sep 14, 2023
1
min read
API (/doc_status)
GET
Updated on Sep 14, 2023
1
min read
API (/doc_status)
GET
Updated on Sep 14, 2023
1
min read
API (/doc_status)
GET
GET /doc_status
Returns the processing status of a given doc.
URL:
GET https://api.vesana.dev/v1/doc_status
Headers:
x-Vesana-API-key: YOUR_API_KEY
Query Parameters:
document_id (str)
Response:
{ "status": "success", "doc_status": "enum" }
doc_status: [ "processing", "ready", "error" ]
Please contact our team if your doc_status is in error
Example:
GET /v1/doc_status?document_id=12345 HTTP/1.1 Host: api.yourdomain.com x-Vesana-API-key: YOUR_API_KEY
Response:
{ "status": "success", "doc_status": "ready" }
See https://vesana.dev/docs/auth-error for error details in case of "status": "error"
GET /doc_status
Returns the processing status of a given doc.
URL:
GET https://api.vesana.dev/v1/doc_status
Headers:
x-Vesana-API-key: YOUR_API_KEY
Query Parameters:
document_id (str)
Response:
{ "status": "success", "doc_status": "enum" }
doc_status: [ "processing", "ready", "error" ]
Please contact our team if your doc_status is in error
Example:
GET /v1/doc_status?document_id=12345 HTTP/1.1 Host: api.yourdomain.com x-Vesana-API-key: YOUR_API_KEY
Response:
{ "status": "success", "doc_status": "ready" }
See https://vesana.dev/docs/auth-error for error details in case of "status": "error"
GET /doc_status
Returns the processing status of a given doc.
URL:
GET https://api.vesana.dev/v1/doc_status
Headers:
x-Vesana-API-key: YOUR_API_KEY
Query Parameters:
document_id (str)
Response:
{ "status": "success", "doc_status": "enum" }
doc_status: [ "processing", "ready", "error" ]
Please contact our team if your doc_status is in error
Example:
GET /v1/doc_status?document_id=12345 HTTP/1.1 Host: api.yourdomain.com x-Vesana-API-key: YOUR_API_KEY
Response:
{ "status": "success", "doc_status": "ready" }
See https://vesana.dev/docs/auth-error for error details in case of "status": "error"