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

# Versionamento da API

> Como a Scribe API lida com versionamento e mudanças incompatíveis

## Prefixo de versão

Todos os endpoints da Scribe API incluem um prefixo de versão no caminho.
A versão estável atual é **v1**.

```
https://scribe-api.telepatia.ai/v1/set-consultation-context
                                 ^^
                              versão
```

## Garantia de estabilidade

Dentro de uma versão, a API não vai introduzir mudanças incompatíveis. São
consideradas incompatíveis:

* Remover um endpoint ou método HTTP
* Remover ou renomear um campo de resposta
* Mudar o tipo de um campo existente
* Adicionar um novo campo obrigatório na requisição
* Mudar códigos de erro pra cenários existentes

O seguinte **não** é incompatível e pode acontecer a qualquer momento:

* Adicionar novos campos opcionais na requisição
* Adicionar novos campos na resposta
* Adicionar novos endpoints
* Adicionar novos códigos de erro pra novos cenários

## Política de deprecação

Quando uma nova versão é publicada (ex. `v2`):

1. A versão anterior entra em um **período de deprecação** de pelo menos 6 meses
2. Versões deprecadas retornam um header `Sunset` com a data planejada de remoção
3. Após o período de deprecação, a versão antiga pode ser removida

## Versões atuais

| Versão | Status  | URL base                             |
| ------ | ------- | ------------------------------------ |
| `v1`   | Estável | `https://scribe-api.telepatia.ai/v1` |