Quick start
Make your first API request without a repository checkout.
You need an available MyanLex deployment, its console URL, and its API base URL
including /v1. Your deployment operator supplies these URLs.
Preview availability
The hosted service is not launched. Use an existing self-hosted deployment, or follow Self-hosting to run one. The five-minute first-request goal assumes a running deployment, not infrastructure installation.
Create your account
Register in your deployment's developer console. Follow the email verification link and sign in. If necessary, use Resend verification on Login.
Create a workspace and project
Open Projects, create a workspace, then create a project. The API calls a workspace an organization. Joining an existing workspace requires the appropriate permissions; signing in alone does not grant access to its data.
Create an API key
Open API keys, select your project and create a key with api.invoke. Save
its secret immediately in a secret manager: it is displayed only once. Creation
requires api_key.create and api.invoke.
Send a request from your server
Set MYANLEX_API_KEY securely in your terminal or server environment. Set
MYANLEX_API_URL to your deployment's API URL, including /v1, not its console
URL. Use HTTPS outside loopback. Do not enable shell tracing with real secrets.
printf 'Authorization: Bearer %s\n' "$MYANLEX_API_KEY" |
curl --silent --show-error --fail-with-body --max-time 30 \
--header @- --header 'Content-Type: application/json' \
--data '{"text":"απ"}' "$MYANLEX_API_URL/syllabify"Expected HTTP 200:
{
"input": "απ",
"profile": "burmese-orthographic-v1",
"segments": [
{ "text": "α", "start": 0, "end": 1, "kind": "burmese_syllable" },
{ "text": "π", "start": 1, "end": 2, "kind": "non_myanmar" }
]
}Keep keys server-side
Do not embed long-lived keys in browser bundles, mobile binaries,
NEXT_PUBLIC_* variables, source control or screenshots. Browser and Flutter
apps should call your authenticated backend.
Next: HTTP examples, language operations, or errors and quotas.