Get Word fill job — Brigg developers

Access & visibility

Allow documents.GetWordFillJob on your API key.

Acting member required. Send Brigg-Act-As with an approved member account ID. 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 · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

job_idstringRequired

Exact job_id returned by FillWordTemplate. Use the same approved member; another member's job is not visible.

At least 1 character.

Start, poll, then download

Choose a Word template from List templates: it must retain its original .docx. Supply a visible meeting_id, non-blank context, or both to Fill Word template. Starting a job uses workspace credit; the start response is not the generated document.

Keep job_id and use Get Word fill job under the same approved member. While status is pending, wait before polling again and honor Retry-After on rate limits. On done, review warnings and pass result.file_id to Get file download. The resulting .docx belongs to that member. On failed, stop polling and review error; the result is not available. A cancelled job also reports failed.

Repeating a start for the same member and template while matching work is in progress can return its job_id with deduped=true. Reuse the original idempotency key to recover a lost start response. After failure, a deliberate new attempt uses a new key and may consume more credit.

Response

Returns 200 OK with a JSON body.

statusstringRequired

pending means work is still queued or running; done supplies result; failed supplies error and is terminal. A cancelled job is reported as failed.

resultobjectOptional

Present only after successful completion. Use its file_id for download and inspect warnings before relying on the document.

Nested fields

file_idstringRequired

Generated .docx file belonging to the member who started the fill. Pass it to GetFileDownload with the same member delegation.

filenamestringRequired

Original filename, including its extension.

warningsarray of stringRequired

Issues reported while generating the document; review the output before using it.

errorstringOptional

Terminal failure reason. Stop polling, inspect the cause and decide whether to start a new attempt. It is not an HTTP transport error.

Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

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.
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 Word job is missing, of another kind, or belongs to another member. Use its original job_id and approved member.
429	`rate_limited`	Wait for Retry-After before retrying.
409	`result_unavailable`	The completed job's file is no longer accessible. Review it in Brigg rather than interpreting this as pending.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "job_id": {
      "type": "string",
      "minLength": 1,
      "description": "Exact job_id returned by FillWordTemplate. Use the same approved member; another member's job is not visible."
    }
  },
  "required": [
    "job_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "job_id": "job_proposal"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "pending means work is still queued or running; done supplies result; failed supplies error and is terminal. A cancelled job is reported as failed."
    },
    "result": {
      "type": "object",
      "properties": {
        "file_id": {
          "type": "string",
          "description": "Generated .docx file belonging to the member who started the fill. Pass it to GetFileDownload with the same member delegation."
        },
        "filename": {
          "type": "string",
          "description": "Original filename, including its extension."
        },
        "warnings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Issues reported while generating the document; review the output before using it."
        }
      },
      "required": [
        "file_id",
        "filename",
        "warnings"
      ],
      "additionalProperties": false,
      "description": "Present only after successful completion. Use its file_id for download and inspect warnings before relying on the document."
    },
    "error": {
      "type": "string",
      "description": "Terminal failure reason. Stop polling, inspect the cause and decide whether to start a new attempt. It is not an HTTP transport error."
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "status": "pending"
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenario

Requires BRIGG_ACT_AS: an approved member account ID.

HTTP 200 confirms the status read, not completion.

Request

cURL

curl 'https://api.brigg.app/v1/operations/documents.GetWordFillJob' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "job_id": "job_proposal"
}'

TypeScript

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

const response = await fetch("https://api.brigg.app/v1/operations/documents.GetWordFillJob", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "job_id": "job_proposal"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "job_id": "job_proposal"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.GetWordFillJob",
    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"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "status": "pending"
}

Illustrative values, not a live response.

Inspect warnings, then use the returned file ID for download.

Request

cURL

curl 'https://api.brigg.app/v1/operations/documents.GetWordFillJob' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "job_id": "job_proposal"
}'

TypeScript

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

const response = await fetch("https://api.brigg.app/v1/operations/documents.GetWordFillJob", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "job_id": "job_proposal"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "job_id": "job_proposal"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.GetWordFillJob",
    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"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "status": "done",
  "result": {
    "file_id": "f_proposal",
    "filename": "Proposal.docx",
    "warnings": []
  }
}

Illustrative values, not a live response.

Stop polling this job. A deliberate new attempt is a separate action.

Request

cURL

curl 'https://api.brigg.app/v1/operations/documents.GetWordFillJob' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "job_id": "job_proposal"
}'

TypeScript

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

const response = await fetch("https://api.brigg.app/v1/operations/documents.GetWordFillJob", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "job_id": "job_proposal"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

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

payload = {
  "job_id": "job_proposal"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.GetWordFillJob",
    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"],
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "status": "failed",
  "error": "wordfill_failed"
}

Illustrative values, not a live response.