GET /language/{request_id}

Retrieves the results of a document language type request after processing has completed. The result is a string which represents the language result respectively.

Headers

Authorization (required) - Requires the standard authentication header used in the system.

Parameters

  • request_id Path Required

    the language request to return result for. This is the language type identifier returned from a successful POST /language response (request_id)

Code Sample 
curl -X GET -H "Accept: application/json"  
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"  
-d "{}" 
https://<base_url>/api/v2/language/<request_id>
language, _ = zdai.language.get(request_id = 'request_id')
Response Codes
  • 200 OK
    The response successfully returned
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The language request does not exist, has been cleaned up, or not finished.
  • 500 Internal Server Error
    Something went wrong unrelated to the users request or the Language type failed and there is an error message.

Response Data

  • request_id

    the request identification for the language classification

  • file_id

    document for the language type

  • status

    the status of the request. Could be queued, processing, or complete

  • language

    the language that has been classified for the document

  • error

    if an error occurs, you may get a standard error response

Response 
{
    "file_id": "<file_id>",
    "status": "complete",
    "request_id": "<request_id>",
    "language": "English"
}

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact Support