Skip to content

API V2 (Beta) · Project Settings

Update project settings

PATCH
/v2/projects/{projectId}/settings
curl --request PATCH \
--url https://api.lingohub.com/v2/projects/PROJECT_ID/settings \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{}'

Changes any of the project’s settings (JSON merge-patch): send only the sections and fields that change; lists are replaced as a whole. Imports and exports that start, or are queued without their own settings, use the new values; existing keys and texts aren’t rewritten. Integration settings apply from the next sync. All changes are applied together or not at all. Requires project-level settings management permission.

projectId
required

Public id that is created from the type prefix of the corresponding resource and its UUID. I.e : For a project, a valid value would be : pr_0197c8f2-5a6b-7cde-8f12-3456789abcde

string
If-Match
string

Optional. The quoted ETag from a GET of this resource. The change is applied only if the resource still has that version; otherwise the request fails with 412 precondition_failed. See Conditional updates.

Request body to change a project’s settings (JSON merge-patch): send only the sections and fields that change, also inside the sections of format. Lists are replaced as a whole; null removes a format section.

object
export

Export defaults.

object
source_statuses

The statuses a source text needs to be exported.

Array<string>
<= 150 items
Allowed values: BLOCKED NEW STALE REJECTED DRAFT AI_TRANSLATED TRANSLATED QA_PASSED QA_FLAGGED APPROVED NOT_TRANSLATABLE

Example

[
"APPROVED"
]
target_statuses

The statuses a target text needs to be exported.

Array<string>
<= 150 items
Allowed values: BLOCKED NEW STALE REJECTED DRAFT AI_TRANSLATED TRANSLATED QA_PASSED QA_FLAGGED APPROVED NOT_TRANSLATABLE

Example

[
"APPROVED"
]
source_empty_content_handling

What an export does with an empty source text.

string
Allowed values: KEEP SKIP

Example

KEEP
target_empty_content_handling

What an export does with an empty target text.

string
Allowed values: KEEP SKIP

Example

SKIP
is_not_translatable_skipped

Whether exports exclude not-translatable entries.

boolean

Example

false
html_encoding

How exports write HTML in the formats that support it.

string
Allowed values: RAW ESCAPE CDATA

Example

CDATA
import

Import defaults.

object
is_source_creation_enabled

Whether imports may create source text entries.

boolean

Example

true
source_text_update_mode

When imports may update an existing source text.

string
Allowed values: ALWAYS ONLY_EMPTY NEVER

Example

ALWAYS
is_source_metadata_update_enabled

Whether imports may update source metadata.

boolean

Example

true
is_source_deactivation_enabled

Whether imports may deactivate source entries missing from the input.

boolean

Example

false
is_target_creation_enabled

Whether imports may create target text entries.

boolean

Example

true
target_text_update_mode

When imports may update an existing target text.

string
Allowed values: ALWAYS ONLY_EMPTY NEVER

Example

ONLY_EMPTY
is_target_metadata_update_enabled

Whether imports may update target metadata.

boolean

Example

true
is_target_deactivation_enabled

Whether imports may deactivate target entries missing from the input.

boolean

Example

false
format

File-format options. Null removes them, which only documents and integration projects allow.

One of:

The options of the project’s file format, in sections. Which sections a project needs depends on its type: general for every file-based type except DOCUMENT; csv for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; escape for STANDARD_PROPERTIES and STANDARD_INI; json for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; i18next_json for I18NEXT_JSON; xliff for STANDARD_XLIFF; properties for STANDARD_PROPERTIES. A section the type doesn’t need has no effect.

object
general

Options every file format uses; changed field by field.

object
charset

The character encoding of exported files.

string
Allowed values: UTF_8 UTF_16

Example

UTF_8
file_name_languages

Which exported files carry their language code in the file name or path.

string
Allowed values: ALL TARGETS NONE

Example

ALL
is_source_used_when_missing

Use source content when supported.

boolean

Example

true
comment_languages

Which exported files carry comments; null: no file does.

One of:

Which exported files carry comments: ALL every file, SOURCE only the file of the source language.

string
Allowed values: ALL SOURCE
indentation

Spaces per indentation level, 0 to 100; null uses 2.

integer | null format: int32
<= 100

Example

2
is_final_newline_enabled

End output in a newline.

boolean

Example

true
csv

CSV options; changed field by field, null removes them.

One of:

Changes how CSV files are read and written, field by field.

object
is_import_detection_enabled

Let imports update detected CSV settings.

boolean

Example

true
key_header

The header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.

string | null

Example

key
description_header

The header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.

string | null

Example

description
delimiter

The character between the columns.

string
>= 1 characters

Example

;
quote

The character that encloses a value.

string
>= 1 characters

Example

"
is_status_exported

Include status information in CSV output.

boolean

Example

false
escape

Escaping options; changed field by field, null removes them.

One of:

Changes how special characters are written.

object
is_character_escaping_enabled

Escape output characters.

boolean

Example

true
json

JSON options; changed field by field, null removes them.

One of:

Changes how JSON files are laid out, field by field.

object
is_array_indentation_enabled

Indent JSON arrays.

boolean

Example

false
is_plural_order_alphabetical

Order plural forms alphabetically.

boolean

Example

false
i18next_json

I18next options; changed field by field, null removes them.

One of:

Changes how i18next JSON files are read and written, field by field.

object
version

The i18next JSON version of the files.

string
Allowed values: VERSION_3 VERSION_4

Example

VERSION_4
is_base_plural_exported

Include base plural keys.

boolean

Example

false
xliff

XLIFF options; changed field by field, null removes them.

One of:

Changes how XLIFF files identify keys and languages, field by field.

object
is_resname_identifier

Use resname for segment identity.

boolean

Example

false
is_multi_language

File contains multiple languages.

boolean

Example

false
properties

Properties options; changed field by field, null removes them.

One of:

Changes how properties files name plural forms.

object
plural_separator

The text between a key and its plural form, such as _ in apples_one.

string

Example

_
keys

Key normalisation.

object
normalization_strategy

How keys are normalised when they are imported, created or renamed. Existing keys aren’t renamed.

string
Allowed values: FORMAT_SPECIFIC ALL NONE

Example

FORMAT_SPECIFIC
placeholders

Placeholder recognition.

object
definitions

The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Send default_definitions to go back to the defaults.

Array<string>
Allowed values: DEFAULT_ICU DEFAULT_PRINTF IOS_PRINTF ANDROID_PRINTF TWINE_PRINTF STRINGSDICT_VARIABLE_START_END STRING_CATALOG_SUBSTITUTION_VARIABLE RAILS_YAML_START_END SYMFONY_YAML_START_END JSON_TEMPLATE_START_END JSON_REFERENCE_START_END DEFAULT_REPEAT_CHARACTERS CHROME_I18N_REPEAT_CHARACTERS JSON_REPEAT_CHARACTERS I18_NEXT_REPEAT_CHARACTERS NQC_REPEAT_CHARACTERS DOCUMENT_CODE_MARKUP CHROME_I18N_NUMBERED QT_LINGUIST_TS_NUMBERED ANDROID_XLIFF_G XLIFF_X XLIFF_BPT XLIFF_EPT XLIFF_IT XLIFF_PH XLIFF_G XLIFF_BX XLIFF_EX

Example

[
"DEFAULT_ICU",
"DEFAULT_PRINTF"
]
integrations

Integration settings; only for a project that has an integration.

object
is_removed_resource_deletion_enabled

Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.

boolean

Example

true
is_removed_language_deletion_enabled

Whether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.

boolean

Example

false

The project’s settings after the change.

Media typeapplication/json

All settings of a project: export and import defaults, file-format options, key normalisation, placeholder recognition and, if the project has an integration, the integration settings.

object
object_type
required

Always PROJECT_SETTINGS.

string
Allowed values: PROJECT_SETTINGS
id
required

The project these settings belong to.

string
>= 1 characters
export
required

Export defaults.

object
source_statuses
required

The statuses a source text needs to be exported. Null on older projects that never stored a selection.

Array<string> | null
Allowed values: BLOCKED NEW STALE REJECTED DRAFT AI_TRANSLATED TRANSLATED QA_PASSED QA_FLAGGED APPROVED NOT_TRANSLATABLE
target_statuses
required

The statuses a target text needs to be exported. Null on older projects that never stored a selection.

Array<string> | null
Allowed values: BLOCKED NEW STALE REJECTED DRAFT AI_TRANSLATED TRANSLATED QA_PASSED QA_FLAGGED APPROVED NOT_TRANSLATABLE
source_empty_content_handling
required

What an export does with an empty source text.

string
Allowed values: KEEP SKIP
target_empty_content_handling
required

What an export does with an empty target text.

string
Allowed values: KEEP SKIP
is_not_translatable_skipped
required

Whether exports exclude not-translatable entries.

boolean
html_encoding
required

How exports write HTML in the formats that support it.

string
Allowed values: RAW ESCAPE CDATA
import
required

Import defaults.

object
is_source_creation_enabled
required

Whether imports may create source text entries.

boolean
source_text_update_mode
required

When imports may update an existing source text.

string
Allowed values: ALWAYS ONLY_EMPTY NEVER
is_source_metadata_update_enabled
required

Whether imports may update source metadata.

boolean
is_source_deactivation_enabled
required

Whether imports may deactivate source entries missing from the input.

boolean
is_target_creation_enabled
required

Whether imports may create target text entries.

boolean
target_text_update_mode
required

When imports may update an existing target text.

string
Allowed values: ALWAYS ONLY_EMPTY NEVER
is_target_metadata_update_enabled
required

Whether imports may update target metadata.

boolean
is_target_deactivation_enabled
required

Whether imports may deactivate target entries missing from the input.

boolean
format
required

File-format options; null for documents and integration projects, which have none.

One of:

The options of the project’s file format, in sections. Which sections a project needs depends on its type: general for every file-based type except DOCUMENT; csv for STANDARD_CSV, SINGLE_LANGUAGE_CSV and KEY_VALUE_CSV; escape for STANDARD_PROPERTIES and STANDARD_INI; json for STANDARD_ARB, STANDARD_JSON, ANGULAR_TRANSLATE_JSON, CHROME_I18N_JSON, GO_I18N_JSON, I18NEXT_JSON, REACT_INTL_JSON and VUE_I18N_JSON; i18next_json for I18NEXT_JSON; xliff for STANDARD_XLIFF; properties for STANDARD_PROPERTIES. A section the type doesn’t need has no effect.

object
general
required

Options every file format uses.

One of:

Options every file format uses.

object
charset
required

The character encoding of exported files. Null on older projects that never stored one.

One of:

The character encoding of exported files.

string
Allowed values: UTF_8 UTF_16
file_name_languages
required

Which exported files carry their language code in the file name or path. Null on older projects that never stored one.

One of:

Which exported files carry their language code in the file name or path: ALL every file, TARGETS only the files of the target languages, NONE no file.

string
Allowed values: ALL TARGETS NONE
is_source_used_when_missing
required

Whether to use source content when missing in supported file processing.

boolean
comment_languages
required

Which exported files carry comments; null: no file does.

One of:

Which exported files carry comments: ALL every file, SOURCE only the file of the source language.

string
Allowed values: ALL SOURCE
indentation
required

Spaces per indentation level, in the formats that indent.

integer format: int32
is_final_newline_enabled
required

Whether output ends in a newline.

boolean
csv
required

CSV options; required for the CSV project types.

One of:

How CSV files are read and written.

object
is_import_detection_enabled
required

Whether imports may update CSV settings from detected file content.

boolean
key_header
required

The header of the column with the keys. Null: imports take the column headed Title, Key or Id, and exports leave the header empty.

string | null
description_header
required

The header of the column with the descriptions. Null: imports take the column headed Description or Comment, and exports leave the header empty.

string | null
delimiter
required

The character between the columns. Null on older projects that never stored one.

string | null
quote
required

The character that encloses a value. Null on older projects that never stored one.

string | null
is_status_exported
required

Whether CSV exports include status information.

boolean
escape
required

Escaping options; required for STANDARD_PROPERTIES and STANDARD_INI.

One of:

How special characters are written.

object
is_character_escaping_enabled
required

Whether file writers escape characters.

boolean
json
required

JSON options; required for the JSON and ARB project types.

One of:

How JSON files are laid out.

object
is_array_indentation_enabled
required

Whether JSON arrays are indented.

boolean
is_plural_order_alphabetical
required

Whether plural forms are ordered alphabetically.

boolean
i18next_json
required

I18next options; required for I18NEXT_JSON.

One of:

How i18next JSON files are read and written.

object
version
required

The i18next JSON version of the files. Null on older projects that never stored one.

One of:

The i18next JSON version, which decides how plural keys are named: VERSION_3 adds _plural (or _0, _1, …), VERSION_4 adds the plural category, such as _one and _other.

string
Allowed values: VERSION_3 VERSION_4
is_base_plural_exported
required

Whether exports include base plural keys.

boolean
xliff
required

XLIFF options; required for STANDARD_XLIFF.

One of:

How XLIFF files identify keys and languages.

object
is_resname_identifier
required

Whether resname identifies the segment key.

boolean
is_multi_language
required

Whether the XLIFF file carries multiple languages.

boolean
properties
required

Properties options; required for STANDARD_PROPERTIES.

One of:

How properties files name plural forms.

object
plural_separator
required

The text between a key and its plural form, such as _ in apples_one. Null on older projects that never stored one.

string | null
keys
required

Key normalisation.

object
normalization_strategy
required

How keys are normalised when they are imported, created or renamed. Null on older projects that never stored one.

One of:

How keys are normalised when they are imported, created or renamed: FORMAT_SPECIFIC as the file format requires, ALL always, NONE never. Existing keys aren’t renamed.

string
Allowed values: FORMAT_SPECIFIC ALL NONE
placeholders
required

Placeholder recognition.

object
definitions
required

The placeholder kinds recognised in texts; the first that matches wins. Empty: none. Null on older projects that never stored a list.

Array<string> | null
Allowed values: DEFAULT_ICU DEFAULT_PRINTF IOS_PRINTF ANDROID_PRINTF TWINE_PRINTF STRINGSDICT_VARIABLE_START_END STRING_CATALOG_SUBSTITUTION_VARIABLE RAILS_YAML_START_END SYMFONY_YAML_START_END JSON_TEMPLATE_START_END JSON_REFERENCE_START_END DEFAULT_REPEAT_CHARACTERS CHROME_I18N_REPEAT_CHARACTERS JSON_REPEAT_CHARACTERS I18_NEXT_REPEAT_CHARACTERS NQC_REPEAT_CHARACTERS DOCUMENT_CODE_MARKUP CHROME_I18N_NUMBERED QT_LINGUIST_TS_NUMBERED ANDROID_XLIFF_G XLIFF_X XLIFF_BPT XLIFF_EPT XLIFF_IT XLIFF_PH XLIFF_G XLIFF_BX XLIFF_EX
default_definitions
required

The placeholder kinds of the project’s type; read-only. Send them as definitions to go back to the defaults.

Array<string>
Allowed values: DEFAULT_ICU DEFAULT_PRINTF IOS_PRINTF ANDROID_PRINTF TWINE_PRINTF STRINGSDICT_VARIABLE_START_END STRING_CATALOG_SUBSTITUTION_VARIABLE RAILS_YAML_START_END SYMFONY_YAML_START_END JSON_TEMPLATE_START_END JSON_REFERENCE_START_END DEFAULT_REPEAT_CHARACTERS CHROME_I18N_REPEAT_CHARACTERS JSON_REPEAT_CHARACTERS I18_NEXT_REPEAT_CHARACTERS NQC_REPEAT_CHARACTERS DOCUMENT_CODE_MARKUP CHROME_I18N_NUMBERED QT_LINGUIST_TS_NUMBERED ANDROID_XLIFF_G XLIFF_X XLIFF_BPT XLIFF_EPT XLIFF_IT XLIFF_PH XLIFF_G XLIFF_BX XLIFF_EX
is_default
required

definitions equals default_definitions; read-only.

boolean
integrations
required

Integration settings; null when the project has no integration.

One of:

What a sync of the project’s integration deletes; every integration type has them.

object
is_removed_resource_deletion_enabled
required

Whether a Git repository pull deletes files the repository no longer contains. Only Git integrations read this setting; the other integrations always delete resources a sync no longer reports. Enabled by default for Git integrations.

boolean
is_removed_language_deletion_enabled
required

Whether a sync deletes languages the integration no longer reports. The source language is never deleted. Only Contentful, HubSpot, Storyblok, Stripo and Zendesk integrations read this setting; Git and Crisp integrations never delete languages. Enabled by default for Contentful, Zendesk and Storyblok integrations.

boolean

Example

{
"object_type": "PROJECT_SETTINGS",
"id": "pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"export": {
"source_statuses": [
"APPROVED"
],
"target_statuses": [
"APPROVED"
],
"source_empty_content_handling": "KEEP",
"target_empty_content_handling": "KEEP",
"is_not_translatable_skipped": false,
"html_encoding": "RAW"
},
"import": {
"is_source_creation_enabled": true,
"source_text_update_mode": "ALWAYS",
"is_source_metadata_update_enabled": true,
"is_source_deactivation_enabled": false,
"is_target_creation_enabled": true,
"target_text_update_mode": "ALWAYS",
"is_target_metadata_update_enabled": true,
"is_target_deactivation_enabled": false
},
"format": {
"general": {
"charset": "UTF_8",
"file_name_languages": "ALL",
"is_source_used_when_missing": true,
"comment_languages": "SOURCE",
"indentation": 2,
"is_final_newline_enabled": true
},
"csv": {
"is_import_detection_enabled": true,
"key_header": "key",
"description_header": "description",
"delimiter": ";",
"quote": "\"",
"is_status_exported": false
},
"escape": {
"is_character_escaping_enabled": true
},
"json": {
"is_array_indentation_enabled": false,
"is_plural_order_alphabetical": false
},
"i18next_json": {
"version": "VERSION_4",
"is_base_plural_exported": false
},
"xliff": {
"is_resname_identifier": false,
"is_multi_language": false
},
"properties": {
"plural_separator": "_"
}
},
"keys": {
"normalization_strategy": "FORMAT_SPECIFIC"
},
"placeholders": {
"definitions": [
"DEFAULT_ICU",
"DEFAULT_PRINTF"
],
"default_definitions": [
"DEFAULT_ICU",
"DEFAULT_PRINTF"
],
"is_default": true
},
"integrations": {
"is_removed_resource_deletion_enabled": true,
"is_removed_language_deletion_enabled": false
}
}
ETag
string

Opaque strong validator for this representation. Keep its quotation marks and use it as If-Match on a documented conditional write. A replay carries the original ETag, which may now be stale.

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 current representation does not match If-Match (precondition_failed). No change was applied.

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 request is well-formed, but values are invalid; errors points at each of them.

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.