> For the complete documentation index, see [llms.txt](https://docs.fylr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fylr.io/for-developers/api/endpoints.md).

# Endpoints

The fylr HTTP/JSON API. Most endpoints live under the **`/api/v1`** base path — for example `/api/v1/collection` or `/api/v1/search`. The OAuth2 / OpenID Connect endpoints under `/api/oauth2` and the `.well-known` discovery document are the exceptions; each lists its own full path.

**Authentication.** Calls are authenticated with an access token. Present it as an `Authorization: Bearer <token>` header, or — as fallbacks — the `access_token` query parameter or an `X-Fylr-Authorization: Bearer <token>` header (a workaround for Safari, which overwrites `Authorization`). A request without a valid token runs as an anonymous session; endpoints that require a user then answer `401`.

Each page below documents one endpoint group, with an interactive panel per operation generated from the OpenAPI specification (`fylr-openapi.yml`). Pages are grouped by the first path segment; larger groups — collection, eas, system, config, plugin — carry subpages.

## All endpoints

* [/api/v1/collection](/for-developers/api/endpoints/collection.md)
* [/api/v1/config](/for-developers/api/endpoints/config.md)
* [/api/v1/db](/for-developers/api/endpoints/api-db.md)
* [/api/v1/db\_info](/for-developers/api/endpoints/api-db_info.md)
* [/api/v1/eas](/for-developers/api/endpoints/eas.md)
* [/api/v1/event](/for-developers/api/endpoints/api-event.md)
* [/api/v1/export](/for-developers/api/endpoints/api-export.md)
* [/api/v1/group](/for-developers/api/endpoints/api-group.md)
* [/api/v1/hotfolder](/for-developers/api/endpoints/api-hotfolder.md)
* [/api/v1/l10n](/for-developers/api/endpoints/api-l10n.md)
* [/api/v1/mask](/for-developers/api/endpoints/api-mask.md)
* [/api/v1/message](/for-developers/api/endpoints/api-message.md)
* [/api/v1/oai](/for-developers/api/endpoints/api-oai.md)
* [/api/oauth2](/for-developers/api/endpoints/api-oauth2.md)
* [/api/v1/objects](/for-developers/api/endpoints/api-objects.md)
* [/api/v1/objecttype](/for-developers/api/endpoints/api-objecttype.md)
* [/api/v1/plugin](/for-developers/api/endpoints/plugin.md)
* [/api/v1/pool](/for-developers/api/endpoints/api-pool.md)
* [/api/v1/publish](/for-developers/api/endpoints/api-publish.md)
* [/api/v1/right](/for-developers/api/endpoints/api-right.md)
* [/api/v1/schema](/for-developers/api/endpoints/api-schema.md)
* [/api/v1/search](/for-developers/api/endpoints/api-search.md)
* [/api/v1/settings](/for-developers/api/endpoints/api-settings.md)
* [/api/v1/suggest](/for-developers/api/endpoints/api-suggest.md)
* [/api/v1/system](/for-developers/api/endpoints/system.md)
* [/api/v1/tags](/for-developers/api/endpoints/api-tags.md)
* [/api/v1/task](/for-developers/api/endpoints/api-task.md)
* [/api/v1/transitions](/for-developers/api/endpoints/api-transitions.md)
* [/api/v1/user](/for-developers/api/endpoints/api-user.md)
* [/api/v1/WebDAV](/for-developers/api/endpoints/api-webdav.md)
* [/.well-known](/for-developers/api/endpoints/api-well-known.md)
* [/api/v1/xmlmapping](/for-developers/api/endpoints/api-xmlmapping.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fylr.io/for-developers/api/endpoints.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
