Skip to main content
POST
/
v1
/
projects
curl --request POST \
  --url https://api.studio.us.phrase.com/v1/projects \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form sourceLanguage=en \
  --form 'subtitleProfiles={
  "subtitleProfileId": "00000000-0000-0000-0000-000000000001",
  "languageCode": "en"
}' \
  --form 'translationLanguages[0]=tr' \
  --form 'translationLanguages[1]=es' \
  --form dubbingLanguages=tr \
  --form summary=false \
  --form customAttributes=true \
  --form 'insights[0]=00000000-0000-0000-0000-000000000002' \
  --form 'insights[1]=00000000-0000-0000-0000-000000000003' \
  --form 'glossary={
  "id": "00000000-0000-0000-0000-000000000004",
  "content": "term1\\nterm2\\nterm3"
}' \
  --form 'safeCommunications[0]=00000000-0000-0000-0000-000000000005' \
  --form 'safeCommunications[1]=00000000-0000-0000-0000-000000000006' \
  --form 'pronunciations={
  "pronunciationId": "00000000-0000-0000-0000-000000000007",
  "languageCode": "en"
}' \
  --form files.items='@example-file'
{
  "id": "01jzmvc20cjq5hj5saa96ttp2x"
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
title
string
default:Untitled Project

Project title

Body

multipart/form-data
​
sourceLanguage
enum<string>
required

Source language code

Available options:
auto,
en,
en-us,
en-gb,
en-in,
en-au,
en-ca,
en-za,
zh,
zh-cn,
zh-tw,
zh-hk,
de,
es,
es-es,
es-mx,
es-419,
es-ar,
ru,
ko,
fr,
fr-ca,
ja,
pt,
pt-br,
tr,
pl,
ca,
nl,
ar,
ar-sa,
ar-ae,
sv,
it,
id,
hi,
fi,
vi,
he,
uk,
el,
ms,
cs,
ro,
da,
hu,
ta,
no,
th,
ur,
hr,
bg,
lt,
la,
mi,
ml,
cy,
sk,
te,
fa,
lv,
bn,
sr,
az,
sl,
kn,
et,
mk,
br,
eu,
is,
hy,
ne,
mn,
bs,
kk,
sq,
sw,
gl,
mr,
pa,
si,
km,
sn,
yo,
so,
af,
oc,
ka,
be,
tg,
sd,
gu,
am,
yi,
lo,
uz,
fo,
ht,
ps,
tk,
nn,
mt,
sa,
lb,
my,
bo,
tl,
mg,
as,
tt,
haw,
ln,
ha,
ba,
jw,
su,
yue,
fil,
ga,
zu,
ig,
ceb,
ny,
ky
​
subtitleProfiles
object[]
required

Array of subtitle profile selections. In multipart, provide this as a JSON array string.

​
translationLanguages
enum<string>[]

Target languages for translation. Provide as JSON array or JSON string.

Available options:
en,
en-us,
en-gb,
en-in,
en-au,
en-ca,
en-za,
zh,
zh-cn,
zh-tw,
zh-hk,
de,
es,
es-es,
es-mx,
es-419,
es-ar,
ru,
ko,
fr,
fr-ca,
ja,
pt,
pt-br,
tr,
pl,
ca,
nl,
ar,
ar-sa,
ar-ae,
sv,
it,
id,
hi,
fi,
vi,
he,
uk,
el,
ms,
cs,
ro,
da,
hu,
ta,
no,
th,
ur,
hr,
bg,
lt,
la,
mi,
ml,
cy,
sk,
te,
fa,
lv,
bn,
sr,
az,
sl,
kn,
et,
mk,
br,
eu,
is,
hy,
ne,
mn,
bs,
kk,
sq,
sw,
gl,
mr,
pa,
si,
km,
sn,
yo,
so,
af,
oc,
ka,
be,
tg,
sd,
gu,
am,
yi,
lo,
uz,
fo,
ht,
ps,
tk,
nn,
mt,
sa,
lb,
my,
bo,
tl,
mg,
as,
tt,
haw,
ln,
ha,
ba,
jw,
su,
yue,
fil,
ga,
zu,
ig,
ceb,
ny,
ky
​
dubbingLanguages
enum<string>[]

Target languages for dubbing. Provide as JSON array or JSON string.

Available options:
af,
ar,
hy,
as,
az,
be,
bn,
bs,
bg,
ca,
ceb,
ny,
zh,
hr,
cs,
da,
nl,
en,
et,
fil,
fi,
fr,
gl,
ka,
de,
el,
gu,
ha,
he,
hi,
hu,
is,
id,
ga,
it,
ja,
jw,
kn,
kk,
ky,
ko,
lv,
ln,
lt,
lb,
mk,
ms,
ml,
mr,
ne,
no,
ps,
fa,
pl,
pt,
pa,
ro,
ru,
sr,
sd,
sk,
sl,
so,
es,
sw,
sv,
ta,
te,
th,
tr,
uk,
ur,
vi,
cy
​
summary
boolean

Enable summary generation

​
customAttributes
boolean

Enable custom attributes extraction

​
insights
string<uuid>[]

Requested insight IDs (UUID v4). Provide as JSON array or JSON string.

​
glossary

Glossary configuration (JSON object or JSON string). When provided as an object in multipart form, use JSON string representation.

​
safeCommunications
string<uuid>[]

Safe communication IDs (UUID v4). Provide as JSON array or JSON string.

​
pronunciations
object[]

Pronunciations to apply. In multipart, provide as JSON array string.

​
fileUrls
string<uri>[]

External file URLs to import. Provide as JSON array or JSON string. If provided, uploaded files in this request are ignored for processing (but still count towards the 5-item limit).

​
files
file[]

One or more files to upload (max 5 total across files + fileUrls). Ignored for processing when fileUrls are provided (but still count towards the limit).

Response

Upload accepted and project initialized

​
id
string
required

Project ID