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

# Primeiros passos

> Fluxo mais curto para integrar com o Refy.

# Primeiros passos

O caminho mais curto para operar o Refy hoje é:

1. autenticar um usuário
2. resolver as areas de trabalho acessiveis
3. criar a primeira area de trabalho, se necessario
4. iniciar análises dentro de um projeto
5. consumir o payload agregado da pagina de analise

## 1. Autentique

Use uma destas rotas:

* `POST /v1/auth/password`
* `POST /v1/auth/federated`
* `GET /v1/auth/google/start`

Exemplo mínimo:

```json theme={null}
{
  "email": "viniciuscoimbra@gmail.com",
  "password": "secret"
}
```

## 2. Descubra o contexto do usuário

Depois da autenticação:

* `GET /v1/auth/me`

Essa rota retorna:

* usuário atual
* identidades
* areas de trabalho disponiveis

Se a lista de areas de trabalho vier vazia, o fluxo correto e seguir para o bootstrap.

## 3. Feche o onboarding

Se o usuario ainda nao tiver uma area de trabalho:

* `POST /v1/auth/bootstrap`

Esse endpoint cria de uma vez:

* perfil final
* area de trabalho
* projeto inicial
* primeira análise

Campos centrais:

* `workspaceName`
* `projectName`
* `projectDomain`
* `rawValue`
* `inputType`
* `mode`

## 4. Crie novas análises

Depois do bootstrap:

* `POST /v1/workspaces/{workspaceId}/projects/{projectId}/analyses`

Entradas suportadas hoje:

* `url`
* `text`
* `sitemap`
* `video`

Exemplo com URL:

```json theme={null}
{
  "inputType": "url",
  "inputPayload": {
    "url": "https://refy.to/blog/content-audit"
  },
  "mode": "standard"
}
```

## 5. Consuma a tela principal do produto

O endpoint mais importante para reproduzir a experiência do produto é:

* `GET /v1/workspaces/{workspaceId}/analyses/{analysisId}/page-data`

Ele agrega:

* analysis
* evidence
* synthesis
* pontuacao
* recomendacoes
* itens de acao
* analises relacionadas
* monitoramento

## Observacao sobre a referencia da API

O portal publico da API do Refy usa OpenAPI como fonte de verdade.

Enquanto o host publico definitivo da API nao estiver estabilizado, a referencia prioriza:

* leitura de endpoints
* exemplos gerados
* contratos de request e response

em vez de um playground interativo completo.

## Fluxo recomendado em produção

1. autenticar
2. obter `workspaceId`
3. obter ou criar `projectId`
4. iniciar análise
5. usar `analysisId` para buscar `page-data`