v1

latestOpenAPI 3.1.02026-07-24107.4 KB

Get Task Summary

get/v1/task

Query parameters

task_idstring required

Unique ID of the task.

frame_offsetinteger

Only applicable for long video/audio projects. By default we return frames starting from the first (0) frame up to frame_limit.

frame_limitinteger

Only applicable for long video/audio projects. Specifies the maximum number of frames to return. By default, we only return results for 1000 frames from the video starting at frame_offset.

Response

200

project_idinteger

task_idstring

progressstring

statestring

created_onstring

completed_onstring

upload_history_idstring

{"stackTrail":"paths:/v1/task:get:responses:200:content:application/json:schema:properties:image_url","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/task:get:responses:200:content:application/json:schema:properties:original_filename","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/task:get:responses:200:content:application/json:schema:properties:file_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/task:get:responses:200:content:application/json:schema:properties:label_data","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/task:get:responses:200:content:application/json:schema:properties:status_to_edit","oasType":"schema","type":"unknown"}

task_unitsinteger

base_customer_chargenumber

total_customer_chargenumber

{"stackTrail":"paths:/v1/task:get:responses:200:content:application/json:schema:properties:focus","oasType":"schema","type":"unknown"}

metadatastring

Example response

{
  "project_id": 18416,
  "task_id": "dd52c0d0-9ec7-11ea-98a3-4b92424b8366",
  "progress": "completed",
  "state": "finished",
  "created_on": "2020-05-28T00:21:21.543Z",
  "completed_on": "2020-05-28T00:21:22.329Z",
  "upload_history_id": "6c5be30b-24ca-463e-809a-9fd061b7bae7",
  "status": [
    {
      "status": {
        "code": "0",
        "message": "SUCCESS"
      },
      "response": {
        "input": {
          "hash": "a71690e72e5cabafc73dc2717818fc6d",
          "inference_client_version": "4.0.8",
          "model": "textmod_svs_2langs_release_test2",
          "model_type": "TEXT_CLASSIFICATION",
          "model_version": 1,
          "text": "rich test data 3",
          "id": "2846b170-a079-11ea-b023-6bfe10549ae0",
          "created_on": "2020-05-28T00:21:21.543Z",
          "user_id": 6994,
          "project_id": 18416,
          "charge": "0.00100",
          "config_version": 1,
          "config_tag": "default"
        },
        "output": [
          {
            "time": 1.98,
            "classes": [
              {
                "class": "suggestive",
                "score": 0.0010710965501463823
              }
            ],
            "end_char_index": 16
          }
        ]
      }
    }
  ],
  "task_units": 1,
  "base_customer_charge": 0.001,
  "total_customer_charge": 0.001,
  "metadata": "my metadata string"
}

All 1 operations