Create a variable
curl --request POST \
--url https://eu.phrase.com/orchestrator/api/v1/variables \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_sensitive": true,
"name": "simonsoft_shared_secret",
"value": "s3cr3t-t0k3n"
}
'import requests
url = "https://eu.phrase.com/orchestrator/api/v1/variables"
payload = {
"is_sensitive": True,
"name": "simonsoft_shared_secret",
"value": "s3cr3t-t0k3n"
}
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({is_sensitive: true, name: 'simonsoft_shared_secret', value: 's3cr3t-t0k3n'})
};
fetch('https://eu.phrase.com/orchestrator/api/v1/variables', 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/orchestrator/api/v1/variables",
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([
'is_sensitive' => true,
'name' => 'simonsoft_shared_secret',
'value' => 's3cr3t-t0k3n'
]),
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/orchestrator/api/v1/variables"
payload := strings.NewReader("{\n \"is_sensitive\": true,\n \"name\": \"simonsoft_shared_secret\",\n \"value\": \"s3cr3t-t0k3n\"\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/orchestrator/api/v1/variables")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_sensitive\": true,\n \"name\": \"simonsoft_shared_secret\",\n \"value\": \"s3cr3t-t0k3n\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/orchestrator/api/v1/variables")
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 \"is_sensitive\": true,\n \"name\": \"simonsoft_shared_secret\",\n \"value\": \"s3cr3t-t0k3n\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"inserted_at": "2026-01-15T09:30:00.000000Z",
"is_readonly": false,
"is_sensitive": false,
"name": "project_template_uid",
"reference": "{{ @var.project_template_uid }}",
"updated_at": "2026-01-15T09:30:00.000000Z",
"url": "https://eu.phrase.com/orchestrator/manage/variables/123/edit",
"value": "aB3dE5fG7hI9"
}{
"code": "bad_request",
"detail": "The request is malformed, for example its body isn't valid JSON.",
"status": 400,
"title": "Bad Request",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#bad_request"
}{
"code": "unauthorized",
"detail": "The request has no valid Phrase Platform JWT issued for Orchestrator. Send one as `Authorization: Bearer <JWT>`.",
"status": 401,
"title": "Unauthorized",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unauthorized"
}{
"code": "forbidden",
"detail": "The authenticated user isn't allowed to perform this action on the resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#forbidden"
}{
"code": "request_timeout",
"detail": "The request body arrived too slowly. Retry the request.",
"status": 408,
"title": "Request Timeout",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#request_timeout"
}{
"code": "content_too_large",
"detail": "The request body is larger than 8 MB.",
"status": 413,
"title": "Request Entity Too Large",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#content_too_large"
}{
"code": "unprocessable_content",
"detail": "A parameter doesn't match its schema, or the change isn't allowed in the resource's current state. Each entry in `errors` describes one cause.",
"errors": [
{
"detail": "has already been taken",
"pointer": "/name"
}
],
"status": 422,
"title": "Unprocessable Content",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unprocessable_content"
}{
"code": "rate_limited",
"detail": "This user's limit of 1000 requests per 300 seconds is used up. Retry in 42 seconds.",
"status": 429,
"title": "Too Many Requests",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#rate_limited"
}{
"code": "internal_server_error",
"detail": "Orchestrator failed unexpectedly. A write may or may not have been applied, so check the resource before retrying it.",
"status": 500,
"title": "Internal Server Error",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#internal_server_error"
}Variables
Create a variable
Creates a variable owned by the authenticated user. Reference it from any of the user’s workflows as {{ @var.<name> }}. Leading and trailing whitespace is trimmed from value. Idempotency keys are not supported: retrying a request that timed out can create a duplicate, so check whether the first attempt succeeded before retrying.
POST
/
orchestrator
/
api
/
v1
/
variables
Create a variable
curl --request POST \
--url https://eu.phrase.com/orchestrator/api/v1/variables \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_sensitive": true,
"name": "simonsoft_shared_secret",
"value": "s3cr3t-t0k3n"
}
'import requests
url = "https://eu.phrase.com/orchestrator/api/v1/variables"
payload = {
"is_sensitive": True,
"name": "simonsoft_shared_secret",
"value": "s3cr3t-t0k3n"
}
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({is_sensitive: true, name: 'simonsoft_shared_secret', value: 's3cr3t-t0k3n'})
};
fetch('https://eu.phrase.com/orchestrator/api/v1/variables', 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/orchestrator/api/v1/variables",
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([
'is_sensitive' => true,
'name' => 'simonsoft_shared_secret',
'value' => 's3cr3t-t0k3n'
]),
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/orchestrator/api/v1/variables"
payload := strings.NewReader("{\n \"is_sensitive\": true,\n \"name\": \"simonsoft_shared_secret\",\n \"value\": \"s3cr3t-t0k3n\"\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/orchestrator/api/v1/variables")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"is_sensitive\": true,\n \"name\": \"simonsoft_shared_secret\",\n \"value\": \"s3cr3t-t0k3n\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.phrase.com/orchestrator/api/v1/variables")
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 \"is_sensitive\": true,\n \"name\": \"simonsoft_shared_secret\",\n \"value\": \"s3cr3t-t0k3n\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"inserted_at": "2026-01-15T09:30:00.000000Z",
"is_readonly": false,
"is_sensitive": false,
"name": "project_template_uid",
"reference": "{{ @var.project_template_uid }}",
"updated_at": "2026-01-15T09:30:00.000000Z",
"url": "https://eu.phrase.com/orchestrator/manage/variables/123/edit",
"value": "aB3dE5fG7hI9"
}{
"code": "bad_request",
"detail": "The request is malformed, for example its body isn't valid JSON.",
"status": 400,
"title": "Bad Request",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#bad_request"
}{
"code": "unauthorized",
"detail": "The request has no valid Phrase Platform JWT issued for Orchestrator. Send one as `Authorization: Bearer <JWT>`.",
"status": 401,
"title": "Unauthorized",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unauthorized"
}{
"code": "forbidden",
"detail": "The authenticated user isn't allowed to perform this action on the resource.",
"status": 403,
"title": "Forbidden",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#forbidden"
}{
"code": "request_timeout",
"detail": "The request body arrived too slowly. Retry the request.",
"status": 408,
"title": "Request Timeout",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#request_timeout"
}{
"code": "content_too_large",
"detail": "The request body is larger than 8 MB.",
"status": 413,
"title": "Request Entity Too Large",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#content_too_large"
}{
"code": "unprocessable_content",
"detail": "A parameter doesn't match its schema, or the change isn't allowed in the resource's current state. Each entry in `errors` describes one cause.",
"errors": [
{
"detail": "has already been taken",
"pointer": "/name"
}
],
"status": 422,
"title": "Unprocessable Content",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#unprocessable_content"
}{
"code": "rate_limited",
"detail": "This user's limit of 1000 requests per 300 seconds is used up. Retry in 42 seconds.",
"status": 429,
"title": "Too Many Requests",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#rate_limited"
}{
"code": "internal_server_error",
"detail": "Orchestrator failed unexpectedly. A write may or may not have been applied, so check the resource before retrying it.",
"status": 500,
"title": "Internal Server Error",
"type": "https://developers.phrase.com/en/api/orchestrator/errors#internal_server_error"
}Authorizations
A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.
Body
application/json
Variable attributes
Attributes of the variable to create.
Response
Created
A named value owned by a user, referenced from the user's workflows as {{ @var.<name> }}.
Was this page helpful?