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

# Introdução

> Referência completa dos endpoints da API do Juridiq.

# API Reference

A API do Juridiq é organizada em endpoints REST e utiliza JSON para requisições e respostas.

Nesta seção você encontrará todos os endpoints disponíveis da plataforma, incluindo exemplos de requisição, parâmetros, respostas e possíveis erros.

<Info>
  Todos os endpoints autenticados exigem o header `x-juridiq-api-key`.
</Info>

## Base URL

```bash theme={null}
https://api.juridiq.com.br
```

## Como utilizar a referência

<Steps>
  <Step title="Escolha um endpoint">
    Navegue pelas categorias disponíveis na barra lateral.
  </Step>

  <Step title="Analise os parâmetros">
    Veja quais campos são obrigatórios e opcionais.
  </Step>

  <Step title="Teste a requisição">
    Utilize os exemplos disponíveis em diferentes linguagens.
  </Step>

  <Step title="Interprete a resposta">
    Consulte exemplos de retorno e possíveis erros.
  </Step>
</Steps>

## Alguns recursos disponíveis

<CardGroup cols={2}>
  <Card title="Usuários" icon="users">
    Gerenciamento de usuários e autenticação.
  </Card>

  <Card title="Contatos" icon="address-book">
    Cadastro e gerenciamento de contatos.
  </Card>

  <Card title="Conversas" icon="messages">
    Operações relacionadas a mensagens e atendimentos.
  </Card>

  <Card title="Webhooks" icon="webhook">
    Configuração e gerenciamento de eventos.
  </Card>

  <Card title="Automação" icon="bolt">
    Fluxos automatizados e integrações.
  </Card>

  <Card title="IA Jurídica" icon="brain">
    Recursos inteligentes da plataforma.
  </Card>
</CardGroup>

## Autenticação

Exemplo de envio da API Key:

```http theme={null}
x-juridiq-api-key: SUA_API_KEY
```

<Warning>
  Nunca exponha sua API Key no frontend ou em aplicações públicas.
</Warning>