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

# Using the API

- [Intro](https://academy.shade.inc/developers/using-the-api/using-the-api.md)
- [Working with assets](https://academy.shade.inc/developers/using-the-api/working-with-assets.md): Look up assets by path or ID, download originals and proxies, organize files and folders, and read transcripts and comments through the Shade API.
- [Searching and filtering assets](https://academy.shade.inc/developers/using-the-api/searching-and-filtering-assets.md): Find and list assets with POST /search: AI search, filters on paths, types, dates, and metadata, sorting, and paging through results.
- [Metadata Guide](https://academy.shade.inc/developers/using-the-api/metadata-guide.md): A beginner's guide to creating and managing metadata attributes and options using the Shade API.
- [Collections and share links](https://academy.shade.inc/developers/using-the-api/collections-and-share-links.md): Group assets into collections and share files, folders, and collections with people outside your workspace using share links.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/developers/using-the-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
