NInimbleway
Tasks

Get task details

Changed on

Retrieve the details of a specific task by its ID.

get/v1/tasks/{task_id}

Request

  • Base URL
    https://sdk.nimbleway.com
  • URL
    https://sdk.nimbleway.com/v1/tasks/{task_id}
  • Auth
    HTTP bearer

Path parameters

task_idstring required

The unique identifier of the task.

Example:123e4567-e89b-12d3-a456-426614174000

Response

Task found and returned successfully.

Example response

{
  "task": {
    "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
    "created_at": "2024-01-15T10:30:00Z",
    "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
    "error": "Connection timeout",
    "error_type": "timeout_error",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "modified_at": "2024-01-15T10:35:00Z",
    "state": "pending",
    "status_code": 200,
    "status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

  • e8a97dc9fce2Revision changes
    • breaking

      response property task/batch_id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property task/download_url list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property task/error list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property task/error_type list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property task/output_url list-of-types was widened by adding types null to media type application/json of response 200

  • ebe52c375b71Revision changes
    • warning

      added the new in_progress enum value to the / response property for the response status

    • warning

      added the new labs enum value to the / response property for the response status

    • warning

      added the new queued enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status