# Document an API

- [OpenAPI](https://gitbook.com/docs/api-references/openapi.md): Add an OpenAPI spec to a page and let your users test endpoints right on the page with interactive blocks.
- [Add an OpenAPI specification](https://gitbook.com/docs/api-references/openapi/add-an-openapi-specification.md): Learn how to add and update an OpenAPI specification in GitBook application or from CLI
- [Insert API reference in your docs](https://gitbook.com/docs/api-references/openapi/insert-api-reference-in-your-docs.md): Insert complete API reference from your OpenAPI spec or pick individual operation or schemas
- [Guides](https://gitbook.com/docs/api-references/guides.md)
- [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
- [Extensions reference](https://gitbook.com/docs/api-references/extensions-reference.md): The complete reference of OpenAPI extensions supported by GitBook


---

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