Get a background job
get_jobThe status and, once completed, the result of a background job started by discover_brands, suggest_brand_names, discover_keywords, discover_prompts or start_auto_clustering. Poll it every few seconds until status is "completed" or "failed"; do not start the job again while it is pending or running. A discover_prompts job usually finishes within 15 minutes and fails with error.code timed_out after about 30 minutes. A failed job carries error.code (timed_out, provider_failed, submission_failed or internal_error) and error.message, which says what to do next.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| jobId | Yes | ||
| organizationId | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | What the job produces, and therefore the shape of `result` | |
| error | No | Why the job failed, and what to do next. Null unless `status` is `failed`. | |
| jobId | Yes | ||
| result | No | The job output, shaped by `type`. Null while the job is still in flight and for a job that failed: it means the result is not known, never that the job produced nothing. | |
| status | Yes | A job in `pending`, `running` or `awaiting_retry` is still in flight; `completed` and `failed` are terminal. |