Get text document version — Brigg developers

Access & visibility

Allow documents.GetTextDocumentVersion on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

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.

file_idstringRequired

Use the file_id of a collaborative text document. Find an existing document with ListDocuments and select kind=text_document. An uploaded PDF, Word file or plain-text file is not a collaborative text document. documents.CreateTextDocument.

At least 1 character.

version_idstringRequired

Saved version_id from ListTextDocumentVersions for this same file_id. It is not a different document's ID.

At least 1 character.

Work with text and saved versions

All documents use a stable file_id. Select document_kind=text_document from the listing for these collaborative text operations. Read text document returns its current Markdown and location.

For an exact change, use Edit text document with the existing text and its replacement; this avoids sending an old full copy over another edit. Replace text document replaces the entire Markdown body. Send the read response’s revision as expected_revision to refuse intervening changes atomically. Re-read before resolving a failed match or revision conflict.

A saved version_id identifies historical content. List versions before reading or reverting one, and use Checkpoint text document when you need a named saved point. A revert changes current content; it is not just a historical read.

Response

Returns 200 OK with a JSON body.

version_idstringRequired

Saved version identity. Keep it together with the document's file_id to read or restore this version.

mdstringRequired

Document content formatted as Markdown.

kindstringRequired

How the version was saved: named is a user-labelled checkpoint; auto is an automatic checkpoint, and pre_revert preserves the state before a restore.

labelstring or nullRequired

Name supplied for a named checkpoint, or null when no label was recorded.

created_bystring or nullRequired

Account that created the record, or null when no account is recorded.

created_atnumberRequired

Creation time in Unix milliseconds.

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. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying.
409	`not_text_document`	This file is not a collaborative text document. Use CreateTextDocument or select kind=text_document from ListDocuments.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "file_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use the file_id of a collaborative text document. Find an existing document with [ListDocuments](/reference/documents/ListDocuments) and select kind=text_document. An uploaded PDF, Word file or plain-text file is not a collaborative text document. [documents.CreateTextDocument](/reference/documents/CreateTextDocument)."
    },
    "version_id": {
      "type": "string",
      "minLength": 1,
      "description": "Saved version_id from ListTextDocumentVersions for this same file_id. It is not a different document's ID."
    }
  },
  "required": [
    "file_id",
    "version_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "file_id": "f_project_notes",
      "version_id": "tdv_project_notes_2"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "version_id": {
      "type": "string",
      "description": "Saved version identity. Keep it together with the document's file_id to read or restore this version."
    },
    "md": {
      "type": "string",
      "description": "Document content formatted as Markdown."
    },
    "kind": {
      "type": "string",
      "description": "How the version was saved: named is a user-labelled checkpoint; auto is an automatic checkpoint, and pre_revert preserves the state before a restore."
    },
    "label": {
      "type": [
        "string",
        "null"
      ],
      "description": "Name supplied for a named checkpoint, or null when no label was recorded."
    },
    "created_by": {
      "type": [
        "string",
        "null"
      ],
      "description": "Account that created the record, or null when no account is recorded."
    },
    "created_at": {
      "type": "number",
      "description": "Creation time in Unix milliseconds."
    }
  },
  "required": [
    "version_id",
    "md",
    "kind",
    "label",
    "created_by",
    "created_at"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "version_id": "tdv_project_notes_2",
      "md": "# Project notes\n\nThe kickoff is on Tuesday.",
      "kind": "named",
      "label": "Before legal review",
      "created_by": "a_jamie",
      "created_at": 1794301200000
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Reading history does not change the current document.

Request

cURL

curl 'https://api.brigg.app/v1/operations/documents.GetTextDocumentVersion' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "file_id": "f_project_notes",
  "version_id": "tdv_project_notes_2"
}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/documents.GetTextDocumentVersion", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "file_id": "f_project_notes",
    "version_id": "tdv_project_notes_2"
  }),
});
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 = {
  "file_id": "f_project_notes",
  "version_id": "tdv_project_notes_2"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.GetTextDocumentVersion",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/documents.GetTextDocumentVersion' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "file_id": "f_project_notes",
  "version_id": "tdv_project_notes_2"
}'

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.GetTextDocumentVersion", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({
    "file_id": "f_project_notes",
    "version_id": "tdv_project_notes_2"
  }),
});
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 = {
  "file_id": "f_project_notes",
  "version_id": "tdv_project_notes_2"
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.GetTextDocumentVersion",
    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

{
  "version_id": "tdv_project_notes_2",
  "md": "# Project notes\n\nThe kickoff is on Tuesday.",
  "kind": "named",
  "label": "Before legal review",
  "created_by": "a_jamie",
  "created_at": 1794301200000
}

Illustrative values, not a live response.