Skip to content

API V1 · Projects

Create a project

POST
/v1/{workspaceUrl}/projects
curl --request POST \
--url https://api.lingohub.com/v1/acme-corp/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": "standard_json",
"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

The URL slug of the workspace. The project links that GET /v1/projects returns contain it: /v1/{workspaceUrl}/projects/{projectUrl}.

Example

acme-corp
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 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

standard_json
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>

A link to a related resource. rel names the relation; type is set on links to resource files.

object
rel

The link relation type describing the relationship to the current resource.

string
href

The URL of the linked resource.

string
type

The media type of the linked resource.

string

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
error
object
code
string
description
string
status
string
Allowed values: 100 CONTINUE 101 SWITCHING_PROTOCOLS 102 PROCESSING 103 EARLY_HINTS 200 OK 201 CREATED 202 ACCEPTED 203 NON_AUTHORITATIVE_INFORMATION 204 NO_CONTENT 205 RESET_CONTENT 206 PARTIAL_CONTENT 207 MULTI_STATUS 208 ALREADY_REPORTED 226 IM_USED 300 MULTIPLE_CHOICES 301 MOVED_PERMANENTLY 302 FOUND 303 SEE_OTHER 304 NOT_MODIFIED 307 TEMPORARY_REDIRECT 308 PERMANENT_REDIRECT 400 BAD_REQUEST 401 UNAUTHORIZED 402 PAYMENT_REQUIRED 403 FORBIDDEN 404 NOT_FOUND 405 METHOD_NOT_ALLOWED 406 NOT_ACCEPTABLE 407 PROXY_AUTHENTICATION_REQUIRED 408 REQUEST_TIMEOUT 409 CONFLICT 410 GONE 411 LENGTH_REQUIRED 412 PRECONDITION_FAILED 413 CONTENT_TOO_LARGE 413 PAYLOAD_TOO_LARGE 414 URI_TOO_LONG 415 UNSUPPORTED_MEDIA_TYPE 416 REQUESTED_RANGE_NOT_SATISFIABLE 417 EXPECTATION_FAILED 418 I_AM_A_TEAPOT 421 MISDIRECTED_REQUEST 422 UNPROCESSABLE_CONTENT 422 UNPROCESSABLE_ENTITY 423 LOCKED 424 FAILED_DEPENDENCY 425 TOO_EARLY 426 UPGRADE_REQUIRED 428 PRECONDITION_REQUIRED 429 TOO_MANY_REQUESTS 431 REQUEST_HEADER_FIELDS_TOO_LARGE 451 UNAVAILABLE_FOR_LEGAL_REASONS 500 INTERNAL_SERVER_ERROR 501 NOT_IMPLEMENTED 502 BAD_GATEWAY 503 SERVICE_UNAVAILABLE 504 GATEWAY_TIMEOUT 505 HTTP_VERSION_NOT_SUPPORTED 506 VARIANT_ALSO_NEGOTIATES 507 INSUFFICIENT_STORAGE 508 LOOP_DETECTED 509 BANDWIDTH_LIMIT_EXCEEDED 510 NOT_EXTENDED 511 NETWORK_AUTHENTICATION_REQUIRED
validationErrors
Array<object>
object
field
string
errors
Array<object>
object
code
string
description
string
parameters
object
key
additional properties

Example

{
"error": {
"status": "100 CONTINUE"
}
}

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
message
required
string | null
items
required
Array<string> | null

Example generated

{
"message": "example",
"items": [
"example"
]
}

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

Media typeapplication/json
object
error
object
code
string
description
string
status
string
Allowed values: 100 CONTINUE 101 SWITCHING_PROTOCOLS 102 PROCESSING 103 EARLY_HINTS 200 OK 201 CREATED 202 ACCEPTED 203 NON_AUTHORITATIVE_INFORMATION 204 NO_CONTENT 205 RESET_CONTENT 206 PARTIAL_CONTENT 207 MULTI_STATUS 208 ALREADY_REPORTED 226 IM_USED 300 MULTIPLE_CHOICES 301 MOVED_PERMANENTLY 302 FOUND 303 SEE_OTHER 304 NOT_MODIFIED 307 TEMPORARY_REDIRECT 308 PERMANENT_REDIRECT 400 BAD_REQUEST 401 UNAUTHORIZED 402 PAYMENT_REQUIRED 403 FORBIDDEN 404 NOT_FOUND 405 METHOD_NOT_ALLOWED 406 NOT_ACCEPTABLE 407 PROXY_AUTHENTICATION_REQUIRED 408 REQUEST_TIMEOUT 409 CONFLICT 410 GONE 411 LENGTH_REQUIRED 412 PRECONDITION_FAILED 413 CONTENT_TOO_LARGE 413 PAYLOAD_TOO_LARGE 414 URI_TOO_LONG 415 UNSUPPORTED_MEDIA_TYPE 416 REQUESTED_RANGE_NOT_SATISFIABLE 417 EXPECTATION_FAILED 418 I_AM_A_TEAPOT 421 MISDIRECTED_REQUEST 422 UNPROCESSABLE_CONTENT 422 UNPROCESSABLE_ENTITY 423 LOCKED 424 FAILED_DEPENDENCY 425 TOO_EARLY 426 UPGRADE_REQUIRED 428 PRECONDITION_REQUIRED 429 TOO_MANY_REQUESTS 431 REQUEST_HEADER_FIELDS_TOO_LARGE 451 UNAVAILABLE_FOR_LEGAL_REASONS 500 INTERNAL_SERVER_ERROR 501 NOT_IMPLEMENTED 502 BAD_GATEWAY 503 SERVICE_UNAVAILABLE 504 GATEWAY_TIMEOUT 505 HTTP_VERSION_NOT_SUPPORTED 506 VARIANT_ALSO_NEGOTIATES 507 INSUFFICIENT_STORAGE 508 LOOP_DETECTED 509 BANDWIDTH_LIMIT_EXCEEDED 510 NOT_EXTENDED 511 NETWORK_AUTHENTICATION_REQUIRED
validationErrors
Array<object>
object
field
string
errors
Array<object>
object
code
string
description
string
parameters
object
key
additional properties

Example

{
"error": {
"status": "100 CONTINUE"
}
}