Get Job Status

Poll the status of an asynchronous workflow execution. Use the jobId returned from the Execute Workflow endpoint when the execution is queued asynchronously.

GET/api/jobs/{jobId}

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Path Parameters

jobId*string

The job identifier returned in the async execution response.

Response Body

application/json

application/json

application/json

application/json

curl -X GET \  "https://www.sim.ai/api/jobs/{jobId}" \  -H "X-API-Key: YOUR_API_KEY"
{
  "success": true,
  "taskId": "job_4a3b2c1d0e",
  "status": "completed",
  "metadata": {
    "startedAt": "2025-06-20T14:15:22Z",
    "completedAt": "2025-06-20T14:15:23Z",
    "duration": 1250
  },
  "output": {
    "result": "Hello, world!"
  },
  "error": null,
  "estimatedDuration": 2000
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}