# Fill Word template

Generate a Word document from a template and meeting content or supplied text. Uses workspace credit. Read workspace.GetJob using the returned job_id to track progress and obtain file_id; repeated requests for the same material reuse the active job.

POST https://api.brigg.app/v1/operations/documents.FillWordTemplate

## Access & visibility

Allow `documents.FillWordTemplate` on your API key.

**Acting member required.** Send `Brigg-Act-As` with an [approved member account ID](https://developer.brigg.app/authentication#member-delegation). The key supplies permissions; the member selects whose data is used.

The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `template_id` | string | Yes | Use a template_id from the template catalogue; this is not the ID of a generated document. [workspace.ListTemplates](https://developer.brigg.app/reference/workspace/ListTemplates). At least 1 character. |
| `meeting_id` | string | No | Visible Meeting record ID from [List meetings](https://developer.brigg.app/reference/meetings/ListMeetings). Supply meeting_id, nonblank context, or both; at least one source is required. At least 1 character. |
| `context` | string | No | Source material to use when filling the Word template. Supply nonblank text, a meeting_id, or both. Whitespace alone does not provide material. At least 1 character. |

## Prepare the source and retrieve the result

Choose a template created from an original .docx in Brigg, then obtain its template_id from [List templates](https://developer.brigg.app/reference/workspace/ListTemplates). The catalogue currently has no Word-capability flag: a normal HTML template cannot be filled by this operation. A not_a_word_template error means choose a Word-backed template; source_missing means repair that template in Brigg.

Provide meeting_id, nonblank context, or both. Keep the returned job_id and poll [Get job](https://developer.brigg.app/reference/workspace/GetJob) as the same member. A successful start is queued work, not a finished document. When completed, pass result.file_id to [Get file download](https://developer.brigg.app/reference/documents/GetFileDownload) for the .docx.

While work is active, the same member/template/meeting reuses that job; for context-only work the text identifies the active request. Changing extra context while a meeting-based job runs does not start a second job. Idempotency-Key independently protects retries of one HTTP action.

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `job_id` | string | Yes | Job ID to pass to workspace.GetJob for progress and the resulting file_id. Poll with the same approved acting member. |
| `deduped` | boolean | No | Whether this call reused work already in progress for the same material. |

## Errors & retries

Set `BRIGG_REQUEST_ID` once for each logical action. The samples send it as `Idempotency-Key`. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. Supply Brigg-Act-As with a member authorized by the key’s delegation grant. The selected member must be active and approved by the credential. This selects whose private data is used; the credential supplies permissions. Private ownership and project boundaries still apply. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |
| 400 | `no_material` | Supply a meeting_id, nonblank context, or both. |
| 404 | `template_not_found` | Choose a template visible to the same acting member. |
| 400 | `not_a_word_template` | Choose a template prepared from an original .docx in Brigg; ordinary HTML templates cannot be filled here. |
| 400 | `source_missing` | Restore the template's original Word file in Brigg. |
| 402 | `insufficient_credits` | Refill workspace credit before starting the job. |
| 502 | `dispatch_failed` | The background job could not be started. Retry the logical request rather than assuming a document was produced. |

## Next steps

- [List templates](https://developer.brigg.app/reference/workspace/ListTemplates)
- [List meetings](https://developer.brigg.app/reference/meetings/ListMeetings)
- [Get job](https://developer.brigg.app/reference/workspace/GetJob)
- [Get file download](https://developer.brigg.app/reference/documents/GetFileDownload)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Fill from supplied material

Use a Word-backed template from your workspace. The returned job is still running.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/documents.FillWordTemplate' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "template_id": "template_consulting",
  "context": "Prepare the agreement for Northstar Consulting AS. A two-week onboarding project starts on 16 November 2026, at a fixed fee of NOK 25,000 excluding VAT."
}'
```

#### TypeScript


```typescript
const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/documents.FillWordTemplate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "template_id": "template_consulting",
    "context": "Prepare the agreement for Northstar Consulting AS. A two-week onboarding project starts on 16 November 2026, at a fixed fee of NOK 25,000 excluding VAT."
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "template_id": "template_consulting",
  "context": "Prepare the agreement for Northstar Consulting AS. A two-week onboarding project starts on 16 November 2026, at a fixed fee of NOK 25,000 excluding VAT."
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.FillWordTemplate",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "job_id": "job_word_agreement"
}
```

### Fill from a meeting

A repeated start can reuse the active job. Poll the returned ID rather than submitting another request.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/documents.FillWordTemplate' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "template_id": "template_consulting",
  "meeting_id": "e_meeting_kickoff",
  "context": "Use the agreed deliverables and owners from this meeting."
}'
```

#### TypeScript


```typescript
const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/documents.FillWordTemplate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "template_id": "template_consulting",
    "meeting_id": "e_meeting_kickoff",
    "context": "Use the agreed deliverables and owners from this meeting."
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "template_id": "template_consulting",
  "meeting_id": "e_meeting_kickoff",
  "context": "Use the agreed deliverables and owners from this meeting."
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.FillWordTemplate",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "job_id": "job_word_agreement",
  "deduped": true
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use a template_id from the template catalogue; this is not the ID of a generated document. [workspace.ListTemplates](https://developer.brigg.app/reference/workspace/ListTemplates)."
    },
    "meeting_id": {
      "type": "string",
      "minLength": 1,
      "description": "Visible Meeting record ID from [List meetings](https://developer.brigg.app/reference/meetings/ListMeetings). Supply meeting_id, nonblank context, or both; at least one source is required."
    },
    "context": {
      "type": "string",
      "minLength": 1,
      "description": "Source material to use when filling the Word template. Supply nonblank text, a meeting_id, or both. Whitespace alone does not provide material."
    }
  },
  "required": [
    "template_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "template_id": "template_consulting",
      "context": "Prepare the agreement for Northstar Consulting AS. A two-week onboarding project starts on 16 November 2026, at a fixed fee of NOK 25,000 excluding VAT."
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Job ID to pass to workspace.GetJob for progress and the resulting file_id. Poll with the same approved acting member."
    },
    "deduped": {
      "type": "boolean",
      "description": "Whether this call reused work already in progress for the same material."
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "job_id": "job_word_agreement"
    }
  ]
}
```