Skip to content

API V1 · Exports

Request a resource export

POST
/v1/{workspaceUrl}/projects/{projectUrl}/exports
curl --request POST \
--url https://api.lingohub.com/v1/acme-corp/projects/my-project/exports \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"filePaths": [
"config/locales/%{locale}/messages.yml"
],
"iso2Slugs": [
"en",
"de",
"fr"
],
"exportFormat": "standard_json",
"branch": "main"
}'

Initiates the creation of a resource export that is assembled asynchronously in the background. Once completed, the export produces a downloadable ZIP file containing the project’s resource files. The optional request body allows filtering by specific file paths, language codes, and overriding the export format. Use the GET endpoint with the returned export ID to poll for completion status and retrieve the download URL.

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
projectUrl
required
string

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

Example

my-project
Media typeapplication/json

Optional request body that acts as filter and may specify the export format

object
filePaths

An additional filter for requesting the export of particular files. If not given, all files of the project will be exported. File paths (including locale placeholder if applicable) as seen in Resources view.

Array<string>
unique items

Example

[
"config/locales/%{locale}/messages.yml"
]
iso2Slugs

An additional filter for requesting the export of particular languages. If not given, all files of all languages of the project will be exported. ISO-639-1 codes of project languages.

Array<string>
unique items

Example

[
"en",
"de",
"fr"
]
exportFormat

Several project types allow to download files in a different format than as defined by the project type. This setting overrides the export format. If not given, the type of the project will be used.

string
Allowed values: strings.ios xml.android.resources properties standard_json

Example

standard_json
branch

Name of the project branch to export from. If omitted, the project’s default branch is used. Returns 422 if the branch name does not exist in the project.

string

Example

main

Successfully created the resource export request. The export is being assembled in the background.

Media typeapplication/json

Response containing the status and details of a resource export, including individual file entries and download URLs.

object
id
required

The unique identifier for this resource export.

string
status
required

The compound status of this resource export. Reflects the overall progress across all entries.

string
Allowed values: NEW SCHEDULED PROCESSING SUCCESS SKIPPED ERROR
resourceExports
required

The list of individual resource export entries (one per file/locale combination).

Array<object>

Status and download information for a single file within a resource export.

object
filePath

The file path of the exported entry, including locale placeholder if applicable.

string
iso2Slug

The ISO-639-1 language code for this entry.

string
status

The processing status of this individual export entry.

string
Allowed values: NEW SCHEDULED PROCESSING SUCCESS SKIPPED ERROR
downloadUrl

The S3 download URL for this individual file. Null while processing or if an error occurred.

string
errorDetails

Detailed information about the error that occurred, if the export failed. Null on success.

string
filePath

The name of the ZIP file that is or will be generated for this export.

string
downloadUrl

The S3 download URL for the exported ZIP. Null while the export is in progress or if an error occurred.

string
triggerType

What started the export, e.g. API_V1 for an export requested through this API or REPOSITORY_PUSH for a repository push.

string
Allowed values: DOWNLOAD_SINGLE DOWNLOAD_MULTIPLE REPOSITORY_PUSH_MULTIPLE REPOSITORY_PUSH DISTRIBUTION_RELEASE PACKAGES BACKUPS ZENDESK_SELECTED ZENDESK_ALL ZENDESK_PUSH API_V1 API_V2 SINGLE_FILE_API_V1 SEGMENT_CONTAINER XLIFF STORYBLOK_PUSH CONTENTFUL_PUSH CSV HUBSPOT_PUSH STRIPO_PUSH CRISP_HELPDESK_PUSH
createdAt

Timestamp when the resource export was created.

string format: date-time

Examples

ExampleexportCreated

Newly created export (scheduled)

ExportCreated

{
"id": "reg_3163-0556-1428-5087674",
"status": "SCHEDULED",
"resourceExports": [],
"errorDetails": null,
"filePath": null,
"downloadUrl": null,
"triggerType": "API_V1",
"createdAt": "2025-01-15T10:30:00.000+00:00"
}

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 resource view permission on this project.

Media typeapplication/json
object
url
string
message
string
text
string

Example generated

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

Not Found: The workspace or project does not exist (V1NotFoundResponse), or a path in filePaths matches no resource file (V1ErrorInfo).

Media typeapplication/json
Any of:
object
message
required
string | null
items
required
Array<string> | null

Example generated

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

Unprocessable Entity: The specified branch name does not exist in the project.

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"
}
}