GET
/
api
/
v1
/
jobs
/
detail
Get Job Detail
curl --request GET \
  --url https://api.goenhance.ai/api/v1/jobs/detail \
  --header 'Authorization: Bearer <token>'
{
  "code": 0,
  "msg": "Success",
  "data": {
    "img_uuid": "5334c57d-8443-4b79-ba24-8539c2163c74",
    "status": "pending",
    "type": "mx-v2v",
    "start_time": "2024-07-12T12:49:12.541Z",
    "model_id": "7",
    "json": null,
    "job_type": "mx-v2v"
  }
}

​
Overview

The Get Job Status API allows you to check the current status of any asynchronous job in the GoEnhance platform. This is a universal endpoint that works with all job types, including video generation, image processing, and other time-consuming operations.

​
How It Works

When you initiate an asynchronous operation through any of our APIs, you receive a job identifier (img_uuid). You can use this identifier with the Get Job Status API to track the progress of your job until it completes.

​
Job Status Values

The API returns a status field with one of the following values:
  • pending: Job is queued and waiting to be processed
  • processing: Job is currently being processed
  • completed: Job has finished successfully
  • failed: Job has failed with an error

​
Usage Example

This endpoint is typically used in a polling pattern:
  1. Submit an asynchronous job request
  2. Receive an img_uuid in the response
  3. Periodically call the Get Job Status API with that img_uuid
  4. When status is “completed”, retrieve your results

​
Example Response

{
  "code": 0,
  "msg": "Success",
  "data": {
    "img_uuid": "37c82d82-8765-4031-8cb3-722df8a668e6",
    "status": "success",
    "type": "mx-image-face-swap",
    "start_time": "2024-10-11T10:55:32.596Z",
    "end_time": "2024-10-11T10:56:00.338Z",
    "model_id": "-1",
    "json": [
      {
        "type": "image",
        "value": "https://openapi-static.goenhance.ai/user/2024/10/11/9dfdb4b5-7ef7-4fe7-93ff-b9eb76cc431d_0.jpg?q-sign-algorithm=sha1&q-ak=AKIDqUvFPSM9vvmdNzSn01oeUAdxw1y1zkS2&q-sign-time=1728644159;1728687359&q-key-time=1728644159;1728687359&q-header-list=host&q-url-param-list=&q-signature=cd1e9c6ef14d36c1e034d6bd3a3fe1aaee41b15f"
      }
    ],
    "job_type": "mx-image-face-swap"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
img_uuid
string

Response

200
application/json

The response is of type object.