Documents

A document is a ready-to-use file that Bitrix24 generates from a template by substituting values. Each document is created from a document template and a data provider.

Bitrix24 API: documentgenerator.document.* Scope: documentgenerator

For CRM documents, select a template in the CRM template section; app templates live in /v1/doc-templates. The /v1/crm-documents routes use crm.documentgenerator.document.* and the crm scope.

PDF and PNG are generated asynchronously. Retry a download after 409 DOCUMENT_NOT_READY. Machine download links use /v1/documents with documentgenerator scope for app documents, and /v1/crm-documents with crm scope for CRM documents. Public sharing is a separate action: an enabled public URL works without authentication.

Download document DOCX

Download the generated DOCX file. Both app and CRM documents use the same download behavior, with different routes and scopes. A READONLY key is accepted.

Parameters

Examples

For CRM documents, replace documents with crm-documents and use crm scope.

cURL: personal key

curl --fail-with-body "https://vibecode.bitrix24.com/v1/documents/73/download" \
  -H "X-Api-Key: $VIBE_API_KEY" -o document.docx

cURL: OAuth app

curl --fail-with-body "https://vibecode.bitrix24.com/v1/documents/73/download" \
  -H "X-Api-Key: $VIBE_APP_KEY" -H "Authorization: Bearer $B24_ACCESS_TOKEN" -o document.docx

JavaScript: personal key

const response = await fetch('https://vibecode.bitrix24.com/v1/documents/73/download', {
  headers: { 'X-Api-Key': vibeApiKey },
});
if (!response.ok) throw new Error(await response.text());
const bytes = await response.arrayBuffer();

JavaScript: OAuth app

const response = await fetch('https://vibecode.bitrix24.com/v1/documents/73/download', {
  headers: { 'X-Api-Key': vibeAppKey, Authorization: `Bearer ${b24AccessToken}` },
});
if (!response.ok) throw new Error(await response.text());
const bytes = await response.arrayBuffer();

Response

Binary bytes with Content-Type and Content-Disposition. For /v1/documents, the maximum file size is 10 MiB. Machine URLs in document reads lead to these authenticated V1 routes. PDF and PNG are generated asynchronously: for /v1/documents, retry 409 later. Bitrix24 credential URLs are never published.

Errors

Common errors

See also

• Documents
• Get document
• Public URL