Its status and, once completed, the drafts it made.
Authentication
Bearer token (content:read): A workspace API key: ud_live_…
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | |
bot_id | query | string | Only for a key that covers several bots (see GET /bots). Or send the Usedocs-Bot header. |
Responses
| Status | Description |
|---|---|
200 | The task. |
400 | The request is missing something or has a bad value. |
401 | No API key, or the key is revoked. |
403 | A read key on a write, or a key for another bot. |
404 | Not found. |
429 | Rate limited: 120 requests a minute per key, 30 tasks an hour. See Retry-After. |
Response fields
| Field | Type | Description |
|---|---|---|
id | string | |
type | string | change, write_article, document_feature, refresh_article, replace_term, draft_gaps, check_all, audit |
title | string | |
status | string | One of: queued, in_progress, completed, failed. |
result | `object | null` |
error | `string | null` |
createdAt | string (date-time) |