Download raw content synchronously

curl --request POST \
  --url https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {
    "tags": [
      "translate-me"
    ],
    "includeReferences": true,
    "includeAssets": false
  },
  "path": {
    "pathType": "ROOT"
  },
  "sourceLocale": "en-US"
}
'

import requests

url = "https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file"

payload = {
    "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
    "configuration": {
        "tags": ["translate-me"],
        "includeReferences": True,
        "includeAssets": False
    },
    "path": { "pathType": "ROOT" },
    "sourceLocale": "en-US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connectorUuid: '4282fec0-d2e9-4266-8733-3e634feb7b59',
    configuration: {tags: ['translate-me'], includeReferences: true, includeAssets: false},
    path: {pathType: 'ROOT'},
    sourceLocale: 'en-US'
  })
};

fetch('https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connectorUuid' => '4282fec0-d2e9-4266-8733-3e634feb7b59',
    'configuration' => [
        'tags' => [
                'translate-me'
        ],
        'includeReferences' => true,
        'includeAssets' => false
    ],
    'path' => [
        'pathType' => 'ROOT'
    ],
    'sourceLocale' => 'en-US'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file"

	payload := strings.NewReader("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {\n    \"tags\": [\n      \"translate-me\"\n    ],\n    \"includeReferences\": true,\n    \"includeAssets\": false\n  },\n  \"path\": {\n    \"pathType\": \"ROOT\"\n  },\n  \"sourceLocale\": \"en-US\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {\n    \"tags\": [\n      \"translate-me\"\n    ],\n    \"includeReferences\": true,\n    \"includeAssets\": false\n  },\n  \"path\": {\n    \"pathType\": \"ROOT\"\n  },\n  \"sourceLocale\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {\n    \"tags\": [\n      \"translate-me\"\n    ],\n    \"includeReferences\": true,\n    \"includeAssets\": false\n  },\n  \"path\": {\n    \"pathType\": \"ROOT\"\n  },\n  \"sourceLocale\": \"en-US\"\n}"

response = http.request(request)
puts response.read_body

{
  "storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}

{
  "problemDetail": {
    "type": "<string>",
    "title": "<string>",
    "status": 123,
    "detail": "<string>",
    "instance": "<string>",
    "properties": {}
  }
}

Contentful

Download raw content synchronously

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-file blocks until the connector finishes. Use for small spaces 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 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 — raw application/octet-stream. Faster for tiny payloads, but holds the file in memory.

POST

contentful2

sync

download-raw-file

Download raw content synchronously

curl --request POST \
  --url https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
  "configuration": {
    "tags": [
      "translate-me"
    ],
    "includeReferences": true,
    "includeAssets": false
  },
  "path": {
    "pathType": "ROOT"
  },
  "sourceLocale": "en-US"
}
'

import requests

url = "https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file"

payload = {
    "connectorUuid": "4282fec0-d2e9-4266-8733-3e634feb7b59",
    "configuration": {
        "tags": ["translate-me"],
        "includeReferences": True,
        "includeAssets": False
    },
    "path": { "pathType": "ROOT" },
    "sourceLocale": "en-US"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connectorUuid: '4282fec0-d2e9-4266-8733-3e634feb7b59',
    configuration: {tags: ['translate-me'], includeReferences: true, includeAssets: false},
    path: {pathType: 'ROOT'},
    sourceLocale: 'en-US'
  })
};

fetch('https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connectorUuid' => '4282fec0-d2e9-4266-8733-3e634feb7b59',
    'configuration' => [
        'tags' => [
                'translate-me'
        ],
        'includeReferences' => true,
        'includeAssets' => false
    ],
    'path' => [
        'pathType' => 'ROOT'
    ],
    'sourceLocale' => 'en-US'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file"

	payload := strings.NewReader("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {\n    \"tags\": [\n      \"translate-me\"\n    ],\n    \"includeReferences\": true,\n    \"includeAssets\": false\n  },\n  \"path\": {\n    \"pathType\": \"ROOT\"\n  },\n  \"sourceLocale\": \"en-US\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {\n    \"tags\": [\n      \"translate-me\"\n    ],\n    \"includeReferences\": true,\n    \"includeAssets\": false\n  },\n  \"path\": {\n    \"pathType\": \"ROOT\"\n  },\n  \"sourceLocale\": \"en-US\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.phrase.com/connectors/contentful2/v1/sync/download-raw-file")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connectorUuid\": \"4282fec0-d2e9-4266-8733-3e634feb7b59\",\n  \"configuration\": {\n    \"tags\": [\n      \"translate-me\"\n    ],\n    \"includeReferences\": true,\n    \"includeAssets\": false\n  },\n  \"path\": {\n    \"pathType\": \"ROOT\"\n  },\n  \"sourceLocale\": \"en-US\"\n}"

response = http.request(request)
puts response.read_body

{
  "storageId": "e48eda63928c4155bez9fdbsaadc15f3"
}

{
  "problemDetail": {
    "type": "<string>",
    "title": "<string>",
    "status": 123,
    "detail": "<string>",
    "instance": "<string>",
    "properties": {}
  }
}

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

enum<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. (ID => JSON with storageId, OBJECT => binary stream).

Available options:

ID,

OBJECT

Body

application/json

Request body for downloading raw Contentful content. The connector loads its credentials from TMS using the supplied connectorUuid.

connectorUuid

string

required

UUID of a connector instance configured in TMS.

Example:

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

configuration

object

required

Contentful-specific behavior knobs (tag filter, reference inlining, asset handling, …).

Show child attributes

sourceLocale

string

required

Source locale of the entries being downloaded (Contentful locale code).

Example:

"en-US"

path

object | null

Selector inside the Contentful space — entry, folder, or ROOT for the entire selection driven by configuration.

Show child attributes

Response

OK — JSON storageId envelope (returned when X-ResponseType=ID).

storageId

string

Download xliff content synchronously Convert raw content from Contentful to XLIFF synchronously

⌘I