Skip to content

API V2 (Beta) · Context Images

List context images

GET
/v2/projects/{projectId}/context-images
curl --request GET \
--url https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images \
--header 'Authorization: Bearer YOUR_API_KEY'

Lists the project’s context images, newest first. attachments lists the segments each image is attached to; a match LingoHub only suggested counts once someone accepts it. Requires project-level context-image view 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

Unique identifier of the project.

Example

pr_0197c8f2-5a6b-7cde-8f12-3456789abcde
filter
Media typeapplication/json

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

object
where

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

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

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

object
>= 1 properties <= 1 properties
_and
Array<object> recursive
_or
Array<object> recursive
context_image[capture_key]

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
context_image[captured_at]

Exactly one operator of the field.

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

The lower and the upper bound.

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

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
context_image[created_at]

Exactly one operator of the field.

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

The lower and the upper bound.

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

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
context_image[has_attachments]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_true

Takes no value; send true.

boolean
_false

Takes no value; send true.

boolean
context_image[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
context_image[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
context_image[name]

Exactly one operator of the field.

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

Takes no value; send true.

boolean
_nblank

Takes no value; send true.

boolean
context_image[updated_at]

Exactly one operator of the field.

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

The lower and the upper bound.

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

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
context_image[upload_status]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
Allowed values: PROCESSING DONE ERROR
_ne
string
Allowed values: PROCESSING DONE ERROR
_in
Array<string>
>= 1 items
Allowed values: PROCESSING DONE ERROR
_nin
Array<string>
>= 1 items
Allowed values: PROCESSING DONE ERROR
_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
context_image[capture_key]

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
context_image[captured_at]

Exactly one operator of the field.

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

The lower and the upper bound.

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

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
context_image[created_at]

Exactly one operator of the field.

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

The lower and the upper bound.

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

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
context_image[has_attachments]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_true

Takes no value; send true.

boolean
_false

Takes no value; send true.

boolean
context_image[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
context_image[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
context_image[name]

Exactly one operator of the field.

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

Takes no value; send true.

boolean
_nblank

Takes no value; send true.

boolean
context_image[updated_at]

Exactly one operator of the field.

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

The lower and the upper bound.

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

Takes no value; send true.

boolean
_nnull

Takes no value; send true.

boolean
context_image[upload_status]

Exactly one operator of the field.

object
>= 1 properties <= 1 properties
_eq
string
Allowed values: PROCESSING DONE ERROR
_ne
string
Allowed values: PROCESSING DONE ERROR
_in
Array<string>
>= 1 items
Allowed values: PROCESSING DONE ERROR
_nin
Array<string>
>= 1 items
Allowed values: PROCESSING DONE ERROR
sort

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

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

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

Field Type Operators Sort
context_image[capture_key] text _eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank –
context_image[captured_at] timestamp _eq _lt _gt _lte _gte _within _null _nnull –
context_image[created_at] timestamp _eq _lt _gt _lte _gte _within _null _nnull yes
context_image[has_attachments] boolean _true _false –
context_image[id] id _eq _ne _in _nin –
context_image[language_code] language code _eq _ne _in _nin _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank _gt –
context_image[name] text _eq _ne _like _nlike _ilike _nilike _contains _ncontains _icontains _nicontains _starts _ends _blank _nblank yes
context_image[updated_at] timestamp _eq _lt _gt _lte _gte _within _null _nnull yes
context_image[upload_status] PROCESSING | DONE | ERROR _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

Context images retrieved successfully.

Media typeapplication/json

A list of context images.

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 visual context image attached to segments of a project, giving translators and AI agents visual context for the text they work on.

object
object_type
required

Always CONTEXT_IMAGE.

string
Allowed values: CONTEXT_IMAGE
id
required

Unique identifier of the context image.

string
>= 1 characters
project_id
required

Unique identifier of the project this context image belongs to.

string
name
required

Display name of the context image (defaults to the uploaded file’s name).

string
0 <= 4096 characters
description
required

Optional description of what the image shows.

string | null
0 <= 4096 characters
url
required

URL of the image at its original size, loadable as returned. Anyone holding the URL can view the image. Null while the upload is still processing or when it failed.

string | null
language_code
required

Language of the UI text shown in the image. Attachments link to segment texts of this language.

string
width
required

Width of the image in pixels.

integer format: int32
height
required

Height of the image in pixels.

integer format: int32
upload_status
required

Processing state of the uploaded image file.

string
Allowed values: PROCESSING DONE ERROR
attachments
required

The segments the image is attached to, with their highlight boxes. A match LingoHub only suggested counts once someone accepts it.

Array<object>

A segment the context image is attached to, at the segment’s text in the image’s language.

object
segment_id
required

Unique identifier of the attached segment.

string
highlight_boxes
required

Where the segment’s text appears in the image, in pixels. Empty when no place is marked.

Array<object>

A region of the image in whole pixels, measured from its top left corner. The box must lie inside the image.

object
left
required

Distance of the box’s left edge from the image’s left edge.

integer format: int32
top
required

Distance of the box’s top edge from the image’s top edge.

integer format: int32
width
required

Width of the box.

integer format: int32
>= 1
height
required

Height of the box.

integer format: int32
>= 1
capture_key
required

Client-chosen screen identity, scoped to this project language; null for ordinary uploads.

string | null
content_hash
required

SHA-256 hex of the stored image bytes; null for historical uploads.

string | null
app_version
required

Client-reported application version of the last stored capture.

string | null
captured_at
required

When the current image file was stored. Metadata edits and unchanged captures do not move this timestamp; null for historical uploads.

string | null format: date-time
created_at
required

Timestamp when the context image was created.

string format: date-time
updated_at
required

Timestamp when the context image was last updated.

string format: date-time

Example

{
"object_type": "LIST",
"has_more": true,
"next_cursor": "1uO9WTLnYqGAtIWkjDmz4VuJZWLkWMxXIH4Hkp2DTuRtPNQYBpkF6Q",
"data": [
{
"object_type": "CONTEXT_IMAGE",
"id": "ci_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"project_id": "pr_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"name": "checkout-screen.png",
"description": "Screenshot of the checkout screen showing the payment options.",
"url": "https://imagedelivery.net/abc/production/context_images/ci_0197c8f2-5a6b-7cde-8f12-3456789abcde/checkout-screen.png/con8192x8192",
"language_code": "en",
"width": 1280,
"height": 720,
"upload_status": "DONE",
"attachments": [
{
"segment_id": "seg_0197c8f2-5a6b-7cde-8f12-3456789abcde",
"highlight_boxes": [
{
"left": 40,
"top": 120,
"width": 200,
"height": 48
}
]
}
],
"capture_key": "checkout/payment-sheet",
"content_hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"app_version": "2.1.0",
"captured_at": "2026-10-08T10:30:00.123Z",
"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.