Download raw content asynchronously
curl --request POST \
--url https://eu.phrase.com/connectors/document360/v1/async/download-raw-file \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Webhook: <x-webhook>' \
--data '
{
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en"
}
'import requests
url = "https://eu.phrase.com/connectors/document360/v1/async/download-raw-file"
payload = {
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en"
}
headers = {
"X-Webhook": "<x-webhook>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Webhook': '<x-webhook>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
credentials: {
connectionUid: '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
organizationUid: '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
},
path: {
pathType: 'ARTICLE',
projectId: '8f1c0f7a-1111-4a2b-9c3d-000000000001',
articleId: '8f1c0f7a-4444-4a2b-9c3d-000000000004'
},
sourceLocale: 'en'
})
};
fetch('https://eu.phrase.com/connectors/document360/v1/async/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/document360/v1/async/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([
'credentials' => [
'connectionUid' => '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
'organizationUid' => '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
],
'path' => [
'pathType' => 'ARTICLE',
'projectId' => '8f1c0f7a-1111-4a2b-9c3d-000000000001',
'articleId' => '8f1c0f7a-4444-4a2b-9c3d-000000000004'
],
'sourceLocale' => 'en'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Webhook: <x-webhook>"
],
]);
$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/document360/v1/async/download-raw-file"
payload := strings.NewReader("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Webhook", "<x-webhook>")
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/document360/v1/async/download-raw-file")
.header("X-Webhook", "<x-webhook>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/connectors/document360/v1/async/download-raw-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Webhook"] = '<x-webhook>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\"\n}"
response = http.request(request)
puts response.read_body{
"requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
"webHookUrl": "https://example.tld/my-webhook"
}""Document360
Download raw content asynchronously
Download one Document360 article in one language as a raw file, without any connector-side
conversion. The raw file is a small JSON envelope (contentType, title, body, langCode).
path must be an ARTICLE path (use list-files to discover ids); the language is the
sourceLocale of the request.
For translation-ready content, use download-xliff-file instead.
Choosing sync vs async
/sync/download-raw-fileblocks until the connector finishes. Use for interactive callers. Subject to gateway timeouts (~60 s)./async/download-raw-filereturns immediately with arequestIdand posts the result to the URL inX-Webhookwhen ready.
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.
POST
/
document360
/
v1
/
async
/
download-raw-file
Download raw content asynchronously
curl --request POST \
--url https://eu.phrase.com/connectors/document360/v1/async/download-raw-file \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Webhook: <x-webhook>' \
--data '
{
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en"
}
'import requests
url = "https://eu.phrase.com/connectors/document360/v1/async/download-raw-file"
payload = {
"credentials": {
"connectionUid": "7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11",
"organizationUid": "3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10"
},
"path": {
"pathType": "ARTICLE",
"projectId": "8f1c0f7a-1111-4a2b-9c3d-000000000001",
"articleId": "8f1c0f7a-4444-4a2b-9c3d-000000000004"
},
"sourceLocale": "en"
}
headers = {
"X-Webhook": "<x-webhook>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Webhook': '<x-webhook>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
credentials: {
connectionUid: '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
organizationUid: '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
},
path: {
pathType: 'ARTICLE',
projectId: '8f1c0f7a-1111-4a2b-9c3d-000000000001',
articleId: '8f1c0f7a-4444-4a2b-9c3d-000000000004'
},
sourceLocale: 'en'
})
};
fetch('https://eu.phrase.com/connectors/document360/v1/async/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/document360/v1/async/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([
'credentials' => [
'connectionUid' => '7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11',
'organizationUid' => '3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10'
],
'path' => [
'pathType' => 'ARTICLE',
'projectId' => '8f1c0f7a-1111-4a2b-9c3d-000000000001',
'articleId' => '8f1c0f7a-4444-4a2b-9c3d-000000000004'
],
'sourceLocale' => 'en'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Webhook: <x-webhook>"
],
]);
$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/document360/v1/async/download-raw-file"
payload := strings.NewReader("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Webhook", "<x-webhook>")
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/document360/v1/async/download-raw-file")
.header("X-Webhook", "<x-webhook>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/connectors/document360/v1/async/download-raw-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Webhook"] = '<x-webhook>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"connectionUid\": \"7d1b0a52-4c0e-4f4e-9d52-1f2f5b0b8a11\",\n \"organizationUid\": \"3f9a6d0e-8c1b-4a57-b0a1-6c2d9e4f7a10\"\n },\n \"path\": {\n \"pathType\": \"ARTICLE\",\n \"projectId\": \"8f1c0f7a-1111-4a2b-9c3d-000000000001\",\n \"articleId\": \"8f1c0f7a-4444-4a2b-9c3d-000000000004\"\n },\n \"sourceLocale\": \"en\"\n}"
response = http.request(request)
puts response.read_body{
"requestId": "e48eda63-928c-4155-bez9-fdbsaadc15f3",
"webHookUrl": "https://example.tld/my-webhook"
}""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.
Available options:
ID, OBJECT 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 one Document360 article in one language as a raw file (a JSON envelope with the content type, title and body). The file is stored in Phrase file storage.
Connection holding the Document360 API key and host.
Show child attributes
Show child attributes
The article to download (ARTICLE with projectId and articleId).
Show child attributes
Show child attributes
Language of the article version to download (locale code, e.g. en).
Minimum string length:
1Example:
"en"
Document360 settings; may be omitted (connector defaults apply).
Show child attributes
Show child attributes
Example:
{ "includeArchived": false, "workspaceTypes": ["KNOWLEDGE_BASE"], "publishAfterUpload": true }
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.
Was this page helpful?