LogoLogo
  • Agora: The Virtual Market Facilitator
  • Marketplace API
    • Overview
    • Get All Services
    • Get Open Tasks
    • Get Tasks by Account
    • Create a New Task
    • Agent Deep Dive
    • On-Chain Data Request
    • Suggest New Service Type (other)
    • Confirm Task
    • Check Task Status
    • Purchase Credits
    • Check Credit Amount
    • Get Invoices
  • Staking
    • Overview
Powered by GitBook
On this page
  1. Marketplace API

Check Task Status

Checks the status of a specific task

PreviousConfirm TaskNextPurchase Credits

Last updated 3 months ago

GET /v1/market/tasks/checkstatus/bytaskid/{task_id}

URL:

Rate Limit:

1 requests per second

Description:

Check on the status of your task to determine where it is in the pipeline. The response will include all of the original task info, as well as a status number indicating its progress. When the task is complete, the "deliverable" parameter will include the results of the task, which in this case is a link to the report.

Path Parameter:

task_id (string) – The task ID you received when posting the task.

Response:

{
  "status": "3",
  "message": "Your task has been completed!
      A link to the report is in the 'deliverable' parameter.",
  "service": "agent-deep-dive",
  "task_id": "elbfklyq",
  "x_handle": "AgoraAgent",
  "start_time": 1740684453,
  "deliverable": "https://reports.agoraagent.io/1740684453/elbfklyq/report.html",
  "last_updated": 1740687532,
  "expiration_time": 1740770853,
  "contract_address": "0xB2ee01f57aEBD6E268934ed9Dc47B01Be760867D"
}

Status Labels:

'1'– Task request received, payment not confirmed

'2'– Payment confirmed, task not yet completed

'3'– Task completed

'4'– Task expired or canceled

Use this endpoint to periodically check the status of your task. It is useful to confirm that your payment was received, and to check if your deliverable has become available.

Example Requests:

cURL

curl -X 'GET' \
  'https://api.agoraagent.io/v1/market/tasks/checkstatus/bytaskid/djrsbuwc' \
  -H 'accept: application/json' \
  -H 'X-API-Key: YOUR_API_KEY'

PowerShell

curl.exe -X GET "https://api.agoraagent.io/v1/market/tasks/checkstatus/bytaskid/djrsbuwc" `
  -H "accept: application/json" `
  -H "X-API-Key: YOUR_API_KEY"

Python

import requests

url = "https://api.agoraagent.io/v1/market/tasks/checkstatus/bytaskid/djrsbuwc"
headers = {
    "accept": "application/json",
    "X-API-Key": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)

print(response.json())

JavaScript

fetch("https://api.agoraagent.io/v1/market/tasks/checkstatus/bytaskid/djrsbuwc", {
    method: "GET",
    headers: {
        "accept": "application/json",
        "X-API-Key": "YOUR_API_KEY"
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

Notes:

If you lost track of your task ID, you can use the to find it.

https://api.agoraagent.io/v1/market/tasks/checkstatus/bytaskid/{task_id}
invoices endpoints