API V2 (Beta) · Context Images
Upload a context image
curl --request POST \ --url https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: multipart/form-data' \ --form file=@translations.json \ --form language_code=en \ --form name=checkout-screen.png \ --form 'description=Screenshot of the checkout screen showing the payment options.' \ --form auto_connect_suggestions=true \ --form capture_key=checkout/payment-sheet \ --form app_version=2.1.0import requests
url = "https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images"
files = { "file": "open('translations.json', 'rb')" }payload = { "language_code": "en", "name": "checkout-screen.png", "description": "Screenshot of the checkout screen showing the payment options.", "auto_connect_suggestions": "true", "capture_key": "checkout/payment-sheet", "app_version": "2.1.0"}headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images';const form = new FormData();form.append('file', 'translations.json');form.append('language_code', 'en');form.append('name', 'checkout-screen.png');form.append('description', 'Screenshot of the checkout screen showing the payment options.');form.append('auto_connect_suggestions', 'true');form.append('capture_key', 'checkout/payment-sheet');form.append('app_version', '2.1.0');
const options = {method: 'POST', headers: {Authorization: 'Bearer YOUR_API_KEY'}};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}package main
import ( "fmt" "strings" "net/http" "io")
func main() {
url := "https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"translations.json\"\r\nContent-Type: application/json\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language_code\"\r\n\r\nen\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ncheckout-screen.png\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nScreenshot of the checkout screen showing the payment options.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_connect_suggestions\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"capture_key\"\r\n\r\ncheckout/payment-sheet\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"app_version\"\r\n\r\n2.1.0\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"translations.json\"\r\nContent-Type: application/json\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language_code\"\r\n\r\nen\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ncheckout-screen.png\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nScreenshot of the checkout screen showing the payment options.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_connect_suggestions\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"capture_key\"\r\n\r\ncheckout/payment-sheet\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"app_version\"\r\n\r\n2.1.0\r\n-----011000010111000001101001--\r\n");Request request = new Request.Builder() .url("https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images") .post(body) .addHeader("Authorization", "Bearer YOUR_API_KEY") .build();
Response response = client.newCall(request).execute();<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('POST', 'https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images', [ 'multipart' => [ [ 'name' => 'file', 'filename' => 'translations.json', 'contents' => null, 'headers' => [ 'Content-Type' => 'application/json' ] ], [ 'name' => 'language_code', 'contents' => 'en' ], [ 'name' => 'name', 'contents' => 'checkout-screen.png' ], [ 'name' => 'description', 'contents' => 'Screenshot of the checkout screen showing the payment options.' ], [ 'name' => 'auto_connect_suggestions', 'contents' => 'true' ], [ 'name' => 'capture_key', 'contents' => 'checkout/payment-sheet' ], [ 'name' => 'app_version', 'contents' => '2.1.0' ] ] 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', ],]);
echo $response->getBody();require 'uri'require 'net/http'
url = URI("https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Post.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"translations.json\"\r\nContent-Type: application/json\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"language_code\"\r\n\r\nen\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\ncheckout-screen.png\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\nScreenshot of the checkout screen showing the payment options.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"auto_connect_suggestions\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"capture_key\"\r\n\r\ncheckout/payment-sheet\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"app_version\"\r\n\r\n2.1.0\r\n-----011000010111000001101001--\r\n"
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Post, RequestUri = new Uri("https://api.lingohub.com/v2/projects/pr_0197c8f2-5a6b-7cde-8f12-3456789abcde/context-images"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, }, Content = new MultipartFormDataContent { new StringContent("") { Headers = { ContentType = new MediaTypeHeaderValue("application/json"), ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "file", FileName = "translations.json", } } }, new StringContent("en") { Headers = { ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "language_code", } } }, new StringContent("checkout-screen.png") { Headers = { ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "name", } } }, new StringContent("Screenshot of the checkout screen showing the payment options.") { Headers = { ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "description", } } }, new StringContent("true") { Headers = { ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "auto_connect_suggestions", } } }, new StringContent("checkout/payment-sheet") { Headers = { ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "capture_key", } } }, new StringContent("2.1.0") { Headers = { ContentDisposition = new ContentDispositionHeaderValue("form-data") { Name = "app_version", } } }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}Uploads an image, at most 10 MB, that shows the UI text of one project language.
- Without
rendered_strings, LingoHub reads the text in the image after the upload and links the segments it finds; withauto_connect_suggestions: falsethey stay suggestions to review in the app. Those links aren’t in the response yet. - With
rendered_strings, as the iOS and Android SDKs send them, the image is linked right away to the segments whose keys or text match, and no text recognition runs.[]uploads the image without links. - With
capture_key, uploading the same screen again keeps the image’s id: identical bytes change nothing (200UNCHANGED); changed bytes replace the file and rebuild all its links, including ones added by hand (200REPLACED). A new image answers 201CREATED.
Every stored upload counts toward the workspace’s monthly context image uploads. A segment keeps its three most recently linked images; linking a fourth detaches the oldest. Requires project-level context-image management permission.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”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
Unique identifier of the project.
Example
pr_0197c8f2-5a6b-7cde-8f12-3456789abcdeHeader Parameters
Section titled “Header Parameters”Optional. A unique key of 1 to 255 characters, for example a UUID, that makes a retry of this request safe: a retry with the same key and the same request returns the first result instead of running the operation again. See Safe retries.
Request Body
Section titled “Request Body”object
The image, at most 10 MB.
Language of the UI text shown in the image. The image can only be attached to segment texts of this language, and the language must be configured for the project.
Example
enDisplay name of the context image, at most 4096 characters. Omit it to use the uploaded file’s name.
Example
checkout-screen.pngWhat the image shows, at most 4096 characters.
Example
Screenshot of the checkout screen showing the payment options.How the segments matched by OCR text-detection are connected: true (the default) connects them to the image, false creates suggestions that require manual review in the web editor.
Example
trueStable capture identity within this project language. Same bytes are a no-op; changed bytes replace all links at the same image id.
Example
checkout/payment-sheetApplication version of this capture.
Example
2.1.0JSON array part with Content-Type application/json, at most 1000 strings. [] uploads the image without links; leave it out to let LingoHub read the text in the image.
One rendered string and its candidate keys. Exactly one matching segment gives a KEY_BASED link; ambiguity gives suggestions. With no key match, exact text matches give suggestions, or TEXT_BASED links when auto_connect_suggestions is true.
object
Candidate SDK keys; an empty list uses text matching.
One key as looked up by the mobile SDK, optionally scoped to an iOS table.
object
Absolute resource key, matched exactly.
Example
checkout.titleIOS table name without file extension; null matches across the default branch.
Example
app.messagesExample
[ { "key": "checkout.title", "table": "app.messages" }]The text as rendered on the screen.
Example
Pay nowWhere the string appears in the image. The boxes of all rendered strings that hit the same segment become its highlight boxes.
A region of the image in whole pixels, measured from its top left corner. The box must lie inside the image.
object
Distance of the box’s left edge from the image’s left edge.
Example
40Distance of the box’s top edge from the image’s top edge.
Example
120Width of the box.
Example
200Height of the box.
Example
48Responses
Section titled “Responses”Capture replaced or unchanged.
A visual context image attached to segments of a project, giving translators and AI agents visual context for the text they work on.
object
Always CONTEXT_IMAGE.
Unique identifier of the context image.
Unique identifier of the project this context image belongs to.
Display name of the context image (defaults to the uploaded file’s name).
Optional description of what the image shows.
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.
Language of the UI text shown in the image. Attachments link to segment texts of this language.
Width of the image in pixels.
Height of the image in pixels.
Processing state of the uploaded image file.
The segments the image is attached to, with their highlight boxes. Links that text recognition finds after the upload aren’t in it yet.
A segment the context image is attached to, at the segment’s text in the image’s language.
object
Unique identifier of the attached segment.
Where the segment’s text appears in the image, in pixels. Empty when no place is marked.
A region of the image in whole pixels, measured from its top left corner. The box must lie inside the image.
object
Distance of the box’s left edge from the image’s left edge.
Distance of the box’s top edge from the image’s top edge.
Width of the box.
Height of the box.
Client-chosen screen identity, scoped to this project language; null for ordinary uploads.
SHA-256 hex of the stored image bytes; null for historical uploads.
Client-reported application version of the last stored capture.
When the current image file was stored. Metadata edits and unchanged captures do not move this timestamp; null for historical uploads.
Timestamp when the context image was created.
Timestamp when the context image was last updated.
What this upload did.
Example
{ "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": "PROCESSING", "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", "outcome": "CREATED"}Headers
Section titled “Headers”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.
True when the original successful result was replayed for this key.
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.
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.
URL of the context image.
Context image uploaded successfully.
A visual context image attached to segments of a project, giving translators and AI agents visual context for the text they work on.
object
Always CONTEXT_IMAGE.
Unique identifier of the context image.
Unique identifier of the project this context image belongs to.
Display name of the context image (defaults to the uploaded file’s name).
Optional description of what the image shows.
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.
Language of the UI text shown in the image. Attachments link to segment texts of this language.
Width of the image in pixels.
Height of the image in pixels.
Processing state of the uploaded image file.
The segments the image is attached to, with their highlight boxes. Links that text recognition finds after the upload aren’t in it yet.
A segment the context image is attached to, at the segment’s text in the image’s language.
object
Unique identifier of the attached segment.
Where the segment’s text appears in the image, in pixels. Empty when no place is marked.
A region of the image in whole pixels, measured from its top left corner. The box must lie inside the image.
object
Distance of the box’s left edge from the image’s left edge.
Distance of the box’s top edge from the image’s top edge.
Width of the box.
Height of the box.
Client-chosen screen identity, scoped to this project language; null for ordinary uploads.
SHA-256 hex of the stored image bytes; null for historical uploads.
Client-reported application version of the last stored capture.
When the current image file was stored. Metadata edits and unchanged captures do not move this timestamp; null for historical uploads.
Timestamp when the context image was created.
Timestamp when the context image was last updated.
What this upload did.
Example
{ "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": "PROCESSING", "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", "outcome": "CREATED"}Headers
Section titled “Headers”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.
True when the original successful result was replayed for this key.
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.
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.
URL of the created context image.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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 workspace has used up the monthly context image uploads of its plan (context_image_limit_reached). An unresolved request returns idempotency_outcome_unknown without Retry-After; inspect the affected resource before starting a new operation. A recent request with the same Idempotency-Key is still being processed (idempotency_key_in_use); retry after the number of seconds in the Retry-After header.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”Seconds to wait for an in-progress keyed request; absent for other conflicts.
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.
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 upload exceeds the maximum size.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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.
A form field is invalid; errors names it. For file: format when it is not an image, file_too_large over 10 MB. language_code is not a language code (format) or not a language of the project (not_found). name and description are longer than 4096 characters (maxLength); auto_connect_suggestions is neither true nor false (type). A rendered_strings box outside the image is maximum on its width or height.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”Seconds to wait before retrying.
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.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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 image service failed to store the image (upstream_error); retry later.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”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.
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.
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
URL identifying the problem type and pointing to its documentation.
Short, constant summary of the problem type.
HTTP status code.
Human-readable explanation of this occurrence of the problem.
Path of the request that produced the problem.
Machine-readable problem type.
Correlation id of the request, also returned in the X-Request-ID header. Quote it when contacting support.
Rejected fields or parameters. Present when the problem concerns specific fields or parameters.
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
Human-readable description of the problem.
JSON Pointer to the offending body field, or to the position inside a JSON-valued parameter.
Name of the offending query, path or header parameter, or of the multipart form field.
Why the field or parameter was rejected.
The permission the API key lacks. Present on 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level required.
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" }}Headers
Section titled “Headers”Seconds to wait before retrying.
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.
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.