Skip to content

API V1 · Projects

Create a project

POST
/v1/{workspaceUrl}/projects
curl --request POST \
--url https://api.lingohub.com/v1/WORKSPACE_URL/projects \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"title": "My Mobile App",
"description": "Localization project for the mobile application",
"resourceType": "json.standard",
"sourceLanguageCode": "en",
"targetLanguageCodes": [
"de",
"fr",
"es"
]
}'

Creates a new localization project within the specified workspace. Requires the project title, resource type (file format), source language, and optionally target languages and a description.

workspaceUrl
required
string

WorkspaceUrl

Media typeapplication/json

Request body for creating a new localization project.

object
title
required

The title of the project.

string
0 <= 999 characters

Example

My Mobile App
description

Optional project description.

string
0 <= 512 characters

Example

Localization project for the mobile application
resourceType
required

The resource file type for the project. Determines the file format used for import/export.

string
>= 1 characters
Allowed values: arb properties windows_resx gettext_po markdown chrome_i18n properties qt_linguist_ts txt standard_ini android_xml ios_strings twine_txt rails_yaml php_define symfony2_yaml json_go_i18n angular_translate_json react_intl_json i18next_json standard_json csv xliff html

Example

json.standard
sourceLanguageCode
required

The source (base) language code of the project. This is the language from which translations are made.

string

Example

en
targetLanguageCodes

The list of target language codes to translate into.

Array<string>

Example

[
"de",
"fr",
"es"
]

Successfully created the project. Returns the detailed project information.

Media typeapplication/json

Detailed information about a localization project including its locales, owner, and HATEOAS links.

object
title

The title of the project.

string
owner_email

Email address of the project’s owner.

string
description

Project description.

string
project_locales

The list of locale codes configured for the project.

Array<string>
created_at

Timestamp when the project was created.

string format: date-time
updated_at

Timestamp when the project was last updated.

string format: date-time
links

HATEOAS links for navigating to related resources (e.g. project resources, status).

Array<object>
object
href
string
hreflang
string
title
string
type
string
deprecation
string
profile
string
name
string
templated
boolean

Examples

ExamplecreatedProject

Newly created JSON project

CreatedProject

{
"title": "My Mobile App",
"description": "Localization project for our mobile application",
"links": [
{
"rel": "self",
"href": "https://api.lingohub.com/v1/my-workspace/projects/my-mobile-app"
},
{
"rel": "resources",
"href": "https://api.lingohub.com/v1/my-workspace/projects/my-mobile-app/resources"
}
],
"owner_email": "user@example.com",
"project_locales": [
"en",
"de",
"fr"
],
"created_at": "2025-01-15T10:30:00+0000",
"updated_at": "2025-01-15T10:30:00+0000"
}

Unauthorized: Authentication credentials are missing or invalid.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Forbidden: The authenticated user does not have settings management permission on this workspace.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Not Found: The specified workspace does not exist.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

{
"url": "example",
"message": "example",
"text": "example"
}

Unprocessable Entity: Validation failed for the request body (e.g. missing title, invalid resource type, or invalid language code).

Media typeapplication/json