Download document bytes for a sync plan download action

GET/api/v1/sync/documents/{id}/content

Authorization

AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Path parameters

idstringrequired

Responses

200

Binary content stream with x-blinqx-checksum header

string<binary>

401

Unauthenticated

errorstringrequired

codestringrequired

rulestring

403

Forbidden (missing scope or permission)

errorstringrequired

codestringrequired

rulestring

404

Not found

errorstringrequired

codestringrequired

rulestring

429

Rate limited

errorstringrequired

codestringrequired

rulestring

Request

curl -X GET '/api/v1/sync/documents/string/content' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("/api/v1/sync/documents/string/content", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/sync/documents/string/content",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

"string"

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}

{
  "error": "string",
  "code": "string",
  "rule": "string"
}