# Getting Started (https://docs.hallolara.ai/docs/getting-started)

## Base URL [#base-url]

Use `https://api.hallolara.ai` as the base URL.

Append the base path of the API you are calling:

| API | Base path | Example |
|---|---|---|
| [MCP Connector](/docs/mcp) | `/mcp` | `https://api.hallolara.ai/mcp` |
| Public API | `/api/v1` | `https://api.hallolara.ai/api/v1/ping` |

## Choosing the right integration [#choosing-the-right-integration]

Hallolara exposes one AI connector and one REST API.

<Cards>
  <Card title="MCP Connector" href="/docs/mcp">
    For connecting an AI client directly to your Hallolara organization. The client discovers the available tools and can authenticate interactively with OAuth or with an organization API key.
  </Card>
  <Card title="Public API" href="/docs/public">
    For Hallolara customers automating their own organization: manage assistants and their configuration (prompts, knowledge, glossary, pronunciation, forwardings, calendars, tools), contacts, calls and recordings, website chats, and usage statistics. Keys are self-service - create them in the dashboard.
  </Card>
</Cards>

If an AI client should operate Hallolara for you, use MCP. If your own application
needs direct HTTP integration, use the Public API.

The Public API authenticates with a bearer token. MCP accepts either Public API
organization keys or OAuth. See [Authentication](/docs/authentication) for how
each credential type works.

## Making your first request [#making-your-first-request]

Get a Public API key from the dashboard under *Settings → API Keys → New key*, picking a role that matches the scope you need. Then call [`GET /ping`](/docs/public/meta/getPing) - it confirms the API is reachable and your key is valid:

```bash
curl https://api.hallolara.ai/api/v1/ping \
  -H "Authorization: Bearer <your_api_key>"
```

Success looks like:

```json
{ "data": { "ok": true, "now": "2026-04-23T00:00:00.000Z" } }
```

A `401` with `{ "error": { "code": "unauthorized", ... } }` means the key is
missing or invalid - check the header.

Responses carry `X-RateLimit-*` headers; see [Errors & Rate Limits](/docs/errors).

From here, continue with the [Public API overview](/docs/public) or jump straight to the [Public API quickstart](/docs/public/quickstart).
