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

# Guides

- [OpenAPI layouts](https://gitbook.com/docs/api-references/guides/openapi-layouts.md): Choose between one page per tag and one page per operation for your API reference
- [Structuring your API reference](https://gitbook.com/docs/api-references/guides/structuring-your-api-reference.md): Learn how to structure your API reference across multiple pages with icons and descriptions
- [Adding custom code samples](https://gitbook.com/docs/api-references/guides/adding-custom-code-samples.md): Learn how to configure custom code samples to display alongside your API endpoints
- [Managing API operations](https://gitbook.com/docs/api-references/guides/managing-api-operations.md): Learn how to mark an OpenAPI API operation as experimental, deprecated or hide it from your documentation
- [Configuring the “Test it” button](https://gitbook.com/docs/api-references/guides/configuring-the-test-it-button.md)
- [Using OpenAPI proxy](https://gitbook.com/docs/api-references/guides/using-openapi-proxy.md)
- [Describing enums](https://gitbook.com/docs/api-references/guides/describing-enums.md): Learn how to add descriptions to enums
- [Integrating with CI/CD](https://gitbook.com/docs/api-references/guides/support-for-ci-cd-with-api-blocks.md): Learn how to automate the update of your OpenAPI specification in GitBook


---

# 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://gitbook.com/docs/api-references/guides.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.
