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

# Início rápido da API

> Crie uma chave de API e faça sua primeira solicitação à API da Ciarem.

A API da Ciarem permite conectar a Ciarem aos seus próprios sistemas: sincronizar contatos, gerenciar suas propriedades de CRM e etapas do funil, e ler conversas de forma programática. Está disponível no plano **Scale**, e durante o **teste gratuito** para você experimentar antes de pagar.

<Info>
  A API é um complemento, não um requisito — tudo na Ciarem funciona sem escrever código. Recorra à API quando quiser integrar a Ciarem com ferramentas que não conectamos nativamente.
</Info>

## 1. Crie uma chave de API

Você precisa ser administrador, em um plano Scale ou no teste gratuito.

<Steps>
  <Step title="Abra Chaves de API">
    No painel, acesse **Configurações** e depois **Chaves de API**.
  </Step>

  <Step title="Clique em Criar chave">
    Dê à chave um nome que diga para qual integração ela serve.
  </Step>

  <Step title="Copie o segredo">
    O segredo — começa com `oak_` — é exibido **apenas uma vez**: copie-o imediatamente e guarde-o como uma senha. Se perdê-lo, revogue a chave e crie uma nova.
  </Step>
</Steps>

## 2. Faça sua primeira solicitação

Cada solicitação se autentica com a chave como token bearer:

```bash theme={null}
curl https://api.ciarem.ai/v1/me \
  -H "Authorization: Bearer oak_SEU_SEGREDO"
```

Uma resposta bem-sucedida identifica a organização à qual a chave pertence:

```json theme={null}
{
  "org_id": "org_…",
  "name": "Sua empresa",
  "timezone": "America/Sao_Paulo",
  "language": "pt",
  "plan": "scale",
  "trial": false
}
```

## 3. Explore

* Crie e atualize **contatos**, incluindo suas propriedades personalizadas: consulte a [referência da API](/api-reference/openapi).
* Leia **conversas e mensagens** — cada mensagem informa quem falou: o campo `sender` é `contact`, `agent`, `ai` ou `system`.
* Gerencie os **metadados do CRM**: propriedades personalizadas e etapas do funil, as mesmas que sua equipe usa no painel.

Continue com [Autenticação](/pt/api-reference/authentication) e [Erros, limites e paginação](/pt/api-reference/errors-limits-pagination).