Download raw Optimizely content asynchronously

curl --request POST \
  --url https://eu.phrase.com/connectors/optimizely/v1/async/download-raw-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Webhook: <x-webhook>' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {},
  "path": {
    "pathType": "ITEM",
    "id": "12345"
  },
  "sourceLocale": "en"
}
'

{
  "requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
  "webHookUrl": "https://example.tld/my-webhook"
}

Optimizely

Download raw Optimizely content asynchronously

Download raw content from Optimizely without any connector-side conversion. The returned payload is Optimizely’s native representation of the content items selected by path and configuration.

Use this when you want the original, untranslated content (e.g. to build a custom preview, snapshot a project, or feed an analytics pipeline). For translation-ready content, use download-xliff-file instead.

Choosing sync vs async

/sync/download-raw-file blocks until the connector finishes. Use for small payloads and interactive callers. Subject to gateway timeouts (~60 s).
/async/download-raw-file returns immediately with a requestId and posts the result to the URL in X-Webhook when ready. Required for large payloads.

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 — raw application/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.

POST

optimizely

async

download-raw-file

Download raw Optimizely content asynchronously

curl --request POST \
  --url https://eu.phrase.com/connectors/optimizely/v1/async/download-raw-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Webhook: <x-webhook>' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {},
  "path": {
    "pathType": "ITEM",
    "id": "12345"
  },
  "sourceLocale": "en"
}
'

{
  "requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
  "webHookUrl": "https://example.tld/my-webhook"
}

Authorizations

Authorization

string

header

required

IDM-issued JWT. Obtain via the IDM authentication flow and pass as: Bearer

Headers

X-ActionId

string

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.

X-ResponseType

string

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.

X-Webhook

string

required

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

application/json

Request body for downloading raw Optimizely content. Authenticate by supplying connectorUuid; the connector loads its stored credentials from TMS.

connectorUuid

string

required

UUID of a connector instance configured in TMS.

Example:

"4282fec0-d2e9-4266-8733-3e634feb7b59"

configuration

object

required

Optimizely-specific behavior knobs.

path

object

required

Selector inside the Optimizely project — content item, folder, or ROOT.

Show child attributes

sourceLocale

string

required

Source locale of the content being downloaded (Optimizely locale code).

Example:

"en"

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.

webhookUrl

string

Webhook URL you supplied in the request

requestId

string

Request ID you can use to retrieve the result

Download Optimizely content as XLIFF asynchronously Convert stored raw Optimizely content to XLIFF asynchronously

⌘I