Skip to main content
GET
/
v1
/
tasks
/
{task_id}
Query Task Status
curl --request GET \
  --url https://api.foxapi.cc/v1/tasks/{task_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "task-unified-1757165031-uyujaw3d",
  "object": "video.generation.task",
  "type": "video",
  "model": "lipsync-2",
  "status": "pending",
  "progress": 0,
  "created": 1757165031,
  "results": null,
  "error": null,
  "usage": {
    "credits_reserved": 5,
    "user_group": "default"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.foxapi.cc/llms.txt

Use this file to discover all available pages before exploring further.

​
results Field Format

After a task completes (status=completed), results is an array whose structure varies by model. Before parsing results, check the model field in the response to determine the structure type.

​
Common Format (Most Models)

Grouped by task output type (type):
typeresults[i] StructureTypical Use Cases
image{url}Image generation, editing, enhancement
video{url}Video generation, lip-sync, video editing
audio (TTS / Music){url}Text-to-speech, music generation
llmFull OpenAI ChatCompletion: {id, object:"chat.completion", created, model, choices[].message, usage}LLM generation (llm_router / llm_async)
All url links are valid for 24 hours. Please save them promptly.

​
Special Formats (By model)

The results[i] structure for the following models does not follow the common format above. Callers must handle them separately based on model.

​
Profile Creation (No Media URL Returned)

modeltyperesults[i] StructureNotes
kling-video-create-voicevideo{voice_id}Creates a reusable voice profile ID for subsequent Kling lip-sync / synthesis tasks
minimax-voice-cloneaudio{voice_id}MiniMax voice cloning: submit a reference audio to generate a reusable voice ID for subsequent MiniMax TTS tasks
sora-2-charactervideo{character_id, name}Extracts a character profile from a reference video for character consistency in subsequent Sora 2 tasks
phota-create-profileimage{result_type, profile_id}Trains a person profile for use by other PHOTA models; result_type is always profile

​
Speech Transcription (No Media URL Returned)

modeltyperesults[i] StructureNotes
scribe-v2audio{text, language_code, language_probability, words[]}Speech-to-text. words[] is a word-level timestamp array; each entry contains text / start / end / type

​
Video with Seed Value

modeltyperesults[i] StructureNotes
seedance-2.0-text-to-videovideo{url, seed}Additionally returns the generation seed for reproducibility
seedance-2.0-fast-text-to-videovideo{url, seed}Same as above
seedance-2.0-image-to-videovideo{url, seed}Same as above
seedance-2.0-fast-image-to-videovideo{url, seed}Same as above
seedance-2.0-reference-to-videovideo{url, seed}Same as above
seedance-2.0-fast-reference-to-videovideo{url, seed}Same as above

​
PBR Material (Single Task Returns Multiple Semantically Labeled Results)

modeltyperesults[i] StructureNotes
patina-pbr-mapsimage{url, content_type, result_type: "pbr_map", map_type}PBR map generation. map_type identifies the map type (e.g. albedo / normal / roughness, etc.)
patina-materialimageMixed: {url, content_type, result_type: "texture"} and {url, content_type, result_type: "pbr_map", map_type}Outputs both tiling textures and multiple PBR maps; distinguish by result_type
patina-material-extractimageSame as patina-materialExtracts textures from an existing image to generate a PBR map set

​
Parsing Recommendations

  • Read model first, then parse results: Different models under the same type may have completely different structures
  • Mind the expiration for URL results: All url links are valid for 24 hours; your application should download and store them immediately upon receipt
  • Profile-type tasks return voice_id / character_id / profile_id as long-lived resource identifiers that can be used directly in subsequent task parameters

Authorizations

​
Authorization
string
header
required

All endpoints require Bearer Token authentication

Add the following to your request headers:

Authorization: Bearer YOUR_API_KEY

Path Parameters

​
task_id
string
required

Task ID, returned by the task submission endpoint

Example:

"task-unified-1757165031-uyujaw3d"

Query Parameters

​
sync_upstream
boolean
default:false

Whether to proactively refresh the task status before returning. Only takes effect for tasks that are still in progress and have an associated remote task; otherwise, the current task status is returned directly.

Example:

true

Response

Query successful

​
id
string

Task ID

Example:

"task-unified-1757165031-uyujaw3d"

​
object
enum<string>

Specific task type

Available options:
video.generation.task,
image.generation.task,
audio.generation.task,
llm.generation.task
Example:

"video.generation.task"

​
type
enum<string>

Task output type

Available options:
video,
image,
audio,
llm
Example:

"video"

​
model
string

Actual model name used

Example:

"lipsync-2"

​
status
enum<string>

Task status

Options:

ValueMeaning
pendingPending
processingProcessing
completedCompleted
failedFailed
Available options:
pending,
processing,
completed,
failed
Example:

"pending"

​
progress
integer

Task progress percentage

Required range: 0 <= x <= 100
Example:

0

​
created
integer

Task creation timestamp (Unix seconds)

Example:

1757165031

​
results
object[] | null

Task result list; only populated when status=completed.

Structure varies by task output type (type):

typeresults[i] structureTypical scenarios
image{url}, some models include content_type; special tasks (e.g. PHOTA profile creation) return {result_type, profile_id}Image generation, editing, enhancement
video{url}, some models include content_type / seed; special subtasks (Kling voice creation / Sora 2 character profile) return {voice_id} or {character_id, name}Video generation, lip-sync
audio (TTS / Music){url}Text-to-speech, music generation
audio (STT / Transcription){text, language_code, language_probability, words[]} (no url)Speech transcription (e.g. Scribe V2)
llmFull OpenAI ChatCompletion: {id, object:"chat.completion", created, model, choices[].message, usage}LLM generation (llm_gateway / llm_async)

General notes:

  • Result URLs are valid for 24 hours; please save them promptly
  • type=llm results are conversation responses and do not produce URLs
  • Some tasks produce non-media artifacts (voice profile / character profile creation, etc.); results contains id-type fields instead of url

Image result (type=image). Most image models only return url; some models (Patina family) also include content_type; PHOTA profile creation tasks return {result_type, profile_id} (non-image artifact)

​
error
object

Error information; only populated when status=failed

​
usage
object

Billing information