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 public API 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.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hyperlocalise","description":"Hyperlocalise Platform and CLI documentation for multilingual content operations, AI translation, and TMS integrations.","colors":{"primary":"#0f766e","light":"#14b8a6","dark":"#0d9488"},"logo":{"light":"https://mintcdn.com/quietcircles/xDwpktL5XMJQ4Sry/logo/logotypo-light-mode.png?fit=max\u0026auto=format\u0026n=xDwpktL5XMJQ4Sry\u0026q=85\u0026s=c1b2c3e2af1cf1bed58bdf3f5061d980","dark":"https://mintcdn.com/quietcircles/xDwpktL5XMJQ4Sry/logo/logotypo-dark-mode.png?fit=max\u0026auto=format\u0026n=xDwpktL5XMJQ4Sry\u0026q=85\u0026s=c4135bdf701b5b3b876be65fe8a9b05c","href":"https://www.hyperlocalise.com"},"favicon":"https://mintcdn.com/quietcircles/xDwpktL5XMJQ4Sry/favicon.svg?fit=max\u0026auto=format\u0026n=xDwpktL5XMJQ4Sry\u0026q=85\u0026s=153abbd13179743d2b9d32b3b514e87a","navbar":{"links":[{"href":"/","label":"Platform"},{"href":"/cli","label":"CLI"}],"primary":{"type":"button","label":"Open Hyperlocalise","href":"https://www.hyperlocalise.com"}},"footer":{"socials":{"website":"https://www.hyperlocalise.com","github":"https://github.com/hyperlocalise/hyperlocalise","linkedin":"https://www.linkedin.com/company/hyperlocalise"},"links":[{"header":"Product","items":[{"label":"Platform","href":"https://www.hyperlocalise.com"},{"label":"Pricing","href":"https://www.hyperlocalise.com/en/pricing"},{"label":"CLI","href":"/cli"}]},{"header":"Company","items":[{"label":"Privacy","href":"https://www.hyperlocalise.com/en/privacy"},{"label":"Trust Center","href":"https://app.aus.vanta.com/hyperlocalise.com/trust/su9x7fcjfa8q700wu9pt2u"},{"label":"Status","href":"https://status.hyperlocalise.com/"}]}]},"search":{"prompt":"Search Platform and CLI docs"},"seo":{"metatags":{"og:site_name":"Hyperlocalise Docs","twitter:card":"summary_large_image","og:image":"https://www.hyperlocalise.com/en/opengraph-image"},"organization":{"id":"https://www.hyperlocalise.com/#organization","name":"Hyperlocalise","legalName":"Hyperlocalise Pty Ltd","url":"https://www.hyperlocalise.com","logo":"https://www.hyperlocalise.com/images/logo/logomark-dark-mode.svg","sameAs":["https://www.linkedin.com/company/hyperlocalise/","https://github.com/hyperlocalise/hyperlocalise"]},"indexing":"navigable"},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/hyperlocalise/hyperlocalise"},{"anchor":"Issues","icon":"circle-exclamation","href":"https://github.com/hyperlocalise/hyperlocalise/issues"}]},"languages":[{"language":"en","href":""},{"language":"zh","href":"zh-CN"},{"language":"vi","href":"vi-VN"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"quietcircles","hasAudioNarration":false,"actualSubdomain":"quietcircles","customDomains":["hyperlocalise.dev"],"gitSource":{"type":"github","owner":"hyperlocalise","repo":"hyperlocalise","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"issues":false,"edits":false,"thumbs":true},"entitlements":{},"buildId":"6b00c950b4a16454a273ef05","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"en","tag":"CLI","count":131},{"language":"en","tag":"CLI guide","count":131},{"language":"en","tag":"Platform","count":93},{"language":"en","tag":"Platform guide","count":93},{"language":"vi","tag":"CLI","count":47},{"language":"zh","tag":"CLI","count":47},{"language":"en","tag":"File formats","count":38},{"language":"en","tag":"Integrations","count":34},{"language":"en","tag":"Developer integrations","count":24},{"language":"en","tag":"Reference","count":21},{"language":"en","tag":"Release notes","count":20},{"language":"en","tag":"Releases","count":19},{"language":"vi","tag":"Providers","count":9},{"language":"zh","tag":"Providers","count":9},{"language":"vi","tag":"Commands","count":8},{"language":"zh","tag":"Commands","count":8},{"language":"vi","tag":"TMS adapters","count":7},{"language":"zh","tag":"TMS adapters","count":7},{"language":"vi","tag":"Getting started","count":6},{"language":"zh","tag":"Getting started","count":6},{"language":"vi","tag":"Reference and concepts","count":5},{"language":"zh","tag":"Reference and concepts","count":5},{"language":"vi","tag":"Workflows","count":4},{"language":"zh","tag":"Workflows","count":4},{"language":"vi","tag":"Configuration","count":3},{"language":"vi","tag":"Troubleshooting","count":3},{"language":"vi","tag":"Contributing","count":3},{"language":"zh","tag":"Configuration","count":3},{"language":"zh","tag":"Troubleshooting","count":3},{"language":"zh","tag":"Contributing","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]){--help-nav-text: #475569;--help-nav-heading: #18242e;--help-nav-line: #e2e8f0;--help-nav-hover: #f1f5f9;--help-nav-active: #e8f3ef;--help-nav-accent: #17634f}.dark :is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]){--help-nav-text: #b5bdc4;--help-nav-heading: #edf1f3;--help-nav-line: #2c353b;--help-nav-hover: #1c252a;--help-nav-active: #1b302a;--help-nav-accent: #a0d9c0}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group{font-size:14px;line-height:22px}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group :is(a,button){min-height:32px;padding-block:5px;border-radius:6px;color:var(--help-nav-text);text-shadow:none}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group :is(a,button):hover{background:var(--help-nav-hover);color:var(--help-nav-heading)}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group button{width:100%;justify-content:space-between}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group>li[data-group-tag]{margin-block:8px}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group>li[data-group-tag]>button{font-weight:600;color:var(--help-nav-heading)}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group ul{margin-inline-start:16px;border-inline-start:1px solid var(--help-nav-line);padding-inline-start:4px}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group ul :is(a,button){padding-inline-start:12px!important}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group a[aria-current=\"page\"]{background:var(--help-nav-active);color:var(--help-nav-accent);font-weight:600}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group :is(a,button):focus-visible{outline:2px solid var(--help-nav-accent);outline-offset:-2px}@media (max-width: 1023px){#mobile-nav #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group :is(a,button){min-height:44px;align-items:center}}:is(#sidebar,#mobile-nav) #navigation-items:has([data-title=\"Project management\"],[data-title=\"Configuration\"]) .sidebar-group button svg{width:12px;height:12px;color:var(--help-nav-text)}"}]}
{"page":{"pagePath":"platform/developers/api-overview","slug":"/platform/developers/api-overview","pageMetadata":{"title":"Choose an API","sidebarTitle":"API overview","description":"Choose the API for project discovery, Queries, source files, or translation jobs.","href":"/platform/developers/api-overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Choose the API for project discovery, Queries, source files, or translation jobs.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Choose the API that serves your task. The two interfaces use different base URLs and expose different resources.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Task`}),_jsx(_components.th,{children:`Base URL`}),_jsx(_components.th,{children:`Authentication`}),_jsx(_components.th,{children:`Guide`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Upload source files, create translation jobs, download translations`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://hyperlocalise.com/api/v1`})}),_jsxs(_components.td,{children:[`Platform API key or supported personal token in `,_jsx(_components.code,{children:`x-api-key`}),`, with file/job scopes`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/platform/api`,children:`Files and jobs`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Read translation jobs`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://public-api.hyperlocalise.com/v1`})}),_jsxs(_components.td,{children:[`Personal access token in `,_jsx(_components.code,{children:`x-api-key`}),`, with `,_jsx(_components.code,{children:`jobs:read`})]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/platform/api#read-jobs`,children:`Read jobs`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Tag strings, upload screenshots, batch review, manage key jobs on native projects`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://public-api.hyperlocalise.com/v1`})}),_jsxs(_components.td,{children:[`Personal access token in `,_jsx(_components.code,{children:`x-api-key`}),`, with `,_jsx(_components.code,{children:`strings:read`}),` / `,_jsx(_components.code,{children:`strings:write`}),`, `,_jsx(_components.code,{children:`translations:approve`}),`, or `,_jsx(_components.code,{children:`jobs:write`}),` as needed`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/platform/developers/strings-and-key-jobs`,children:`Strings and key jobs`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Read your identity, accessible projects, and Queries`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://public-api.hyperlocalise.com/v1`})}),_jsxs(_components.td,{children:[`Personal access token in `,_jsx(_components.code,{children:`x-api-key`}),`, with the required effective permissions`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/platform/developers/projects-and-queries`,children:`Projects and Queries`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Register job-change webhook endpoints`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`https://public-api.hyperlocalise.com/v1`})}),_jsxs(_components.td,{children:[`Personal access token in `,_jsx(_components.code,{children:`x-api-key`}),`, with `,_jsx(_components.code,{children:`jobs:read`}),` / `,_jsx(_components.code,{children:`jobs:write`}),`, as an admin or localization manager`]}),_jsx(_components.td,{children:_jsx(_components.a,{href:`/platform/developers/webhooks`,children:`Webhooks`})})]})]})]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.a,{href:`/platform/cli`,children:`CLI Platform sync`}),` uses the files and jobs API. Keep its `,_jsx(_components.code,{children:`api_base_url`}),` at `,_jsx(_components.code,{children:`https://hyperlocalise.com/api`}),` unless you are using a separately configured environment. Do not replace it with the public API host.`]}),`\n`,_jsx(Heading,{level:`2`,id:`choose-credentials`,children:`Choose credentials`}),`\n`,_jsxs(_components.p,{children:[`Use workspace `,_jsx(_components.strong,{children:`Settings`}),` to create the `,_jsx(_components.a,{href:`/platform/settings`,children:`API key or personal token`}),` required by your integration. Store its value in your environment or CI secret manager.`]}),`\n`,_jsx(_components.p,{children:`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.`}),`\n`,_jsx(Heading,{level:`2`,id:`verify-the-connection`,children:`Verify the connection`}),`\n`,_jsxs(_components.p,{children:[`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 `,_jsx(_components.a,{href:`/platform/api`,children:`Files and jobs`}),`, using one source file and one target locale.`]}),`\n`,_jsxs(_components.p,{children:[`Keep the host, resource, HTTP status, and error code when investigating a failure. For an access problem, check `,_jsx(_components.a,{href:`/platform/workspace/roles`,children:`roles and permissions`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`next`,children:`Next`}),`\n`,_jsxs(_components.p,{children:[`Connect an AI agent through `,_jsx(_components.a,{href:`/platform/mcp`,children:`MCP`}),` if you want tool-based access instead of writing HTTP requests.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Choose an API","sidebarTitle":"API overview","description":"Choose the API for project discovery, Queries, source files, or translation jobs.","href":"/platform/developers/api-overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Choose credentials","slug":"choose-credentials","depth":2,"children":[]},{"title":"Verify the connection","slug":"verify-the-connection","depth":2,"children":[]},{"title":"Next","slug":"next","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"quietcircles","siteName":"Hyperlocalise","title":"Choose an API - Hyperlocalise","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/platform/developers/api-overview","matchLevel":0},"zh":{"href":"/zh-CN","matchLevel":4},"vi":{"href":"/vi-VN","matchLevel":4}}},"lastModified":"2026-11-12T21:24:05.951Z","originalFileLocation":"platform/developers/api-overview.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Choose the API for project discovery, Queries, source files, or translation jobs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperlocalise\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Choose an API - Hyperlocalise\">\u003cmeta data-mint-head property=\"og:description\" content=\"Choose the API for project discovery, Queries, source files, or translation jobs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperlocalise Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://hyperlocalise.dev/platform/developers/api-overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.hyperlocalise.com/en/opengraph-image\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Choose an API - Hyperlocalise\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Choose the API for project discovery, Queries, source files, or translation jobs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.hyperlocalise.com/en/opengraph-image\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/quietcircles/1yzlBwttUHVM8B2H/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperlocalise\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0f766e\">\u003clink data-mint-head rel=\"canonical\" href=\"https://hyperlocalise.dev/platform/developers/api-overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform/developers/api-overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.hyperlocalise.com/#organization\",\"name\":\"Hyperlocalise\",\"legalName\":\"Hyperlocalise Pty Ltd\",\"url\":\"https://www.hyperlocalise.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.hyperlocalise.com/images/logo/logomark-dark-mode.svg\"},\"sameAs\":[\"https://www.linkedin.com/company/hyperlocalise/\",\"https://github.com/hyperlocalise/hyperlocalise\"]},{\"@type\":\"WebSite\",\"@id\":\"https://hyperlocalise.dev#website\",\"name\":\"Hyperlocalise\",\"url\":\"https://hyperlocalise.dev\",\"publisher\":{\"@id\":\"https://www.hyperlocalise.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://hyperlocalise.dev/platform/developers/api-overview#webpage\",\"url\":\"https://hyperlocalise.dev/platform/developers/api-overview\",\"name\":\"Choose an API\",\"description\":\"Choose the API for project discovery, Queries, source files, or translation jobs.\",\"dateModified\":\"2026-11-12T21:24:05.951Z\",\"isPartOf\":{\"@id\":\"https://hyperlocalise.dev#website\"},\"breadcrumb\":{\"@id\":\"https://hyperlocalise.dev/platform/developers/api-overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://hyperlocalise.dev/platform/developers/api-overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform guide\",\"item\":\"https://hyperlocalise.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Developer integrations\",\"item\":\"https://hyperlocalise.dev/platform/developers/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Choose an API\",\"item\":\"https://hyperlocalise.dev/platform/developers/api-overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://hyperlocalise.dev/platform/developers/api-overview#article\",\"headline\":\"Choose an API\",\"name\":\"Choose an API\",\"description\":\"Choose the API for project discovery, Queries, source files, or translation jobs.\",\"url\":\"https://hyperlocalise.dev/platform/developers/api-overview\",\"mainEntityOfPage\":{\"@id\":\"https://hyperlocalise.dev/platform/developers/api-overview#webpage\"},\"image\":\"https://www.hyperlocalise.com/en/opengraph-image\",\"dateModified\":\"2026-11-12T21:24:05.951Z\",\"publisher\":{\"@id\":\"https://www.hyperlocalise.com/#organization\"},\"isPartOf\":{\"@id\":\"https://hyperlocalise.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperlocalise\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperlocalise\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform/developers/api-overview.md","siteName":"Hyperlocalise","nav":{"global":{"anchors":[{"anchor":"GitHub","icon":"github","href":"https://github.com/hyperlocalise/hyperlocalise"},{"anchor":"Issues","icon":"circle-exclamation","href":"https://github.com/hyperlocalise/hyperlocalise/issues"}]},"languages":[{"language":"en","products":[{"product":"Platform","icon":"cloud","description":"Customer guides for translation, review, automation, and workspace management.","groups":[{"group":"Platform guide","pages":[{"group":"Getting started","expanded":true,"pages":[{"title":"Hyperlocalise Platform: multilingual content operations","sidebarTitle":"Introduction","href":""},{"title":"For localization managers","sidebarTitle":"For managers","href":"/platform/getting-started/managers"},{"title":"For translators and reviewers","sidebarTitle":"For translators and reviewers","href":"/platform/getting-started/translators"},{"title":"For developers","href":"/platform/getting-started/developers"},{"title":"Your first translation","href":"/platform/getting-started"},{"title":"Supported file formats in Hyperlocalise Platform","sidebarTitle":"Supported formats","href":"/platform/file-formats"},{"title":"Moving to Hyperlocalise","href":"/platform/getting-started/moving-to-hyperlocalise"}]},{"group":"Translation process","expanded":false,"pages":[{"title":"Choose a translation workflow","sidebarTitle":"Translation workflows","href":"/platform/translation/workflows"},{"title":"Start a translation","href":"/platform/translation/start"},{"title":"Review translations","href":"/platform/cat"},{"title":"Merge strings","sidebarTitle":"Merge strings","href":"/platform/translation/merge-strings"},{"title":"Track and recover jobs","sidebarTitle":"Jobs and recovery","href":"/platform/translation/jobs"},{"title":"Resolve translation issues","sidebarTitle":"Translation issues","href":"/platform/translation/issues"}]},{"group":"Project management","expanded":false,"pages":[{"title":"Create a project","href":"/platform/projects/create-project"},{"title":"Start projects from templates","sidebarTitle":"Project templates","href":"/platform/projects/templates"},{"title":"Manage project settings","sidebarTitle":"Project settings","href":"/platform/projects/settings"},{"title":"Manage project languages","sidebarTitle":"Languages","href":"/platform/projects/languages"},{"group":"Sources","expanded":false,"pages":[{"title":"Upload and organize source files","sidebarTitle":"Upload source files","href":"/platform/projects/files"},{"title":"Native version branches","sidebarTitle":"Version branches","href":"/platform/projects/branches"},{"title":"Update source content safely","sidebarTitle":"Update source content","href":"/platform/guides/update-source-content"}]},{"group":"Translations","expanded":false,"pages":[{"title":"Download translated files","href":"/platform/translation/download"},{"title":"Prepare a review handoff","sidebarTitle":"Export segments for review","href":"/platform/guides/review-handoff"},{"title":"Import existing translations","href":"/platform/translation/import"}]},{"title":"Manage project access","sidebarTitle":"Project access","href":"/platform/projects/access"}]},{"group":"Language resources","expanded":false,"pages":[{"title":"Language resources","href":"/platform/knowledge"},{"title":"Add translation guidelines","href":"/platform/knowledge/guidelines"},{"title":"Glossary import and export","href":"/platform/glossary-import-export"},{"title":"Translation memory import and export","href":"/platform/translation-memory-import-export"}]},{"group":"Automations","expanded":false,"pages":[{"title":"Automate your work","href":"/platform/automations"},{"title":"Create a translation automation","href":"/platform/automation/create-automation"},{"title":"Sync content with a repository","href":"/platform/automation/content-sync"},{"title":"Visual workflows","href":"/platform/visual-workflows"},{"title":"Build reliable workflow branches and retries","href":"/platform/guides/workflow-data-and-retries"},{"title":"Fix automation and sync problems","href":"/platform/help/automations"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Connect your tools","href":"/platform/integrations"},{"title":"TMS-agnostic localization with Hyperlocalise Platform","sidebarTitle":"TMS integrations","href":"/platform/tms"},{"title":"Connect GitHub","href":"/platform/connections/github"},{"title":"Localize Intercom Help Center articles","href":"/platform/connections/intercom"},{"title":"Localize Sanity documents (automation)","href":"/platform/connections/sanity"},{"title":"Localize Sanity Studio documents","href":"/platform/connections/sanity-studio-plugin"},{"title":"Localize Webflow CMS items (automation)","href":"/platform/connections/webflow"},{"title":"Localize Braze","href":"/platform/connections/braze"},{"title":"Localize Customer.io","href":"/platform/connections/customer-io"},{"title":"Localize Iterable","href":"/platform/connections/iterable"},{"title":"Localize Loops","href":"/platform/connections/loops"},{"title":"Localize HubSpot","href":"/platform/connections/hubspot"},{"title":"Localize Mailchimp","href":"/platform/connections/mailchimp"},{"title":"Localize Canva","href":"/platform/connections/canva"},{"title":"Localize Figma","href":"/platform/connections/figma"},{"title":"Connect design tools","href":"/platform/connections/design-tools"}]},{"group":"Developer integrations","expanded":false,"pages":[{"title":"Developer integrations","href":"/platform/developers/overview"},{"title":"Connect the CLI","description":"Connect git and CI to Hyperlocalise Platform with an API key.","href":"/platform/cli"},{"title":"Choose an API","sidebarTitle":"API overview","href":"/platform/developers/api-overview"},{"title":"Files and translation jobs API","sidebarTitle":"Files and jobs","description":"HTTP API for the same multilingual content operations pipeline the CLI uses.","href":"/platform/api"},{"title":"Projects and Queries API","href":"/platform/developers/projects-and-queries"},{"title":"Custom fields API","sidebarTitle":"Custom fields","href":"/platform/developers/custom-fields"},{"title":"Strings, screenshots, and key jobs API","sidebarTitle":"Strings and key jobs","href":"/platform/developers/strings-and-key-jobs"},{"title":"MCP server","href":"/platform/mcp"},{"title":"MCP tool reference","href":"/platform/developers/mcp-tools"},{"title":"Job webhooks","sidebarTitle":"Webhooks","href":"/platform/developers/webhooks"},{"title":"CDN distributions","sidebarTitle":"CDN distributions","href":"/platform/developers/cdn-distributions"},{"group":"Framework and repository guides","pages":[{"title":"GitHub localisation workflow","href":"/platform/tutorials/github-localisation-workflow"},{"title":"React Intl and ICU","href":"/platform/tutorials/react-intl-icu"},{"title":"Vue and vue-i18n","href":"/platform/tutorials/vue-i18n"},{"title":"i18next and interpolation placeholders","href":"/platform/tutorials/i18next"},{"title":"next-intl and ICU messages","href":"/platform/tutorials/next-intl"},{"title":"iOS Strings","href":"/platform/tutorials/ios-strings"},{"title":"Android string resources","href":"/platform/tutorials/android-string-resources"},{"title":"Flutter ARB","href":"/platform/tutorials/flutter-arb"},{"title":"Gettext POT and PO","href":"/platform/tutorials/gettext-pot-po"},{"title":"Fluent localization","href":"/platform/tutorials/fluent"},{"title":"XLIFF","href":"/platform/tutorials/xliff"},{"title":"Qt Linguist TS","href":"/platform/tutorials/qt-linguist"},{"title":".NET RESX","href":"/platform/tutorials/dotnet-resx"}]}]},{"group":"Website and market research","expanded":false,"pages":[{"title":"About Domains","href":"/platform/domains"},{"title":"Tutorial: from audit to verified domain","href":"/platform/research/audit-to-domain-tutorial"},{"title":"Verify a website domain","href":"/platform/research/verify-domain"},{"title":"Research keywords and track rankings","href":"/platform/research/keywords-and-ranks"},{"title":"About the localisation audit","href":"/platform/research/localisation-audit"},{"title":"Localisation audit checks","href":"/platform/research/localisation-audit-checks"}]},{"group":"Workspace and account","expanded":false,"pages":[{"title":"Workspace administration","href":"/platform/settings"},{"title":"Invite teammates and manage access","href":"/platform/workspace/members"},{"title":"Roles and permissions","href":"/platform/workspace/roles"},{"title":"Reports","href":"/platform/workspace/reports"},{"title":"Manage billing and usage","href":"/platform/workspace/billing"}]},{"group":"Troubleshooting and support","expanded":false,"pages":[{"title":"Troubleshooting and support","href":"/platform/help/overview"},{"title":"Fix upload and file problems","href":"/platform/help/uploads"},{"title":"Fix failed or missing translations","href":"/platform/help/translation-failures"},{"title":"Improve translation quality","href":"/platform/help/quality"},{"title":"Fix connection and token problems","href":"/platform/help/connections"},{"title":"Fix workspace and project access","href":"/platform/help/access"},{"title":"Contact support","href":"/platform/help/contact-support"}]},{"group":"Release notes","expanded":false,"pages":[{"title":"Release notes","href":"/platform/release-notes"}]}]}]},{"product":"CLI","icon":"terminal","description":"Local generation, CI, and sync with Platform or a TMS","pages":[{"title":"CLI","href":"/cli"}]}]},{"language":"zh","pages":[{"title":"zh","href":"/zh-CN"}]},{"language":"vi","pages":[{"title":"vi","href":"/vi-VN"}]}]},"basePath":"","title":"Choose an API - Hyperlocalise","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}