LOlokalise
Keys

Retrieve a key

Retrieves a Key object.

Requires <code>read_keys</code> OAuth access scope.

get/projects/{project_id}:{branch}/keys/{key_id}

Request

  • Base URL
    https://api.lokalise.com/api2
  • URL
    https://api.lokalise.com/api2/projects/{project_id}:{branch}/keys/{key_id}
  • Auth
    API key in header X-Api-Token

Path parameters

project_idstring required

A unique project identifier

branchstring required

Branch name

key_idnumber required

A unique identifier of the key.

Query parameters

disable_referencesnumber

Whether to disable key references. Possible values are <code>1</code> and <code>0</code>.

include_ai_scoringnumber

Whether to include AI scoring (LQA) results as an <code>ai_scoring</code> object on each translation. Possible values are <code>1</code> and <code>0</code>. The object is <code>null</code> when no score is stored for the translation. Scores are produced by the AI scoring feature (for example an automatic translation task with <code>include_ai_score</code>) and are a signal for human review, not a final quality verdict.

Response

OK

project_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.