Skip to main content
GET
Agent Jobs API is currently in beta.
Use this endpoint after an agent job completes or fails. You can call it earlier, but output, final_message, completed_at, and failed_at are fully populated only in a terminal state. For in-progress polling, use Get job status. To receive this payload automatically, set config.callbacks when you create the 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 your CLOUD_API_KEY or OAUTH_ACCESS_TOKEN.
Pass Authorization: Bearer CLOUD_API_KEY or Authorization: Bearer OAUTH_ACCESS_TOKEN.
string
required
Cloud API key or OAuth access token. Create credentials in API keys or OAuth.

Path

string
required
Job whose result you want (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
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 requested (job_...). Same value you sent in the path.
string
Where the job is right now. Read output and final_message when this is completed. Read last_error when this is failed. You can call this endpoint earlier, but those fields fill in only after the job finishes.
object
Structured result of the finished plan. The keys depend on the steps that ran. Often includes a summary string. Empty or partial until status is completed.
string
Plain-language summary of the result. Use this for UI copy. The same text is often also in output.summary.
string
Why the job failed. Empty on success. Filled when status is failed.
string
Plan that produced this result (pr_...). Empty if planning never finished.
object
How many plan steps ended in each state: total, completed, running, pending, failed, waiting_approval. Same shape as Get job status.
object
First compact step with status failed. null when the job completed without a failed step. Same shape as one item in sub_tasks on Get job status.
array
Compact plan steps, oldest first. Same fields as sub_tasks on Get job status.
array
Compact planner and execution notes (id, kind, title, status, summary). Empty if the planner wrote none.
timestamp
When Cloud accepted the job, in UTC ISO 8601.
timestamp
When the job last changed, in UTC ISO 8601.
timestamp
When the job reached completed, in UTC ISO 8601. null until then.
timestamp
When the job reached failed, in UTC ISO 8601. null unless status is failed.
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.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.