API V2 (Beta) · Segments
Update a segment
curl --request PATCH \ --url https://api.lingohub.com/v2/segments/SEGMENT_ID \ --header 'Authorization: Bearer YOUR_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "description": "Label on the sign-in button", "is_not_translatable": false, "is_plural": false, "label_ids": [ "la_0197c8f2-5a6b-7cde-8f12-3456789abcde" ], "texts": { "de": { "variants": [ { "content": "Anmelden" } ] } }}'import requests
url = "https://api.lingohub.com/v2/segments/SEGMENT_ID"
payload = { "description": "Label on the sign-in button", "is_not_translatable": False, "is_plural": False, "label_ids": ["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"], "texts": { "de": { "variants": [{ "content": "Anmelden" }] } }}headers = { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v2/segments/SEGMENT_ID';const options = { method: 'PATCH', headers: {Authorization: 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json'}, body: '{"description":"Label on the sign-in button","is_not_translatable":false,"is_plural":false,"label_ids":["la_0197c8f2-5a6b-7cde-8f12-3456789abcde"],"texts":{"de":{"variants":[{"content":"Anmelden"}]}}}'};
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/segments/SEGMENT_ID"
payload := strings.NewReader("{\n \"description\": \"Label on the sign-in button\",\n \"is_not_translatable\": false,\n \"is_plural\": false,\n \"label_ids\": [\n \"la_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"texts\": {\n \"de\": {\n \"variants\": [\n {\n \"content\": \"Anmelden\"\n }\n ]\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY") req.Header.Add("Content-Type", "application/json")
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("application/json");RequestBody body = RequestBody.create(mediaType, "{\n \"description\": \"Label on the sign-in button\",\n \"is_not_translatable\": false,\n \"is_plural\": false,\n \"label_ids\": [\n \"la_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"texts\": {\n \"de\": {\n \"variants\": [\n {\n \"content\": \"Anmelden\"\n }\n ]\n }\n }\n}");Request request = new Request.Builder() .url("https://api.lingohub.com/v2/segments/SEGMENT_ID") .patch(body) .addHeader("Authorization", "Bearer YOUR_API_KEY") .addHeader("Content-Type", "application/json") .build();
Response response = client.newCall(request).execute();<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('PATCH', 'https://api.lingohub.com/v2/segments/SEGMENT_ID', [ 'body' => '{ "description": "Label on the sign-in button", "is_not_translatable": false, "is_plural": false, "label_ids": [ "la_0197c8f2-5a6b-7cde-8f12-3456789abcde" ], "texts": { "de": { "variants": [ { "content": "Anmelden" } ] } }}', 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', 'Content-Type' => 'application/json', ],]);
echo $response->getBody();require 'uri'require 'net/http'
url = URI("https://api.lingohub.com/v2/segments/SEGMENT_ID")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Patch.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'request["Content-Type"] = 'application/json'request.body = "{\n \"description\": \"Label on the sign-in button\",\n \"is_not_translatable\": false,\n \"is_plural\": false,\n \"label_ids\": [\n \"la_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"texts\": {\n \"de\": {\n \"variants\": [\n {\n \"content\": \"Anmelden\"\n }\n ]\n }\n }\n}"
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://api.lingohub.com/v2/segments/SEGMENT_ID"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, }, Content = new StringContent("{\n \"description\": \"Label on the sign-in button\",\n \"is_not_translatable\": false,\n \"is_plural\": false,\n \"label_ids\": [\n \"la_0197c8f2-5a6b-7cde-8f12-3456789abcde\"\n ],\n \"texts\": {\n \"de\": {\n \"variants\": [\n {\n \"content\": \"Anmelden\"\n }\n ]\n }\n }\n}") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}Changes a segment and its texts with JSON merge-patch; changes apply to every key of the segment. texts takes only the languages you change: variants replaces that language’s text and an empty list clears it. Texts are processed with the placeholder settings and automations of project_id, by default the project of the segment’s oldest key. Becoming singular keeps the OTHER form and removes the other plural forms in all languages. Send the ETag from getSegment as If-Match to make sure nobody changed the segment in between. Requires stack-level segment and text view permissions, segment management to change the segment and text management to change its texts.
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 segment, a valid value would be : seg_0197c8f2-5a6b-7cde-8f12-3456789abcde
Public identifier of the segment.
Query Parameters
Section titled “Query 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
Project whose placeholder settings and automations process the texts. It must have a key of the segment; the project of the segment’s oldest key when left out.
Example
pr_0197c8f2-5a6b-7cde-8f12-3456789abcdeHeader Parameters
Section titled “Header Parameters”Optional. The quoted ETag from a GET of this resource. The change is applied only if the resource still has that version; otherwise the request fails with 412 precondition_failed. See Conditional updates.
Request Bodyrequired
Section titled “Request Bodyrequired”Request body to change a segment and its texts with JSON merge-patch. Changes apply to every key of the segment.
object
Note for translators. A LINA with an AI engine reads it too when its context.is_segments_enabled is on; LingoHub-managed LINAs always do. Null clears it.
Example
Label on the sign-in buttonWhether the segment is excluded from translation.
Example
falseWhether the segment has plural forms. The formats of all its files must allow it. Becoming singular keeps the OTHER form and removes the other plural forms in all languages.
Example
falseReplaces the segment’s labels with these labels of the workspace; [] removes them all. At most 150.
Example
[ "la_0197c8f2-5a6b-7cde-8f12-3456789abcde"]The texts to change, by language code; languages left out keep their text. variants replaces a language’s text, and [] clears it.
object
Request body part that replaces the text of a segment in one language.
object
The new text, one variant per device and plural form, in this order. It replaces the language’s text; [] clears it. At most 1,000 variants.
One variant of a text: its content for a device and a plural form. The variants of a text keep the order they are sent in.
object
Device the variant is for. Defaults to OTHER.
Example
OTHERPlural form of the variant; a segment without plural forms takes OTHER only. Defaults to OTHER.
Example
OTHERThe text, with its placeholders and markup. A variant that is still empty after the project’s automations is removed. At most 51,999 characters.
Example
Sign inExample
[ { "content": "Anmelden" }]Whether the change is minor, such as a typo fix: the status automations for minor edits apply, so the translations of a changed source text can stay as they are. Defaults to false.
Example
falseExample
{ "de": { "variants": [ { "content": "Anmelden" } ] }}Request body to change a segment and its texts with JSON merge-patch. Changes apply to every key of the segment.
object
Note for translators. A LINA with an AI engine reads it too when its context.is_segments_enabled is on; LingoHub-managed LINAs always do. Null clears it.
Example
Label on the sign-in buttonWhether the segment is excluded from translation.
Example
falseWhether the segment has plural forms. The formats of all its files must allow it. Becoming singular keeps the OTHER form and removes the other plural forms in all languages.
Example
falseReplaces the segment’s labels with these labels of the workspace; [] removes them all. At most 150.
Example
[ "la_0197c8f2-5a6b-7cde-8f12-3456789abcde"]The texts to change, by language code; languages left out keep their text. variants replaces a language’s text, and [] clears it.
object
Request body part that replaces the text of a segment in one language.
object
The new text, one variant per device and plural form, in this order. It replaces the language’s text; [] clears it. At most 1,000 variants.
One variant of a text: its content for a device and a plural form. The variants of a text keep the order they are sent in.
object
Device the variant is for. Defaults to OTHER.
Example
OTHERPlural form of the variant; a segment without plural forms takes OTHER only. Defaults to OTHER.
Example
OTHERThe text, with its placeholders and markup. A variant that is still empty after the project’s automations is removed. At most 51,999 characters.
Example
Sign inExample
[ { "content": "Anmelden" }]Whether the change is minor, such as a typo fix: the status automations for minor edits apply, so the translations of a changed source text can stay as they are. Defaults to false.
Example
falseExample
{ "de": { "variants": [ { "content": "Anmelden" } ] }}Responses
Section titled “Responses”The segment after the change, with its texts in all languages of its stack.
A source text and its translations, with the notes and labels they share. Every key of the segment shows these texts; its keys are listed by listSegmentKeys.
object
Always SEGMENT.
Public identifier of the segment.
Public identifier of the stack the segment belongs to.
Whether the segment has plural forms.
Note for translators. A LINA with an AI engine reads it too when its context.is_segments_enabled is on; LingoHub-managed LINAs always do.
Whether the segment is excluded from translation.
Why the segment is not translatable: RESOURCE_FILE when the imported file marks it (Android XML, Rails YAML, iOS String Catalog, XLIFF 2), EDITOR when someone marked it in LingoHub. Null when it is translatable.
Origin of a segment’s not-translatable flag: file syntax or an editor/bulk action.
Public identifiers of the segment’s labels.
The segment’s texts by language code, the source first. A read can limit them to the languages named by language_codes.
object
The text of a segment in one language, the source included: its variants and its workflow status.
object
Whether this is the stack’s source language.
Workflow status of the text.
Workflow stage of the status.
The variants of the text in their order: one per device and plural form. Empty when the text is empty.
One variant of a text: its content for a device and a plural form.
object
The text, with its placeholders and markup.
Device the variant is for.
Plural form of the variant; a segment without plural forms has OTHER only.
When the text, its status or its counts last changed.
When the variants last changed. Null before the text ever had content.
Timestamp when the segment was created.
Timestamp when the segment’s description, flags or labels last changed. Each text has its own timestamps.
Example
{ "object_type": "SEGMENT", "id": "seg_0197c8f2-5a6b-7cde-8f12-3456789abcde", "stack_id": "stack_0197c8f2-5a6b-7cde-8f12-3456789abcde", "is_plural": false, "description": "Label on the sign-in button", "is_not_translatable": false, "not_translatable_reason": "RESOURCE_FILE", "label_ids": [ "la_0197c8f2-5a6b-7cde-8f12-3456789abcde" ], "texts": { "en": { "is_source": true, "status": "APPROVED", "stage": "DONE", "variants": [ { "content": "Sign in", "device": "OTHER", "plural_form": "OTHER" } ], "updated_at": "2026-09-29T00:00:00.000Z", "content_updated_at": "2026-09-29T00:00:00.000Z" }, "de": { "is_source": false, "status": "TRANSLATED", "stage": "NEEDS_REVIEW", "variants": [ { "content": "Anmelden", "device": "OTHER", "plural_form": "OTHER" } ], "updated_at": "2026-09-29T00:00:00.000Z", "content_updated_at": "2026-09-29T00:00:00.000Z" } }, "created_at": "2026-09-29T00:00:00.123Z", "updated_at": "2026-09-29T00:00:00.123Z"}Headers
Section titled “Headers”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.
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 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.
conflict: the segment is deactivated (it is in no file) so its texts can’t be changed, the project’s edit settings refer to something that no longer exists, or another change to the segment’s texts is in progress (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”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 current representation does not match If-Match (precondition_failed). No change was applied.
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 request is well-formed, but values are invalid; errors points at each of them.
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 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.