GET /insightFace/v1/fetch

Query face swap task results. The returned data structure is consistent with the <a href="fetch" target="_self">hookUrl</a> return format.<br/>Note: jobId can be passed via URL parameters (Query) or request body (Body)

Request

Base URL
https://api.ttapi.io
Auth
API key in header TT-API-KEY
TypeScript
https://skmtc.dev/ttapi/apis/flowmusic-api-docs/docs/insightFace/v1/fetch/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

jobIdstring required

Job ID returned synchronously by the generation endpoint

Response

Request successful

status'SUCCESS' | 'ON_QUEUE' | 'FAILED' required

Task status: ON_QUEUE-processing, SUCCESS-success, FAILED-failed

messagestring required

Response message: empty string on success, returns specific error reason on failure (e.g., 'insufficient quota', 'prompt violation')

jobIdstring required

Unique task identifier for querying task status or receiving callback notifications

Example response

{
  "status": "SUCCESS",
  "jobId": "c679a92e-dae0-462d-b70f-dcfeaf2189fa",
  "data": {
    "quota": "3",
    "hookUrl": "https://webhook-test.com/bf74f63b0d51ba1b3090e295aae057fe",
    "finishTime": "2025-07-30T05:40:01Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.