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

# Versioning

> How the API is versioned and what counts as a breaking change.

## The version is in the path

Every endpoint starts with `/v1`.

```
https://YOUR_AGENTIC_ID_HOST/v1/resolve
```

A breaking change ships under a new prefix. Changes that do not break existing clients are added to `/v1`.

## OpenAPI

The API serves its own OpenAPI document. It is generated from the same schemas the API validates requests with.

| Item | Value |
| - | - |
| Document | `GET /v1/openapi.json` |
| OpenAPI version | `3.1.0` |
| API version (`info.version`) | `1.0.0` |

The [API reference](https://docs-agentic-id.icustomer.ai/api-reference/introduction.md) is built from this document.

> [!NOTE]
>
> Use only the paths listed in the API reference. Any other path that happens to answer is not part of the contract and can change without notice.

## What is a breaking change

| Breaking | Not breaking |
| - | - |
| Removing or renaming an endpoint | Adding an endpoint |
| Removing or renaming a request or response field | Adding an optional request field |
| Making an optional request field required | Adding a response field |
| Changing a field's type or meaning | Adding a value to an enum in a response, such as a new `stopped_early` reason |
| Changing or removing an error `code` | Adding an error `code` |
| Tightening a limit in the schema, such as a lower maximum | Changing the wording of `summary` or `detail` |

## Write clients that last

* Branch on `code`, `outcome`, `verdict` and `level`. Do not parse `summary` or `detail`.
* Ignore response fields you do not know.
* Treat an enum value you do not know as "other", not as a failure.
* Read `cost.charged_credits` for what a call cost. Do not hard-code credit costs.

## Clients

| Client | Version |
| - | - |
| [Claude Code plugin](https://docs-agentic-id.icustomer.ai/claude-code-plugin.md), [MCP server](https://docs-agentic-id.icustomer.ai/mcp-server.md), [CLI](https://docs-agentic-id.icustomer.ai/cli.md) | `agentic-id --version` prints it. It is also sent as the `x-agentic-id-client` header. |
| [SDK](https://docs-agentic-id.icustomer.ai/sdk.md) | 0.1.0, not published yet |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.