cURL
curl --request POST \
--url https://{deployment}.convex.site/v1/projects \
--header 'Content-Type: application/json' \
--data '
{
"name": "My App",
"sourceLocale": "en",
"targetLocales": [
"nl-NL",
"fr-FR"
]
}
'import requests
url = "https://{deployment}.convex.site/v1/projects"
payload = {
"name": "My App",
"sourceLocale": "en",
"targetLocales": ["nl-NL", "fr-FR"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: 'My App', sourceLocale: 'en', targetLocales: ['nl-NL', 'fr-FR']})
};
fetch('https://{deployment}.convex.site/v1/projects', 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://{deployment}.convex.site/v1/projects",
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([
'name' => 'My App',
'sourceLocale' => 'en',
'targetLocales' => [
'nl-NL',
'fr-FR'
]
]),
CURLOPT_HTTPHEADER => [
"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://{deployment}.convex.site/v1/projects"
payload := strings.NewReader("{\n \"name\": \"My App\",\n \"sourceLocale\": \"en\",\n \"targetLocales\": [\n \"nl-NL\",\n \"fr-FR\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{deployment}.convex.site/v1/projects")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My App\",\n \"sourceLocale\": \"en\",\n \"targetLocales\": [\n \"nl-NL\",\n \"fr-FR\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}.convex.site/v1/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My App\",\n \"sourceLocale\": \"en\",\n \"targetLocales\": [\n \"nl-NL\",\n \"fr-FR\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"projectId": "<string>"
}Projects
Post v1projects
Create a new translation project with source and target locales. Initializes translation records and activity log. Requires user session.
POST
/
v1
/
projects
cURL
curl --request POST \
--url https://{deployment}.convex.site/v1/projects \
--header 'Content-Type: application/json' \
--data '
{
"name": "My App",
"sourceLocale": "en",
"targetLocales": [
"nl-NL",
"fr-FR"
]
}
'import requests
url = "https://{deployment}.convex.site/v1/projects"
payload = {
"name": "My App",
"sourceLocale": "en",
"targetLocales": ["nl-NL", "fr-FR"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({name: 'My App', sourceLocale: 'en', targetLocales: ['nl-NL', 'fr-FR']})
};
fetch('https://{deployment}.convex.site/v1/projects', 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://{deployment}.convex.site/v1/projects",
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([
'name' => 'My App',
'sourceLocale' => 'en',
'targetLocales' => [
'nl-NL',
'fr-FR'
]
]),
CURLOPT_HTTPHEADER => [
"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://{deployment}.convex.site/v1/projects"
payload := strings.NewReader("{\n \"name\": \"My App\",\n \"sourceLocale\": \"en\",\n \"targetLocales\": [\n \"nl-NL\",\n \"fr-FR\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://{deployment}.convex.site/v1/projects")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My App\",\n \"sourceLocale\": \"en\",\n \"targetLocales\": [\n \"nl-NL\",\n \"fr-FR\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{deployment}.convex.site/v1/projects")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My App\",\n \"sourceLocale\": \"en\",\n \"targetLocales\": [\n \"nl-NL\",\n \"fr-FR\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"projectId": "<string>"
}Body
application/json
Minimum string length:
1Example:
"My App"
Required string length:
2 - 10Pattern:
^[a-z]{2,3}(-[A-Z]{2,3})?$/iExample:
"en"
Minimum array length:
1Required string length:
2 - 10Pattern:
^[a-z]{2,3}(-[A-Z]{2,3})?$/iExample:
["nl-NL", "fr-FR"]
Response
201 - application/json
Project created successfully
⌘I