Get API Key Get API
Docs

Get Task Status

- Query the execution status and result of an asynchronous task

  • Real-time status updates and progress tracking
  • Retrieve generation results when tasks are completed
  • Error messages available in 10 languages (en/zh/ja/ko/ru/fr/de/id/pt/es)

Request example

curl --request GET \
  --url https://api.openveer.com/v1/tasks/task-unified-1757156493-imcg5zqt?language=en \
  --header 'Authorization: Bearer <token>'

Response example

{
  "code": 200,
  "data": {
    "id": "task_01KA040M0HP1GJWBJYZMKX1XS1",
    "status": "completed",
    "cost": 0.15,
    "credits_cost": 1.5,
    "progress": 100,
    "result": {
      "images": [
        {
          "url": [
            "https://upload.openveer.com/f/image/9998236911693428-e8d7441f-f7b4-4130-97ad-9ef8a0dde2ce-image_task_01KA0413RT2GGNZJ9GWQ4PXF2F_0.png"
          ],
          "expires_at": 1763174708
        }
      ]
    },
    "created": 1763088289,
    "completed": 1763088308,
    "estimated_time": 60,
    "actual_time": 19
  }
}

Authorizations

Authorization string

All API endpoints require Bearer Token authentication

Get your API Key:

Visit the API Key Management Page to get your API Key

Add it to the request header:

Authorization: Bearer YOUR_API_KEY

Path parameters

task_id string

Task ID returned by the generation API

Query parameters

language string

Language of error.message for failed tasks. Supported values:

  • en - English
  • zh - Simplified Chinese
  • ja - Japanese
  • ko - Korean
  • ru - Russian
  • fr - French
  • de - German
  • id - Indonesian
  • pt - Portuguese
  • es - Spanish

Values are case-insensitive, and surrounding whitespace is trimmed. Use the two-letter codes above; regional tags such as zh-CN, en-US, and pt-BR are not recognized.

This parameter only affects error.message. If omitted or set to an unsupported value, the original error message is returned.

Response

id string

Unique task identifier

status string

Task status values:

  • pending - Queued for processing
  • processing - In progress
  • completed - Finished successfully
  • failed - Failed
  • cancelled - Cancelled by user
cost number

Cost charged for this task

credits_cost number

Credits charged for this task

progress integer

Task progress percentage (0–100)

result object
Task result, returned only when status is completed
images array

Array of generated image objects (for image generation tasks)

videos array

Array of generated video objects (for video generation tasks)

created integer

Task creation timestamp

completed integer

Task completion timestamp (only present when completed)

estimated_time integer

Estimated completion time in seconds

actual_time integer

Actual completion time in seconds (only present when completed)

error object
Error details (only present when status is failed)
code integer

Error code

message string

Error message

type string

Error type

This documentation is built and hosted on Mintlify, a developer documentation platform.