Skip to content

API V2 (Beta) · Distribution Releases

List distribution releases

GET
/v2/distributions/{distributionId}/releases
curl --request GET \
--url https://api.lingohub.com/v2/distributions/DISTRIBUTION_ID/releases \
--header 'Authorization: Bearer YOUR_API_KEY'

Lists the distribution’s releases, newest first. The live release, the one the CDN serves, is the one with activated_at set; a distribution has at most one. Requires project-level settings management permission.

distributionId
required

Public id composed of the resource type prefix and its UUID.

string
filter
Media typeapplication/json

The filter of a list: which items to return and in which order.

object
where

Exactly one of _and and _or, with the clauses it combines.

object
>= 1 properties <= 1 properties
_and
Array<object>
>= 1 items

A nested _and/_or, or one field with one operator.

object
>= 1 properties <= 1 properties
_and
Array<object> recursive
_or
Array<object> recursive
distribution_release[activated_at]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string format: date-time
_lt
string format: date-time
_gt
string format: date-time
_lte
string format: date-time
_gte
string format: date-time
_within

The lower and the upper bound.

Array<string>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[archive_size_kib]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
integer format: int32
>= -2147483648 <= 2147483647
_ne
integer format: int32
>= -2147483648 <= 2147483647
_in
Array<integer>
>= 1 items
_nin
Array<integer>
>= 1 items
_gt
integer format: int32
>= -2147483648 <= 2147483647
_lt
integer format: int32
>= -2147483648 <= 2147483647
_gte
integer format: int32
>= -2147483648 <= 2147483647
_lte
integer format: int32
>= -2147483648 <= 2147483647
_within

The lower and the upper bound.

Array<integer>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[branch_name]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
_ne
string
_like
string
_nlike
string
_ilike
string
_nilike
string
_contains
string
_ncontains
string
_icontains
string
_nicontains
string
_starts
string
_ends
string
_blank

Takes no value; send true.

boolean
_nblank

Takes no value; send true.

boolean
distribution_release[created_at]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string format: date-time
_lt
string format: date-time
_gt
string format: date-time
_lte
string format: date-time
_gte
string format: date-time
_within

The lower and the upper bound.

Array<string>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[file_count]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
integer format: int32
>= -2147483648 <= 2147483647
_ne
integer format: int32
>= -2147483648 <= 2147483647
_in
Array<integer>
>= 1 items
_nin
Array<integer>
>= 1 items
_gt
integer format: int32
>= -2147483648 <= 2147483647
_lt
integer format: int32
>= -2147483648 <= 2147483647
_gte
integer format: int32
>= -2147483648 <= 2147483647
_lte
integer format: int32
>= -2147483648 <= 2147483647
_within

The lower and the upper bound.

Array<integer>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[id]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
_ne
string
_in
Array<string>
>= 1 items
_nin
Array<string>
>= 1 items
distribution_release[name]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
_ne
string
_like
string
_nlike
string
_ilike
string
_nilike
string
_contains
string
_ncontains
string
_icontains
string
_nicontains
string
_starts
string
_ends
string
_blank

Takes no value; send true.

boolean
_nblank

Takes no value; send true.

boolean
distribution_release[status]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
Allowed values: PROCESSING SUCCEEDED FAILED
_ne
string
Allowed values: PROCESSING SUCCEEDED FAILED
_in
Array<string>
>= 1 items
Allowed values: PROCESSING SUCCEEDED FAILED
_nin
Array<string>
>= 1 items
Allowed values: PROCESSING SUCCEEDED FAILED
distribution_release[updated_at]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string format: date-time
_lt
string format: date-time
_gt
string format: date-time
_lte
string format: date-time
_gte
string format: date-time
_within

The lower and the upper bound.

Array<string>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
_or
Array<object>
>= 1 items

A nested _and/_or, or one field with one operator.

object
>= 1 properties <= 1 properties
_and
Array<object> recursive
_or
Array<object> recursive
distribution_release[activated_at]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string format: date-time
_lt
string format: date-time
_gt
string format: date-time
_lte
string format: date-time
_gte
string format: date-time
_within

The lower and the upper bound.

Array<string>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[archive_size_kib]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
integer format: int32
>= -2147483648 <= 2147483647
_ne
integer format: int32
>= -2147483648 <= 2147483647
_in
Array<integer>
>= 1 items
_nin
Array<integer>
>= 1 items
_gt
integer format: int32
>= -2147483648 <= 2147483647
_lt
integer format: int32
>= -2147483648 <= 2147483647
_gte
integer format: int32
>= -2147483648 <= 2147483647
_lte
integer format: int32
>= -2147483648 <= 2147483647
_within

The lower and the upper bound.

Array<integer>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[branch_name]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
_ne
string
_like
string
_nlike
string
_ilike
string
_nilike
string
_contains
string
_ncontains
string
_icontains
string
_nicontains
string
_starts
string
_ends
string
_blank

Takes no value; send true.

boolean
_nblank

Takes no value; send true.

boolean
distribution_release[created_at]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string format: date-time
_lt
string format: date-time
_gt
string format: date-time
_lte
string format: date-time
_gte
string format: date-time
_within

The lower and the upper bound.

Array<string>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[file_count]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
integer format: int32
>= -2147483648 <= 2147483647
_ne
integer format: int32
>= -2147483648 <= 2147483647
_in
Array<integer>
>= 1 items
_nin
Array<integer>
>= 1 items
_gt
integer format: int32
>= -2147483648 <= 2147483647
_lt
integer format: int32
>= -2147483648 <= 2147483647
_gte
integer format: int32
>= -2147483648 <= 2147483647
_lte
integer format: int32
>= -2147483648 <= 2147483647
_within

The lower and the upper bound.

Array<integer>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
distribution_release[id]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
_ne
string
_in
Array<string>
>= 1 items
_nin
Array<string>
>= 1 items
distribution_release[name]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
_ne
string
_like
string
_nlike
string
_ilike
string
_nilike
string
_contains
string
_ncontains
string
_icontains
string
_nicontains
string
_starts
string
_ends
string
_blank

Takes no value; send true.

boolean
_nblank

Takes no value; send true.

boolean
distribution_release[status]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
Allowed values: PROCESSING SUCCEEDED FAILED
_ne
string
Allowed values: PROCESSING SUCCEEDED FAILED
_in
Array<string>
>= 1 items
Allowed values: PROCESSING SUCCEEDED FAILED
_nin
Array<string>
>= 1 items
Allowed values: PROCESSING SUCCEEDED FAILED
distribution_release[updated_at]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string format: date-time
_lt
string format: date-time
_gt
string format: date-time
_lte
string format: date-time
_gte
string format: date-time
_within

The lower and the upper bound.

Array<string>
>= 2 items <= 2 items
_null

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
sort

Fields to sort by, in order: + ascending, - descending.

Array<string>
<= 8 items
Allowed values: +distribution_release[branch_name] -distribution_release[branch_name] +distribution_release[created_at] -distribution_release[created_at] +distribution_release[name] -distribution_release[name] +distribution_release[updated_at] -distribution_release[updated_at]

Filters and sorts the list: URL-encoded JSON of the schema DistributionReleaseFilter. where holds exactly one _and or _or with an array of clauses; a clause is another _and/_or or a field with exactly one operator. sort lists fields with + (ascending) or - (descending). An unsupported field, operator or value answers 400 invalid_filter with a pointer into the filter.

Field Type Operators Sort
distribution_release[activated_at] timestamp _eq _lt _gt _lte _gte _within _null _nnull –
distribution_release[archive_size_kib] integer _eq _ne _in _nin _gt _lt _gte _lte _within _null _nnull –
distribution_release[branch_name] text _eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank yes
distribution_release[created_at] timestamp _eq _lt _gt _lte _gte _within _null _nnull yes
distribution_release[file_count] integer _eq _ne _in _nin _gt _lt _gte _lte _within _null _nnull –
distribution_release[id] id _eq _ne _in _nin –
distribution_release[name] text _eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank yes
distribution_release[status] PROCESSING | SUCCEEDED | FAILED _eq _ne _in _nin –
distribution_release[updated_at] timestamp _eq _lt _gt _lte _gte _within _null _nnull yes
cursor
string

Opaque pagination cursor from the next_cursor field of a previous response. Omit for the first page.

limit
integer format: int32
default: 20 >= 1 <= 100

Maximum number of items to return per page (1-100).

Example

20

The distribution’s releases.

Media typeapplication/json

A list of distribution releases with cursor pagination.

object
object_type
required

Always LIST.

string
Allowed values: LIST
has_more
required

True if more items exist after this page. Iterate by repeating the request with the cursor query parameter set to next_cursor until has_more is false.

boolean
next_cursor
required

Opaque cursor token pointing past the last item of this page. Null on the last page. Pass it unchanged via the cursor query parameter to request the next page.

string | null
data
required

The list of items in this page.

Array<object>

A release of a distribution: the project’s translations of one branch, exported as an archive the CDN can serve.

object
object_type
required

Always DISTRIBUTION_RELEASE.

string
Allowed values: DISTRIBUTION_RELEASE
id
required

Unique identifier of the release.

string
>= 1 characters
distribution_id
required

Unique identifier of the distribution the release belongs to.

string
project_id
required

Unique identifier of the project the release belongs to.

string
name
required

Name of the release.

string
branch_name
required

The branch the release was made from, under its name at that time.

string
status
required

Status of the release.

string
Allowed values: PROCESSING SUCCEEDED FAILED
language_codes
required

Languages of the release.

Array<string>
file_count
required

Number of files in the archive; null until the release has succeeded.

integer | null format: int32
archive_size_kib
required

Size of the archive in KiB, rounded up; null until the release has succeeded.

integer | null format: int32
key_counts
required

Retained successful-entry key counts; null when unavailable. The total sums file entries, so separate language files count separately while bundled languages count once. Historical releases are not backfilled.

One of:

Retained successful export entry counts. Unknown statistics make the entire snapshot unavailable.

object
total
required

Sum of the entry counts, not a distinct count across separate files or languages.

integer format: int64
entries
required

One count per successful exported file, including combined multi-language files.

Array<object>

Selected logical keys in one successful release file; does not infer separate counts inside bundled language files.

object
file_path
required

Retained exported file path.

string
language_codes
required

Languages selected for this file; bundled files can contain several.

Array<string>
key_count
required

Selected logical keys in this entry, counted once across its languages. Zero means an empty selection.

integer format: int32
export_id
required

Unique identifier of the export that made the release’s archive; read it for the reason of a failure and its log lines. Null once the export is past the workspace’s plan retention and deleted.

string | null
download_url
required

URL of the release’s archive, valid for 24 hours; reading the release again gives a fresh one. Null unless the release SUCCEEDED.

string | null
download_url_expires_at
required

When download_url stops working; null when there is no URL.

string | null format: date-time
activated_at
required

When the release went live; null when it isn’t the live release.

string | null format: date-time
created_at
required

When the release was created.

string format: date-time
updated_at
required

When the release was last changed, including when it went live.

string format: date-time

Example

{
"object_type": "LIST",
"has_more": true,
"next_cursor": "1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q",
"data": [
{
"object_type": "DISTRIBUTION_RELEASE",
"id": "rel_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"distribution_id": "dtb_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"project_id": "pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"name": "September release",
"branch_name": "main",
"status": "SUCCEEDED",
"language_codes": [
"en",
"de"
],
"file_count": 12,
"archive_size_kib": 42,
"key_counts": {
"total": 500,
"entries": [
{
"file_path": "messages.json",
"language_codes": [
"en",
"de"
],
"key_count": 500
}
]
},
"export_id": "reg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"download_url": "https://storage.lingohub.com/distribution-releases/rel_0197c8f2-5a6b-7cde-8f12-3456789abcde.zip?token=abc",
"download_url_expires_at": "2026-10-01T00:00:00.123Z",
"activated_at": "2026-09-30T00:00:00.123Z",
"created_at": "2026-09-30T00:00:00.123Z",
"updated_at": "2026-09-30T00:00:00.123Z"
}
]
}
RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

The request is malformed: an unknown or invalid query parameter, an invalid id in the path, or a body that is not valid JSON. code names the problem, errors the parameter or field.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}
RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

Invalid or missing API key.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}

Insufficient permissions.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}
RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

The resource does not exist, or the API key cannot see it.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}
RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}
Retry-After
integer format: int32

Seconds to wait before retrying.

RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

An unexpected internal server error occurred.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}
RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.

Media typeapplication/problem+json

RFC 9457 problem details. code identifies the problem type (one per type URL); errors lists rejected fields or parameters; required_permission names the permission a 403 lacked.

object
type
required

URL identifying the problem type and pointing to its documentation.

string
title
required

Short, constant summary of the problem type.

string
status
required

HTTP status code.

integer format: int32
detail
required

Human-readable explanation of this occurrence of the problem.

string
instance
required

Path of the request that produced the problem.

string
code
required

Machine-readable problem type.

string
Allowed values: invalid_json invalid_parameter missing_parameter unknown_parameter invalid_filter invalid_cursor bad_request missing_api_key invalid_api_key expired_api_key revoked_api_key disabled_api_key insufficient_permissions resource_not_found route_not_found method_not_allowed not_acceptable precondition_failed content_too_large unsupported_media_type already_exists idempotency_outcome_unknown idempotency_key_in_use stack_not_empty branch_not_ready backup_not_ready backup_in_use default_branch_protected owner_membership_protected source_language_protected branch_limit_reached context_image_limit_reached automation_limit_reached translation_order_pending git_integration_not_configured branch_git_integration_not_configured git_integration_unauthorized conflict validation_failed idempotency_key_mismatch rate_limit_exceeded internal_error upstream_error service_unavailable upstream_timeout
request_id
required

Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.

string
errors

Rejected fields or parameters. Present when the problem concerns specific fields or parameters.

Array<object>

A rejected field or parameter. pointer locates a body field (RFC 6901 JSON Pointer), parameter a query, path or header parameter or a field of a multipart upload; both are set for a position inside a JSON-valued parameter such as filter.

object
detail
required

Human-readable description of the problem.

string
pointer
required

JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.

string | null
parameter
required

Name of the offending query, path or header parameter, or of the multipart form field.

string | null
code
required

Why the field or parameter was rejected.

string
Allowed values: required type enum minLength maxLength minimum maximum pattern format additionalProperties minItems maxItems uniqueItems already_exists not_found not_supported unsupported_file_extension file_too_large file_empty invalid_archive empty_archive
required_permission

The permission the API key lacks. Present on 403 responses.

object
scope
required

Where the permission applies.

string
Allowed values: WORKSPACE STACK
target
required

The area the permission governs.

string
Allowed values: GENERAL BILLING_SUBSCRIPTION WORKSPACES MEMBERS PLUGINS_INTEGRATIONS LOGS API_ACCESS STACKS TRANSLATION_ORDERS WORK_REPORTS STYLE_GUIDES GLOSSARIES TRANSLATION_MEMORIES LABELS AI_TRANSLATION QUICK_TRANSLATIONS SETTINGS ACTIVITIES RESOURCES CONTEXT_IMAGES LANGUAGES SEGMENT_KEYS SEGMENTS SEGMENT_TEXTS
level
required

The access level required.

string
Allowed values: NO_ACCESS VIEW WRITE MANAGE

Example

{
"type": "https://api.lingohub.com/errors/resource-not-found",
"title": "Resource not found",
"status": 404,
"detail": "Resource with ID 'pr_0197c8f2-5a6b-7cde-8f12-3456789abcde' was not found.",
"instance": "/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"code": "invalid_json",
"request_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"errors": [
{
"detail": "must be at least 2 characters long",
"pointer": "#/name",
"parameter": "limit",
"code": "minLength"
}
],
"required_permission": {
"scope": "WORKSPACE",
"target": "GENERAL",
"level": "NO_ACCESS"
}
}
Retry-After
integer format: int32

Seconds to wait before retrying.

RateLimit
string

State of the rate-limit policy currently closest to rejection (IETF draft-ietf-httpapi-ratelimit-headers): the quoted policy name with r = requests remaining right now and t = seconds until the full quota is available again. Example: "api-key";r=42;t=7. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.

RateLimit-Policy
string

The rate-limit policies applied to the request: each quoted policy name with q = sustained request quota per window of w seconds. Example: "api-key";q=180;w=60, "workspace";q=600;w=60. Advisory: absent when the request fails authentication or the limiter state is momentarily unknown.