Check on an ad being made
get_ad_statusReturns the progress of an ad being made: state, stage (writing, designing, rendering, checking), whether it is terminal, the finished image and download once ready, or a failure message with any refunded credits. Meant to be read again after poll_after_seconds, until terminal is true; an ad usually takes a few minutes.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"job_id": "<job_id>"
},
"name": "get_ad_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | Yes | Job reference returned when the ad was started (_references.job_id); list_generation_jobs returns it too. A generation_job_id is a different value and is not accepted. | |
| response_format | No | Output format: text (default) or json. table is not available for this tool. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| stage | No | stage value in this response. | |
| state | No | state value in this response. | |
| status | No | Current progress or delivery state. | |
| message | No | message value in this response. | |
| results | No | Completed outputs currently available for this job or campaign. | |
| brand_id | No | Reference for the selected brand. | |
| terminal | No | True when polling should stop: ready, ended without a preview, failed, cancelled, or awaiting human attention. | |
| created_at | No | created at value in this response. | |
| updated_at | No | updated at value in this response. | |
| _references | No | Opaque action references accepted by subsequent tool calls. | |
| next_action | No | Suggested next operation for the current job state. | |
| refund_credits | No | refund credits value in this response. | |
| failure_message | No | failure message value in this response. | |
| needs_attention | No | True when the ad is waiting on support before it can continue. | |
| credits_reserved | No | credits reserved value in this response. | |
| estimated_seconds | No | estimated seconds value in this response. | |
| poll_after_seconds | No | Seconds between status checks; zero when finished. |