GET /fields/{field_id}/train/{request_id}

Retrieve a training status. This endpoint allows the status of the train request to be checked based on the field identifier (field_id) and train identifier (request_id). Each request_id for a field should be checked individually. The status process is queued, processing, complete, or failed.

Headers

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

Parameters

  • field_id Path Required

    the field identifier.

  • request_id Path Required

    the train request to query status. This is the train identifier returned from a successful POST /fields/{field_id}/train response

Code Sample
curl -X GET -H "Accept: application/json"  
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-d "{}" https://<base_url>/api/v2/fields/<field_id>/train/<request_id>
request.update()
status = request.status()
Response Codes
  • 200 OK
    The response successfully returned
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The train request does not exist or has been cleaned up.
  • 500 Internal Server Error
    Something went wrong unrelated to the users request.

Response Data

  • field_id

    the field identifier. This can be used in other endpoints

  • status

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

  • request_id

    the request identifier that can be used to retrieve the train results

Response
{
    "field_id": "2efb79d4-857d-46de-8097-f70668157dbf",
    "status": "queued",
    "request_id": "c71qfcco2ua9dqja2d70"
}

Need Help?

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

Contact us at support@zuva.ai