API V2 (Beta) · API Keys
Retrieve the API key
curl --request GET \ --url https://api.lingohub.com/v2/api-key \ --header 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.lingohub.com/v2/api-key"
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get(url, headers=headers)
print(response.json())const url = 'https://api.lingohub.com/v2/api-key';const options = {method: 'GET', headers: {Authorization: 'Bearer YOUR_API_KEY'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://api.lingohub.com/v2/api-key"
req, _ := http.NewRequest("GET", url, nil)
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();
Request request = new Request.Builder() .url("https://api.lingohub.com/v2/api-key") .get() .addHeader("Authorization", "Bearer YOUR_API_KEY") .build();
Response response = client.newCall(request).execute();<?php
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.lingohub.com/v2/api-key', [ 'headers' => [ 'Authorization' => 'Bearer YOUR_API_KEY', ],]);
echo $response->getBody();require 'uri'require 'net/http'
url = URI("https://api.lingohub.com/v2/api-key")
http = Net::HTTP.new(url.host, url.port)http.use_ssl = true
request = Net::HTTP::Get.new(url)request["Authorization"] = 'Bearer YOUR_API_KEY'
response = http.request(request)puts response.read_bodyusing System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://api.lingohub.com/v2/api-key"), Headers = { { "Authorization", "Bearer YOUR_API_KEY" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}Returns the API key this request is made with: what it reaches, what it may do there, and when it expires. The permissions are the ones requests are authorized with, in the vocabulary of required_permission in 403 responses.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”API key retrieved successfully.
An API key of the workspace, without its token. Only getApiKey includes the permissions, for the key the request is made with.
object
Always API_KEY.
Unique identifier of the API key.
Name of the API key.
Description of the API key.
What the API key reaches.
Whose permissions the API key follows: WORKSPACE_MANAGED keys act with the permissions stored on the key, USER_OWNED keys with the current permissions of the member in member_id.
Unique identifier of the workspace the API key belongs to.
The only stack a STACK key reaches; null for the other scopes and once that stack is deleted.
The member a personal (USER_OWNED) key belongs to or a USER key is assigned to; null for other keys and once that member has left the workspace.
When the API key stops working: the end of its last valid day in UTC. Null when it does not expire.
When the API key was last used, to the minute; null when it has not been used.
When the API key was deactivated; null while it is active. A deactivated key no longer works.
When the API key was created.
When the API key was last changed; using it doesn’t count as a change.
The current permissions of the key the request is made with: one per workspace area, and one per stack area that applies to every stack the key reaches, unless stack_permissions names the stack. Only getApiKey fills it; null elsewhere.
The access level the represented principal has to one area, in the vocabulary of required_permission in 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level granted.
The stacks on which the key’s stack permissions differ from those in permissions. Only getApiKey fills it; null elsewhere.
The API key’s stack permissions for one stack where they differ from its default.
object
Unique identifier of the stack.
The permissions on this stack, one per stack area.
The access level the represented principal has to one area, in the vocabulary of required_permission in 403 responses.
object
Where the permission applies.
The area the permission governs.
The access level granted.
Example
{ "object_type": "API_KEY", "id": "api_0197c8f2-5a6b-7cde-8f12-3456789abcde", "name": "CI pipeline", "description": "Pushes translations from the release pipeline.", "scope": "WORKSPACE", "management_mode": "WORKSPACE_MANAGED", "workspace_id": "space_0197c8f2-5a6b-7cde-8f12-3456789abcde", "expires_at": "2027-01-01T00:00:00.123Z", "last_used_at": "2026-09-30T12:00:00.123Z", "deactivated_at": "2026-10-01T08:00:00.123Z", "deactivation_reason": "MANUAL_REVOCATION", "created_at": "2026-01-15T10:30:00.123Z", "updated_at": "2026-06-20T14:45:00.123Z", "permissions": [ { "scope": "STACK", "target": "RESOURCES", "level": "MANAGE" } ], "stack_permissions": [ { "stack_id": "stack_0197c8f2-5a6b-7cde-8f12-3456789abcde", "permissions": [ { "scope": "STACK", "target": "RESOURCES", "level": "MANAGE" } ] } ]}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 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.