Open Dashboard

This feature is only available in the Enterprise version

AI integrations

Get job status

Poll progress, subtasks, and approval state for an agent job.

GET/agents/jobs/{job_id}/status

Use this endpoint while an agent job is in progress. The response is a compact snapshot: status, progress counts, the current or failed step, and summarized subtasks.

For the final output after the job completes or fails, use Get job result. To pause, resume, approve, reject, or schedule, use Control agent job.

Enterprise authentication

Send these requests to https://api.cloud.blnkfinance.com on Blnk Cloud. On a self-hosted Enterprise deployment, send them to ENTERPRISE_PUBLIC_URL.

Pass an Enterprise API key, or an OAuth access token, in the X-blnk-key header. Create the key in Enterprise API keys, or issue a token with Enterprise OAuth.

This credential comes from the Cloud or Enterprise workspace. A Core API key belongs to the Core instance.

X-blnk-keystringrequiredheader

Enterprise API key, or an OAuth access token.

Path

job_idstringrequiredpath

Job to poll (job_...). Use the job_id returned by Create agent job.

viewstringquery

Set to debug or verbose to add a debug object with the raw plan steps and reasoning trail. Leave unset for the compact payload.

verbosestringquery

Alias for view=debug. Send 1 or true. Prefer view.

instance_idstringquery

Optional Core instance (instance_...). When present, Cloud checks that the instance belongs to your organization. The job already stores its instance from create.

Response

job_idstring

Job you polled (job_...). Same value you sent in the path.

statusstring

Where the job is right now: queued, scheduled, planning, running, paused, waiting_approval, completed, or failed. Poll until completed or failed, then call Get job result.

status_messagestring

Short sentence that matches status, for example Workflow executing. Use this for logs or UI copy. Do not parse it.

plan_run_idstring

Plan Cloud built from your message (pr_...). Empty until planning finishes. Status, result, and control still use job_id.

approval_statestring

Set when the job is in waiting_approval. Empty otherwise. Use Control agent job with approve or reject to continue.

last_errorstring

Most recent error on the job. Empty while the job is healthy. Filled when a step or the planner fails.

scheduleobject

Present when this job is waiting for a one-time run or is tied to a recurring template. null for a normal create.

progressobject

How many plan steps are in each state: total, completed, running, pending, failed, waiting_approval. Use this for a progress bar. running also counts steps in created_task.

current_stepobject

The step Cloud is on now: first running, created_task, or waiting_approval step, otherwise the next pending step. null when no step is active. Same shape as one item in sub_tasks.

failed_stepobject

First step with status failed. null when every step has succeeded or has not failed yet. Same shape as one item in sub_tasks.

sub_tasksarray

Compact plan steps, oldest first. This is the summarized view. Use view=debug if you need the raw plan payload.

reasoning_trailarray

Compact planner and execution notes. Each item has id, kind, title, status, and summary. Empty until the planner writes notes.

created_attimestamp

When Cloud accepted the job, in UTC ISO 8601.

updated_attimestamp

When the job last changed, in UTC ISO 8601. Use this to see if a poll returned new work.

linksobject

Relative paths for status, result, and control on this job. Prefix them with https://api.cloud.blnkfinance.com.

debugobject

Raw sub_tasks and reasoning_trail. Present only when you send view=debug (or verbose=1). Omit it in production clients.