Documentation
  • How Our System works
  • Text to Image
    • Dalle-3
    • SDXL Models
  • Image Editing
    • Replace Background
    • Inpainting and CleanUp
    • Upscaling
  • Image to Image
    • SDXL Models
    • Face Consistent
    • ControlNet
    • Illusion Diffusion
    • Image Variation
  • ChatBot
  • Knowledge Bases in Chatbot
  • Text To Speech
  • History Section
  • Qreative wall
  • How to Cancel Your Subscription
  • Extra Resources
    • Prompt Advancement
    • Private Session
    • Image Editing Options
    • Resolution
    • Generation Settings
  • API Platform
    • Text to Image
    • Image to Image
    • ControlNet
    • Inpainting
    • Replace Background
    • Face Consistency
    • Face Avatar
    • Image Variation
    • Illusion Diffusion
    • Upscaling
    • Background Removal
    • Text to Speech
    • Task Status
    • ChatBot API
Powered by GitBook
On this page
  • Task Status API
  • Run the API

Was this helpful?

  1. API Platform

Task Status

Use this API endpoint to check the progress of a scheduled task through Celery. All you need is the task_id, which you receive when you schedule the task. This allows you to monitor the status and progress of your long-running tasks.

Task Status API

POST /getImage

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

id

string

-> The id parameter is used to provide the unique identifier of the scheduled task you want to check the status for.

refID

string

-> The reference_id parameter is an optional field that allows you to provide a reference ID to identify the request, if required. If you did not specify a reference_id when passing the input parameters, there is no need to provide this parameter.

Response

{
  "time_required": "",
  "error": "",
  "error_data": "",
  "input": "",
  "output": "",
  "app_id": "",
  "task_id": "",
  "status": ""
}
{
  "time_required": "",
  "error": "",
  "error_data": "",
  "input": "",
  "output": "",
  "app_id": "",
  "task_id": "",
  "status": ""
}

Run the API

To test this API, please use the following link:

PreviousText to SpeechNextChatBot API

Last updated 1 year ago

Was this helpful?

https://app.theneo.io/api-runner/qolaba/ml-apis/api-reference/get-status
Logo