> ## 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.

# API Versioning

> How the Scribe API handles versioning and breaking changes

## Version prefix

Every Scribe API endpoint includes a version prefix in its path. The current
stable version is **v1**.

```
https://scribe-api.telepatia.ai/v1/set-consultation-context
                                 ^^
                              version
```

## Stability guarantee

Within a version, the API will not introduce breaking changes. The following
are considered breaking:

* Removing an endpoint or HTTP method
* Removing or renaming a response field
* Changing the type of an existing field
* Adding a new required request field
* Changing error codes for existing scenarios

The following are **not** breaking and may happen at any time:

* Adding new optional request fields
* Adding new response fields
* Adding new endpoints
* Adding new error codes for new scenarios

## Deprecation policy

When a new version is released (e.g. `v2`):

1. The previous version enters a **deprecation period** of at least 6 months
2. Deprecated versions return a `Sunset` header with the planned removal date
3. After the deprecation period, the old version may be removed

## Current versions

| Version | Status | Base URL                             |
| ------- | ------ | ------------------------------------ |
| `v1`    | Stable | `https://scribe-api.telepatia.ai/v1` |