> ## Documentation Index
> Fetch the complete documentation index at: https://docs.larynth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Create an agent, test it in your browser, and give it a phone number.

This takes a few minutes. You do not need a phone number to start: you can talk to your agent in the browser first.

**1. Create an account**

[Sign up](https://app.larynth.com/signup). Every new account gets \$5 of free credit for browser and inbound test calls. Outbound calling needs business verification and a paid top-up.

**2. Create an agent**

In the [dashboard](https://app.larynth.com), create an agent. Give it a name, a greeting and instructions that say who it answers for and what it should do. Choose a language and a voice.

Write instructions the way you would brief a new front-desk hire: what the business does, what callers usually want, what to collect, and when to hand the call to a person.

**3. Test it in your browser**

Start a browser call from the agent page and talk to it. Browser calls use your free credit. If something sounds wrong, change the instructions and test again. See [Test in the browser](https://docs.larynth.com/guides/test-in-browser.md).

**4. Publish the agent**

Publishing freezes the version that callers reach. Later edits create a new draft, so a change never reaches live callers until you publish it. See [Agents](https://docs.larynth.com/concepts/agents.md).

**5. Add a phone number**

Order a US or Canadian number for \$2 per month, and point it at your agent. Or keep your current number and forward calls to the new one. See [Phone numbers](https://docs.larynth.com/concepts/phone-numbers.md) and [Forward your number](https://docs.larynth.com/guides/forward-your-number.md).

**6. Call it**

Call the number from your own phone. When the call ends, open it in the dashboard to read the transcript and the summary.

## Do the same through the API

Create an API key in the dashboard and export it. Keys look like `lx_<key_id>_<secret>`.

```bash theme={null}
export LARYNTH_API_KEY="lx_test_..."
```

Create an agent.

```bash theme={null}
curl https://api-us.larynth.com/v1/assistants \
  -H "Authorization: Bearer $LARYNTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Front desk"}'
```

The response includes the agent `id`. Create the first draft version. `mode`, `language`, `system_prompt` and `greeting_text` are required; in `cascade` mode also pass the speech, language and voice model IDs.

```bash theme={null}
curl https://api-us.larynth.com/v1/assistants/$ASSISTANT_ID/versions \
  -H "Authorization: Bearer $LARYNTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mode": "cascade", "language": "en-US", "system_prompt": "You answer calls for a dental clinic. Collect the caller name and reason for calling.", "greeting_text": "Hello, how can I help?", "stt_model_id": "'"$STT_MODEL_ID"'", "llm_model_id": "'"$LLM_MODEL_ID"'", "tts_model_id": "'"$TTS_MODEL_ID"'", "tts_voice_id": "'"$VOICE_ID"'"}'
```

The response includes the version number. Publish it.

```bash theme={null}
curl -X POST https://api-us.larynth.com/v1/assistants/$ASSISTANT_ID/versions/1/publish \
  -H "Authorization: Bearer $LARYNTH_API_KEY"
```

Search for numbers, then order one and route it to the agent.

```bash theme={null}
curl "https://api-us.larynth.com/v1/numbers/available?country=US&area_code=415&limit=5" \
  -H "Authorization: Bearer $LARYNTH_API_KEY"
```

```bash theme={null}
curl https://api-us.larynth.com/v1/numbers \
  -H "Authorization: Bearer $LARYNTH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"e164": "+14155550123", "route_type": "assistant", "assistant_id": "'"$ASSISTANT_ID"'"}'
```

Ordering is asynchronous. Poll `GET /v1/numbers/{id}` until `status` is `active`.

> [!NOTE]
>
> The numbers above are fictional. Use a number returned by the search.

## Next

> [card] [Concepts](https://docs.larynth.com/concepts/agents.md)
>
> How agents, numbers, calls and billing work.

> [card] [SDKs](https://docs.larynth.com/sdks/typescript.md)
>
> Use the TypeScript or Python SDK (0.1 beta) instead of raw HTTP.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.