AI integrations
Get job status
Poll progress, subtasks, and approval state for an agent job.
GET
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.
Add
?view=debug (or view=verbose, verbose=1) to include a debug object with the raw plan steps and reasoning trail.Authorization
Blnk Cloud APIs support any one of the following authentication methods. All of them work with yourCLOUD_API_KEY or OAUTH_ACCESS_TOKEN.
- Bearer token
- X-Blnk-Key header
- X-API-Key header
Path
string
required
Job to poll (
job_...). Use the job_id returned by Create agent job.string
Set to
debug or verbose to add a debug object with the raw plan steps and reasoning trail. Leave unset for the compact payload.string
Alias for
view=debug. Send 1 or true. Prefer view.string
Optional Core instance (
instance_...). When present, Cloud checks that the instance belongs to your organization. The job already stores its instance from create.Response
string
Job you polled (
job_...). Same value you sent in the path.string
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.string
Short sentence that matches
status, for example Workflow executing. Use this for logs or UI copy. Do not parse it.string
Plan Cloud built from your message (
pr_...). Empty until planning finishes. Status, result, and control still use job_id.string
Set when the job is in
waiting_approval. Empty otherwise. Use Control agent job with approve or reject to continue.string
Most recent error on the job. Empty while the job is healthy. Filled when a step or the planner fails.
object
Present when this job is waiting for a one-time run or is tied to a recurring template.
null for a normal create.object
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.object
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.object
First step with status
failed. null when every step has succeeded or has not failed yet. Same shape as one item in sub_tasks.array
Compact plan steps, oldest first. This is the summarized view. Use
view=debug if you need the raw plan payload.array
Compact planner and execution notes. Each item has
id, kind, title, status, and summary. Empty until the planner writes notes.timestamp
When Cloud accepted the job, in UTC ISO 8601.
timestamp
When the job last changed, in UTC ISO 8601. Use this to see if a poll returned new work.
object
Relative paths for
status, result, and control on this job. Prefix them with https://api.cloud.blnkfinance.com.object
Raw
sub_tasks and reasoning_trail. Present only when you send view=debug (or verbose=1). Omit it in production clients.