Download raw content asynchronously
Download raw entry content from Contentful without any connector-side conversion. The
returned payload is Contentful’s native JSON representation of the entries selected
by path and configuration.
Use this when you want the original, untranslated content (e.g. to build a custom
preview, snapshot a space, or feed an analytics pipeline). For translation-ready
content, use download-xliff-file instead.
Choosing sync vs async
/sync/download-raw-fileblocks until the connector finishes. Use for small spaces and interactive callers. Subject to gateway timeouts (~60 s)./async/download-raw-filereturns immediately with arequestIdand posts the result to the URL inX-Webhookwhen ready. Required for large spaces.
Response shape (sync only) is controlled by X-ResponseType:
ID(default) — JSON{ "storageId": "..." }. The caller fetches the content from Phrase file storage later. Recommended for any non-trivial payload.OBJECT— rawapplication/octet-stream. Faster for tiny payloads, but holds the file in memory.
Async variant. This endpoint returns immediately with { requestId, webHookUrl }. The actual download result is POSTed to the URL supplied in X-Webhook. X-Webhook is required.
Authorizations
IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer
Headers
A logging ID of the request. It is propagated through Phrase systems, making it easier to connect logs from various services. If no ActionId is sent with a request, one will be generated by Bifrost and returned with the response.
Specify if the response should contain the processed object itself in an application/octet-stream body, or a application/json body with an ID that can be then used to retrieve the object using a /load-content endpoint. Note that for larger files (> 1 MB), it is advised to use the ID option which is also default.
Required on /async/... endpoints. Bifrost POSTs the operation result to this URL once the connector finishes processing.
Omitting this header on an async endpoint returns 400.
Body
Request body for downloading raw Contentful content. The connector loads its credentials from TMS using the supplied connectorUuid.
UUID of a connector instance configured in TMS.
"4282fec0-d2e9-4266-8733-3e634feb7b59"
Contentful-specific behavior knobs (tag filter, reference inlining, asset handling, …).
Source locale of the entries being downloaded (Contentful locale code).
"en-US"
Selector inside the Contentful space — entry, folder, or ROOT for the entire selection driven by configuration.
Response
Successful operation. If X-ResponseType is set to 'ID' or no value is sent in the header, the file is saved and can be retrieved by sending a GET request to this endpoint. If X-ResponseType is set to 'OBJECT', the file is returned as a stream.