Sign in

v1

latestOpenAPI 3.0.02026-07-263014.2 KB

Get Image Details

Query the status and results of an image generation or editing task.

Status Descriptions

  • 0: GENERATING - Task is currently being processed
  • 1: SUCCESS - Task completed successfully
  • 2: CREATE_TASK_FAILED - Failed to create the task
  • 3: GENERATE_FAILED - Task creation succeeded but generation failed

Important Notes

  • Generated images (resultImageUrl) will expire after 14 days
get/api/v1/flux/kontext/record-info

Query parameters

taskIdstring required

Unique identifier of the image generation task

Response

Request successful

code200 | 401 | 404 | 422 | 429 | 455 | 500 | 501

Response status code

  • 200: Success - Request has been processed successfully
  • 401: Unauthorized - Authentication credentials are missing or invalid
  • 404: Not Found - The requested resource or endpoint does not exist
  • 422: Validation Error - The request parameters failed validation checks
  • 429: Rate Limited - Request limit has been exceeded for this resource
  • 455: Service Unavailable - System is currently undergoing maintenance
  • 500: Server Error - An unexpected error occurred while processing the request
  • 501: Generation Failed - Image generation task failed
msgstring

Error message when code != 200

Example response

{
  "msg": "success",
  "data": {
    "taskId": "task12345",
    "paramJson": "{\"prompt\":\"A serene mountain landscape\",\"aspectRatio\":\"16:9\"}",
    "completeTime": "2024-03-20T10:30:00Z",
    "response": {
      "originImageUrl": "https://example.com/original.jpg",
      "resultImageUrl": "https://example.com/result.jpg"
    },
    "successFlag": 1,
    "createTime": "2024-03-20T10:25:00Z"
  }
}