---
title: Visão geral da API
description: Os endpoints do Human Plugin, como se relacionam, as regras comuns de resposta e o que a API não oferece.
canonical: https://developer.unico.io/pt-BR/human-plugin/api-reference/overview
locale: pt-BR
generated_by: markdown-export
---

# Visão geral da API

Três endpoints de processo e duas sondas de saúde.

O Human Plugin é servido em HTTP simples na porta que você configurar (padrão `8080`). A URL base é o lugar onde você expõe o container dentro da sua rede, por exemplo `http://human-plugin.internal:8080`.

| Método | Caminho | Finalidade |
| --- | --- | --- |
| `POST` | `/v1/processes` | [Criar um processo](/pt-BR/human-plugin/api-reference/create-process), com um dos [fluxos](/pt-BR/human-plugin/api-reference/create-process#flows) |
| `GET` | `/v1/processes/{id}` | [Consultar um processo](/pt-BR/human-plugin/api-reference/get-process) |
| `GET` | `/v1/processes/{id}/selfie` | [Consultar a selfie](/pt-BR/human-plugin/api-reference/get-selfie) |
| `GET` | `/health/live` | Verificação de que o serviço está ativo. Veja [Saúde e monitoramento](/pt-BR/human-plugin/self-hosting/health-and-monitoring) |
| `GET` | `/health/ready` | Prontidão (ping no banco de dados) |

Não há endpoint para listar, excluir ou pesquisar processos, nem receptor de webhook.

## Regras que valem para toda chamada

- **Sem header de autenticação.** O Human Plugin não valida os chamadores. Restrinja o acesso pela rede: veja [Rede e segurança](/pt-BR/human-plugin/self-hosting/networking-and-security).
- **Somente JSON**, com nomes de campo em camelCase.
- **As respostas têm `Cache-Control: no-store`.**
- **Os erros** usam um único envelope, `{"message": "INVALID_REQUEST", "details": []}`. Veja [Erros e novas tentativas](/pt-BR/human-plugin/api-reference/errors-and-retries).
- **`id` é o id de processo do Human Plugin.** Guarde-o a partir da criação: é por ele que você consulta o processo depois.

## Sequência típica

```mermaid
sequenceDiagram
  participant B as Your back-end
  participant H as Human Plugin
  B->>H: POST /v1/processes
  H-->>B: 201 + id, state, data
  B->>H: GET /v1/processes/{id}
  H-->>B: 200 + id, state, data (humanToken, ndocs)
```

Próximo passo: [Criar um processo](/pt-BR/human-plugin/api-reference/create-process).