Skip to main content
Choose the API that serves your task. The two interfaces use different base URLs and expose different resources. CLI Platform sync uses the files and jobs API. Keep its api_base_url at https://hyperlocalise.com/api unless you are using a separately configured environment. Do not replace it with the Projects and Queries host.

​
Choose credentials

Use workspace Settings to create the API key or personal token required by your integration. Store its value in your environment or CI secret manager. Access depends on the credential’s permissions and its owner’s current workspace and project access. A token does not grant access its owner lacks. Queries also depend on the workspace’s entitlement.

​
Verify the connection

For Projects and Queries, start with the read-only identity request in its guide, then list accessible projects. For file translation, follow the upload and download examples in Files and jobs, using one source file and one target locale. Keep the host, resource, HTTP status, and error code when investigating a failure. For an access problem, check roles and permissions.

​
Next

Connect an AI agent through MCP if you want tool-based access instead of writing HTTP requests.