Skip to content

API V2 (Beta) · Imports

List import entries

GET
/v2/imports/{importId}/entries
curl --request GET \
--url https://api.lingohub.com/v2/imports/IMPORT_ID/entries \
--header 'Authorization: Bearer YOUR_API_KEY'

Lists the import’s entries, one per file and language, in the order they were queued. Files are imported one at a time, the source language first; after the first file that fails, the remaining ones are SKIPPED, so retry those after fixing the failed one. UNCHANGED means the file hadn’t changed since its last import and was left alone. Requires stack-level resource view permission; the entries of an import that adds languages can also be read with languages view permission.

importId
required

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

string
filter
Media typeapplication/json

The filter of a list: which items to return.

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
import_entry[file_path]

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
import_entry[file_size_bytes]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_ne
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_in
Array<integer>
>= 1 items
_nin
Array<integer>
>= 1 items
_gt
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_lt
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_gte
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_lte
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_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
import_entry[language_code]

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
_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
_gt
string
import_entry[resource_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
import_entry[status]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_ne
string
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_in
Array<string>
>= 1 items
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_nin
Array<string>
>= 1 items
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_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
import_entry[file_path]

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
import_entry[file_size_bytes]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_ne
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_in
Array<integer>
>= 1 items
_nin
Array<integer>
>= 1 items
_gt
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_lt
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_gte
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_lte
integer format: int64
>= -9223372036854776000 <= 9223372036854776000
_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
import_entry[language_code]

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
_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
_gt
string
import_entry[resource_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
import_entry[status]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_ne
string
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_in
Array<string>
>= 1 items
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
_nin
Array<string>
>= 1 items
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED

Filters the list: URL-encoded JSON of the schema ImportEntryFilter. 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. This list cannot be sorted. An unsupported field, operator or value answers 400 invalid_filter with a pointer into the filter.

Field Type Operators
import_entry[file_path] text _eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank
import_entry[file_size_bytes] integer _eq _ne _in _nin _gt _lt _gte _lte _within _null _nnull
import_entry[language_code] language code _eq _ne _in _nin _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank _gt
import_entry[resource_id] id _eq _ne _in _nin
import_entry[status] QUEUED | PROCESSING | SUCCEEDED | FAILED | SKIPPED | UNCHANGED _eq _ne _in _nin
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 import’s entries.

Media typeapplication/json

A list of import entries with pagination capability.

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 single file entry within an import job.

object
object_type
required

Always IMPORT_ENTRY.

string
Allowed values: IMPORT_ENTRY
id
required

Unique identifier of the import entry.

string
>= 1 characters
import_id
required

Unique identifier of the import the entry belongs to.

string
resource_id
required

Unique identifier of the resource the entry imported into, or null while it is not known yet.

string | null
file_path
required

The file path of the import entry.

string | null
language_code
required

Language of the file.

string
status
required

Current status of the import entry.

string
Allowed values: QUEUED PROCESSING SUCCEEDED FAILED SKIPPED UNCHANGED
status_details
required

Machine-readable outcome explanation, including failures and explained skips; null when no explanation was recorded or is needed.

One of:

A machine-readable explanation of a background operation or entry outcome. The detail is safe display text, not a value to parse. A failed or partial operation may already have applied changes; inspect its entries before retrying.

object
code
required

Stable public outcome code.

string
Allowed values: ALREADY_EXISTS UNKNOWN_ERROR PARTIAL_FAILURE STORAGE_UPLOAD_FAILED STORAGE_DOWNLOAD_FAILED ARCHIVE_CREATION_FAILED LANGUAGE_NOT_DETECTED FILE_PATH_NOT_DETECTED PRETRANSLATION_FAILED TRANSLATION_PROVIDER_FAILED EMPTY_FILE UNKNOWN_ENCODING UNSUPPORTED_IMPORT_FORMAT INVALID_FILE_SYNTAX DUPLICATE_KEY KEY_OPERATION_IN_PROGRESS INVALID_DOCUMENT DOCUMENT_PROCESSING_FAILED UNSUPPORTED_EXPORT_FORMAT FILE_GENERATION_FAILED INVALID_FILE_STRUCTURE RESOURCE_TREE_CHANGED RESOURCE_NOT_FOUND LANGUAGE_NOT_FOUND LANGUAGE_NOT_SUPPORTED NO_RESOURCES NO_FILES ENTRY_FAILURES DOCUMENT_VERSION_MISSING DOCUMENT_MERGE_FAILED INVALID_TRANSLATIONS INTEGRATION_RESOURCE_NOT_FOUND INTEGRATION_FAILED INCOMPLETE_TRANSLATION INTERRUPTED SELECTION_CHANGED EMPTY_SELECTION MOVE_SOURCE_CHANGED BACKUP_FAILED RESTORE_FAILED EXECUTION_FAILED TIMED_OUT
detail
required

English explanation of the outcome.

string
file_size_bytes
required

Input file byte length, including document packages. Retained for unchanged imports when known; null when unavailable.

integer | null format: int64
created_at
required

Timestamp when the entry was created.

string format: date-time
updated_at
required

Timestamp when the entry was last updated.

string format: date-time

Example

{
"object_type": "LIST",
"has_more": true,
"next_cursor": "1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q",
"data": [
{
"object_type": "IMPORT_ENTRY",
"id": "rie_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"import_id": "rin_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"resource_id": "rc_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"file_path": "en.xliff",
"language_code": "en",
"status": "SUCCEEDED",
"status_details": null,
"file_size_bytes": 2048,
"created_at": "2025-01-15T10:30:00.123Z",
"updated_at": "2025-06-20T14:45: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.