> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/xytech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/xytech/rest-api-v3/api-v3-user-guide/api-reference-swagger.md).

# API reference (Swagger)

Every document has an auto-generated OpenAPI (Swagger) specification describing its exact endpoints, fields, and operations. This is the authoritative, always-up-to-date reference for the documents available in **your** environment.

### The `/apidocs` index

Open the API documentation index in a browser:

```
https://<your-server>/ApiDocs
```

To view the index for a specific database:

```
https://<your-server>/ApiDocs/MyDatabase
```

The index lists every document grouped by module, with a filter box to find a document quickly. Each document offers a link to its **v2** and its **v3** specification - use the **\[v3]** link for the current API.

### Spec URLs

The v3 specification for a single document is served from:

```
https://<your-server>/api/v3/spec/{documentCode}
```

Compare this to the v2 spec URL, which includes the database in the path:

```
https://<your-server>/api/v2/database/{database}/spec/{documentCode}
```

The database segment is absent from the v3 spec URL - consistent with v3 not using a database URL parameter (see [Base URL and databases](/xytech/rest-api-v3/api-v3-user-guide/base-url-and-databases.md)).

### Using the reference

The generated spec documents, per document:

* Available operations (GET / POST / PUT / PATCH) and their routes.
* Field names and types for request and response bodies.
* The supported filter operators for querying (mirrors the [Filtering reference](/xytech/rest-api-v3/api-v3-user-guide/filtering-reference.md)).

> Because the reference is generated from your environment, it always reflects the documents and fields actually configured for your database - start here whenever you need the exact field names for a specific document.