Beta

Get AI Job

GEThttps://api.youvico.com/api/files/:id/ai-job
MCP Tool
Not Supported
Rate Limit
Default

Gets the AI job of a file created by Generate File. Only files generated with AI have an AI job.

Example

curl 'https://api.youvico.com/api/files/FXABCDEFGHIJKLMN/ai-job' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "data": {
    "id": "AXABCDEFGHIJKLMN",
    "status": "COMPLETED",
    "outputType": "VIDEO",
    "outputModel": "kling-3.0",
    "lastErrorCode": null,
    "lastErrorMessage": null,
    "configs": {
      "start": "GA1234567890ABCD",
      "durationSeconds": 10
    },
    "unusedAttachments": [],
    "createdAt": "2026-04-10 08:20:00.318204",
    "updatedAt": "2026-04-10 08:23:41.52",
    "endedAt": "2026-04-10 08:23:41.52",
    "canceledAt": null
  }
}
Request
curl -X GET 'https://api.youvico.com/api/files/FXABCDEFGHIJKLMN/ai-job' \
-H 'Authorization: Bearer YOUR_API_KEY'
Response200 OK
{
  "data": {
    "id": "AXABCDEFGHIJKLMN",
    "status": "COMPLETED",
    "outputType": "VIDEO",
    "outputModel": "kling-3.0",
    "lastErrorCode": null,
    "lastErrorMessage": null,
    "configs": {
      "start": "GA1234567890ABCD",
      "durationSeconds": 10
    },
    "unusedAttachments": [],
    "createdAt": "2026-04-10 08:20:00.318204",
    "updatedAt": "2026-04-10 08:23:41.52",
    "endedAt": "2026-04-10 08:23:41.52",
    "canceledAt": null
  }
}

Request

Path

idstringrequired
File ID

Response

Returns 200 OK.

dataobject
AI job
data.idstring
AI job ID

Example: AXABCDEFGHIJKLMN

data.statusstring
ANALYZING: planning, PROCESSING: generating, COMPLETED: completed, FAILED: failed, CANCELED: canceled

Possible values: ANALYZINGPROCESSINGCOMPLETEDFAILEDCANCELED

Example: COMPLETED

data.outputTypestring
Output type. DOCUMENT: earlier document job

Possible values: DOCUMENTPDFMARKDOWNIMAGEVIDEO3DMUSICTTSSTT

Example: VIDEO

data.outputModelstring?
Model ID

Example: kling-3.0

data.lastErrorCodestring?
Latest failure code. See Failure Codes

Example: null

data.lastErrorMessagestring?
Failure reason to show users, in the request language

Example: null

data.configsobject?
Settings fixed from the request configs
data.unusedAttachmentsarray
Reference files not used in the result. Empty until the job ends
data.createdAtstring
Creation time

Example: 2026-04-10 08:20:00.318204

data.updatedAtstring
Last update time

Example: 2026-04-10 08:23:41.52

data.endedAtstring?
End time

Example: 2026-04-10 08:23:41.52

data.canceledAtstring?
Cancellation time

Example: null

Failure Codes

CodeMeaning
SERVICE_UNAVAILABLEThe AI service is temporarily unavailable
PROVIDER_REJECTEDThe AI service rejected the request
PROVIDER_TASK_FAILEDThe AI service's generation task failed
RESULT_UNAVAILABLEGeneration finished, but the result could not be fetched or saved
CONTENT_BLOCKEDBlocked by the AI service's safety policy
COMPILER_STOPPEDThe request cannot be generated as written
OUTPUT_LIMIT_REACHEDThe document reached the output limit before it finished
INPUT_CHANGE_REQUIREDThe ADVANCED input must change to fit the model's rules
STORAGE_LIMIT_EXCEEDEDNot enough workspace storage to save the result
EXECUTION_TIMEOUTThe job ran out of time
INTERNAL_ERRORAny other server error