function getRequestBodyExample (bodySchema, details, components) { if (!bodySchema) return undefined if (bodySchema.$ref) bodySchema = resolveSchema(bodySchema, components) if (details && details.requestBody && details.requestBody.content && details.requestBody.content['application\/json']) if (bodySchema.example !== undefined) return bodySchema.example if (bodySchema.examples && typeof bodySchema.examples === 'object') if (bodySchema.type === 'array' && bodySchema.items) if (bodySchema.type === 'object' || bodySchema.properties) if (bodySchema.type === 'string') return '' if (bodySchema.type === 'boolean') return false if (bodySchema.type === 'integer' || bodySchema.type === 'number') return 0 return } function resolveSchema (schema, components) function MarkdownRenderer ( ) function capitalizeTagName (name) const [tryItCollapsed, setTryItCollapsed] = useState( ) const toggleTryItCollapsed = (key) => const = useData() const [liveSpec, setLiveSpec] = useState(spec) const [globalApiKey, setGlobalApiKey] = useState('') useEffect(() => , [spec, specUrl]) const tagMap = React.useMemo(() => { const map = if (liveSpec.tags && liveSpec.paths) { liveSpec.tags.forEach(tag => ) const listedRoutes = new Set() Object.entries(liveSpec.paths).forEach(([path, methods]) => { Object.entries(methods).forEach(([method, details]) => { const routeKey = method + ' ' + path for (const tag of details.tags || []) }) }) } return map }, [liveSpec]) const [expanded, setExpanded] = useState( ) const toggleExpand = (key) => useEffect(() => { if (typeof window === 'undefined') return function expandFromHash () { const hash = window.location.hash?.replace(\/^#\/, '') if (!hash) return const allEndpoints = [] if (liveSpec.tags && liveSpec.tags.length && tagMap) { liveSpec.tags.forEach(tag => ) } const match = allEndpoints.find(e => e.anchorId.toLowerCase() === hash.toLowerCase()) if (match) } expandFromHash() window.addEventListener('hashchange', expandFromHash) return () => window.removeEventListener('hashchange', expandFromHash) }, [liveSpec, tagMap]) const [tryItState, setTryItState] = useState( ) const handleTryItChange = (key, field, value) => const cdnDomains = [ , ] const [globalDomain, setGlobalDomain] = useState(cdnDomains[1].value) function buildPath (path, paramValues) { let out = path Object.entries(paramValues || ).forEach(([k, v]) => ) return out } const methodColor = method => function endpointRequiresAuth (details) function buildCurlCommand ( ) { const state = tryState || const verb = (method || 'GET').toUpperCase() const cmd = [`curl -X $ `] const escapeSingleQuotes = (s) => String(s).replace(\/'\/g, "'\\''") if (requiresAuth) let bodyText = null if (bodySchema) { cmd.push('-H \'Content-Type: application\/json\'') if (typeof state.body === 'string' && state.body.trim() !== '') else } if (bodyText != null) cmd.push(`'$ '`) return cmd.join(' \\\n ') } return ( <> API Getting Started You can use the API directly via HTTPS requests, or with our Command Line tool and locizer module . The API supports both public and private (API-key protected) endpoints. Depending on your CDN type , the API domain may differ. Tip: Store your API keys securely and never expose write keys in client-side code or public repositories. Main Capabilities Fetch translations for any namespace, version, and language Fetch available languages for a project Report missing or used translations (for development workflows) Update or remove translations in bulk Add context or tags to translations Usage Notes All endpoints use standard HTTP verbs (GET, POST, etc). Most endpoints require your projectId (and sometimes an API key). For large updates, batch your requests (max 1000 keys per request). For production, use only read endpoints or API keys with limited permissions. See the Going to production guide for best practices. API Endpoint Explorer Browse all available endpoints grouped by category. Click an endpoint for details and usage examples. Domain: 🌐 Applies to all endpoints Global API Key: 🔒 Used for all endpoints that require authorization {liveSpec.tags && liveSpec.tags.map(tag => ( {tagMap[tag.name]?.map(( ) => { const key = method + ' ' + path const isExpanded = expanded[key] const summary = details.summary || `$ $ ` const anchorId = summary.toLowerCase().replace(\/\s+\/g, '-').replace(\/[^a-zA-Z0-9-]\/g, '') const params = (details.parameters || []).filter(p => p.in === 'path' || p.in === 'query').sort((a, b) => ) let bodySchema = details.requestBody?.content?.['application\/json']?.schema bodySchema = resolveSchema(bodySchema, liveSpec.components) const tryState = tryItState[key] || const domain = globalDomain const paramValues = params.reduce((acc, p) => ( ), ) const url = domain + buildPath(path, paramValues) async function handleTryIt (e) { e.preventDefault() setTryItState(s => ( )) const reqUrl = url const options = if (bodySchema && tryState.body) const apiKeyToUse = tryState.apiKey || globalApiKey if (apiKeyToUse) try catch (err) } const requiresAuth = endpointRequiresAuth(details) return ( {isExpanded && ( Parameters: {params.length > 0 && ( {params.map(p => { const schema = p.schema || let descriptions = [] if (schema.oneOf && Array.isArray(schema.oneOf)) if (schema.anyOf && Array.isArray(schema.anyOf)) if (schema.allOf && Array.isArray(schema.allOf)) if (p.description) descriptions = [...new Set(descriptions)] if (p.name === 'projectId' && descriptions.length === 0) return ( ( ) {descriptions.length > 1 && ( )} ) })} )} Responses: {details.responses && Object.entries(details.responses).map(([code, resp]) => { let example = null let contentType = null const contentTypes = resp.content ? Object.keys(resp.content) : [] if (contentTypes.length > 0) return ( : {contentTypes.length > 0 && ( Content type: )} ) })} Try it out {!!tryItCollapsed[key] && ( {params.length > 0 && ( {[...params].sort((a, b) => ).map(p => { let example = p.example if (example === undefined && p.schema) { if (p.schema.example !== undefined) else if (p.schema.$ref && liveSpec.components && liveSpec.components.schemas) } const placeholder = example !== undefined && example !== '' ? example : (p.description || '') const type = p.schema?.type || p.type || 'string' const required = !!p.required return ( : ) })} )} {bodySchema && ( Body (JSON): {(() => )()} )} Request: Curl: )} )} ) })} ))} ) } ..\/..\/..\/..\/components\/Code.jsx react vike-react\/useData react-markdown remark-gfm ..\/..\/..\/..\/src\/useMDXComponents.jsx application\/json application\/json object object value object object object value object array object property1 value object property1 string boolean integer number value object prose max-w-none cdn CDN undefined - smooth start hashchange hashchange Standard CDN (api.lite.locize.app) https:\/\/api.lite.locize.app Pro CDN (api.locize.app) https:\/\/api.locize.app GET #27ae60 POST #2980ef PUT #f39c12 DELETE #e74c3c PATCH #8e44ad #888 GET \/g, " YOUR_API_KEY Authorization: Bearer ${escapeSingleQuotes(apiKeyToUse)} -H \'Content-Type: application\/json\' string undefined { "key": "value" } CURL_JSON_EOF ${escapeSingleQuotes(url)} ${delim} \\\n ${escapeSingleQuotes(url)} \\\n mb-6 text-4xl font-bold tracking-tight text-base-content mb-3 text-3xl font-bold tracking-tight text-base-content list-disc pl-6 https:\/\/github.com\/locize\/locize-cli _blank noopener noreferrer https:\/\/github.com\/locize\/locizer _blank noopener noreferrer \/docs\/integration\/cdn-types-standard-vs-pro docs-callout mt-4 mb-3 text-3xl font-bold tracking-tight text-base-content list-disc pl-6 mb-3 text-3xl font-bold tracking-tight text-base-content list-disc pl-6 \/docs\/guides\/going-to-production my-8 border-base-200 mb-3 text-3xl font-bold tracking-tight text-base-content mb-4 text-base-content\/80 my-4 p-3 bg-base-200\/60 rounded flex items-center gap-3 font-medium min-w-fit w-80 px-3 py-2 rounded border border-base-300 text-base font-normal bg-white text-base-content\/60 text-sm ml-2 my-4 p-3 bg-base-200\/60 rounded flex items-center gap-3 font-medium min-w-fit text Bearer API Key (applies to all endpoints) w-80 px-3 py-2 rounded border border-base-300 text-base font-normal bg-white text-base-content\/60 text-sm ml-2 mb-12 - mb-2 text-2xl font-semibold text-base-content text-base-content\/70 mb-2 pl-0 list-none - path query path path application\/json Content-Type application\/json Authorization Bearer content-type text\/html border-blue-600 bg-blue-50\/60 shadow-lg border-base-200 bg-white shadow border-blue-200 bg-blue-50\/80 border-base-200 bg-base-100\/80 font-bold font-mono text-sm rounded-lg px-4 py-1 bg-white border-2 mr-2 shadow-sm center font-mono text-sm text-sm-content flex-1 Requires authorization ml-2 text-orange-500 text-xl align-middle text-blue-600 text-base-content\/40 ▼ ▶ px-6 pb-4 pt-1 mt-2 mb-1 text-lg font-bold text-slate-800 tracking-tight bg-none border-none bg-blue-50\/40 rounded-b-2xl px-6 pb-6 pt-2 border-t-0 mb-4 text-sm-content\/80 #888 projectId #888 * #888 #888 * #888 #888 #f8f8f8 #888 #f8f8f8 auto object mt-6 bg-blue-50\/60 rounded-xl p-0 shadow border border-blue-100 flex items-center justify-between cursor-pointer px-6 py-4 select-none none 1px solid #cce3fa text-lg font-bold text-blue-700 #2980ef ▶ ▼ px-6 pb-6 pt-2 mb-4 space-y-3 path path string flex items-center gap-3 min-w-[140px] font-medium text-red-600 text-gray-800 ml-1 text w-90 px-3 py-2 rounded border border-red-400 bg-red-50 border-gray-300 bg-white text-base focus:outline-none focus:ring-2 focus:ring-blue-300 text-xs font-mono text-blue-600 ml-2 text-xs text-gray-500 ml-2 font-mono mb-4 flex items-start gap-4 min-w-[140px] font-medium mt-1 { "key": "value" } body w-full px-3 py-2 rounded border border-gray-300 font-mono text-base bg-white focus:outline-none focus:ring-2 focus:ring-blue-300 submit mt-2 bg-blue-600 hover:bg-blue-700 text-white font-bold py-3 px-8 rounded-lg shadow transition disabled:bg-blue-300 disabled:cursor-not-allowed text-lg Loading... Send mt-8 text-gray-500 text-base mb-2 font-mono text-gray-800 font-semibold mb-2 text-sm text-gray-600 text-green-600 text-red-600 ml-4 text-gray-400 mt-6 bg-gray-50 p-4 rounded-lg text-base mt-2 1px solid #eee HTML Response 100% none white allow-scripts allow-same-origin mt-6 bg-gray-100 p-4 rounded-lg text-base mt-2 font-mono whitespace-pre break-all text-red-600 mt-4 font-semibold relative w-full text-gray-500 text-base mt-3 bash const anchorId = summary.replace(\/\s+\/g, '-').replace(\/[^a-zA-Z0-9-]\/g, '') allEndpoints.push({ key: method + ' ' + path, anchorId }) }) }) } const match = allEndpoints.find(e => e.anchorId.toLowerCase() === hash.toLowerCase()) if (match) { setExpanded(e => ({ ...e, [match.key]: true })) setTimeout(() => { const el = document.getElementById(match.anchorId) if (el) el.scrollIntoView({ behavior: 'smooth', block: 'start' }) }, 100) } } expandFromHash() window.addEventListener('hashchange', expandFromHash) return () => window.removeEventListener('hashchange', expandFromHash) }, [liveSpec, tagMap]) \/\/ Try-it-out state: per endpoint const [tryItState, setTryItState] = useState({}) const handleTryItChange = (key, field, value) => { setTryItState(s => ({ ...s, [key]: { ...s[key], [field]: value } })) } \/\/ Domains for CDN const cdnDomains = [ { label: 'Standard CDN (api.lite.locize.app)', value: 'https:\/\/api.lite.locize.app' }, { label: 'Pro CDN (api.locize.app)', value: 'https:\/\/api.locize.app' } ] \/\/ Global domain state const [globalDomain, setGlobalDomain] = useState(cdnDomains[1].value) \/\/ Helper to build a path with parameter values function buildPath (path, paramValues) { let out = path Object.entries(paramValues || {}).forEach(([k, v]) => { out = out.replace( , v || ) }) return out } \/\/ Method color const methodColor = method => { switch (method.toUpperCase()) { case 'GET': return '#27ae60' case 'POST': return '#2980ef' case 'PUT': return '#f39c12' case 'DELETE': return '#e74c3c' case 'PATCH': return '#8e44ad' default: return '#888' } } \/\/ Helper: does endpoint require auth? function endpointRequiresAuth (details) { if (details.security && details.security.length === 0) return false if (liveSpec.security && liveSpec.security.length === 0) return false return true } \/\/ Helper to build curl command preview function buildCurlCommand ({ method, url, tryState, bodySchema, requiresAuth, globalApiKey, details }) { const state = tryState || {} const verb = (method || 'GET').toUpperCase() const cmd = [ ] \/\/ small helper: escape single quotes for header and url quoting const escapeSingleQuotes = (s) => String(s).replace(\/'\/g, "'\\''") \/\/ -- AUTH header (always show if required) if (requiresAuth) { const apiKeyToUse = state.apiKey || globalApiKey || 'YOUR_API_KEY' cmd.push( ) } \/\/ If there's a body schema we will include Content-Type and body let bodyText = null if (bodySchema) { cmd.push('-H \'Content-Type: application\/json\'') \/\/ choose body: provided -> example from spec -> fallback if (typeof state.body === 'string' && state.body.trim() !== '') { bodyText = state.body } else { try { const example = getRequestBodyExample(bodySchema, details, (typeof liveSpec !== 'undefined' && liveSpec) ? liveSpec.components : undefined) bodyText = JSON.stringify(example ?? {}, null, 2) \/\/ eslint-disable-next-line no-unused-vars } catch (e) { bodyText = '{ "key": "value" }' } } } \/\/ append URL and body handling (heredoc preferred for safety) if (bodyText != null) { \/\/ generate a delimiter that's not present in the body const delimBase = 'CURL_JSON_EOF' let delim = delimBase let attempt = 0 while (bodyText.indexOf(delim) !== -1 && attempt < 20) { attempt += 1 delim = } \/\/ use a quoted heredoc so the shell won't expand variables inside the JSON \/\/ place the heredoc token as part of the curl args; URL comes before it for clarity cmd.push( ) cmd.push( ) const cmdPrefix = cmd.join(' \\\n ') return } \/\/ no body case: just URL cmd.push( ) return cmd.join(' \\\n ') } return ( <>

{details.summary ? details.summary :

Main Capabilities<\/h2> Fetch translations for any namespace, version, and language<\/li> Fetch available languages for a project<\/li> Report missing or used translations (for development workflows)<\/li> Update or remove translations in bulk<\/li>

{details.summary ? details.summary :

Migrating from ...