> For the complete documentation index, see [llms.txt](https://dev.ishare.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.ishare.eu/introduction/getting-started/openapi-descriptions.md).

# OpenAPI Descriptions

The endpoints that are defined in this developer documentation as part of the iSHARE Framework are also available in OpenAPI descriptions and are published on the iSHARE OpenAPI specifications. In each endpoint, links are provided to relevant parts of the OpenAPI description.

The complete OpenAPI descriptions are available here:

* Human-readable: <https://openapi.ishare.eu/>
  * The site will automatically present you with the latest available version. Use the version pull-down (top right) to select any previous version.
* Machine readable (YAML): <https://raw.githubusercontent.com/iSHAREScheme/openapi/v\\><version>/ishare\_openapi\_spec.yaml
  * Remember to replace \<version> with the required version number (for example: 2.2)


---

# 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, and the optional `goal` query parameter:

```
GET https://dev.ishare.eu/introduction/getting-started/openapi-descriptions.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.