# Share text document

Create an expiring read-only link to a text document’s current content. Later edits appear through the same link. Anyone holding the URL can read it until expiry or revocation; share_id is only its management identifier.

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

## Access & visibility

Allow `documents.ShareTextDocument` 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 |
| --- | --- | --- | --- |
| `file_id` | string | Yes | Use the file_id of a collaborative text document. Find an existing document with [ListDocuments](https://developer.brigg.app/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](https://developer.brigg.app/reference/documents/CreateTextDocument). At least 1 character. |
| `ttl_days` | integer | No | Link lifetime in days from creation. Defaults to 30; choose an integer from 1 through 365. Creating another link does not revoke existing links. Range: 1 to 365. |

## A share link grants access

The returned `url` is a bearer link: someone holding it can open the shared content within that link's terms. Keep it out of application logs and analytics. The separate `share_id` identifies a link for management and revocation; it is not sufficient to read content.

Sharing a text document uses `file_id`; sharing a generated document uses `document_id` and can name a `version_id`. Do not substitute one ID type for another. Revoking one share link does not remove other links or change the content's underlying workspace/private visibility.

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `share_id` | string | Yes | Non-secret identifier of a share link returned by a share or share-list operation. Use it to revoke that link; it cannot be used to open the document. Treat the separate url value as a bearer credential. |
| `url` | string | Yes | Read-only bearer link to the document's current content. Later edits appear at this URL. Send only to intended readers and keep it out of logs. |
| `expires_at` | number | Yes | Time this share link stops granting access, in Unix milliseconds. Create a new share link if access is needed after expiry. |

## 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. |
| 409 | `not_text_document` | This file is not a collaborative text document. Use CreateTextDocument or select kind=text_document from ListDocuments. |

## Next steps

- [Create text document](https://developer.brigg.app/reference/documents/CreateTextDocument)
- [List documents](https://developer.brigg.app/reference/documents/ListDocuments)
- [Read text document](https://developer.brigg.app/reference/documents/ReadTextDocument)
- [List text document shares](https://developer.brigg.app/reference/documents/ListTextDocumentShares)
- [Revoke text document share](https://developer.brigg.app/reference/documents/RevokeTextDocumentShare)

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

## Examples

### Share for seven days

Use an existing collaborative text document. The URL below is fictional and cannot open a real document.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/documents.ShareTextDocument' \
  -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 '{
  "file_id": "f_project_notes",
  "ttl_days": 7
}'
```

#### 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.ShareTextDocument", {
  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({
    "file_id": "f_project_notes",
    "ttl_days": 7
  }),
});
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 = {
  "file_id": "f_project_notes",
  "ttl_days": 7
}
request = Request(
    "https://api.brigg.app/v1/operations/documents.ShareTextDocument",
    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
{
  "share_id": "share_project_notes",
  "url": "https://app.example.com/share/fictional-link?org=o_northstar",
  "expires_at": 1794906000000
}
```

## JSON schemas


```json-schema-request
{
  "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](https://developer.brigg.app/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](https://developer.brigg.app/reference/documents/CreateTextDocument)."
    },
    "ttl_days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 365,
      "description": "Link lifetime in days from creation. Defaults to 30; choose an integer from 1 through 365. Creating another link does not revoke existing links."
    }
  },
  "required": [
    "file_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "file_id": "f_project_notes",
      "ttl_days": 7
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "share_id": {
      "type": "string",
      "description": "Non-secret identifier of a share link returned by a share or share-list operation. Use it to revoke that link; it cannot be used to open the document. Treat the separate url value as a bearer credential."
    },
    "url": {
      "type": "string",
      "description": "Read-only bearer link to the document's current content. Later edits appear at this URL. Send only to intended readers and keep it out of logs."
    },
    "expires_at": {
      "type": "number",
      "description": "Time this share link stops granting access, in Unix milliseconds. Create a new share link if access is needed after expiry."
    }
  },
  "required": [
    "share_id",
    "url",
    "expires_at"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "share_id": "share_project_notes",
      "url": "https://app.example.com/share/fictional-link?org=o_northstar",
      "expires_at": 1794906000000
    }
  ]
}
```