From c6104540bd4c5ec2c620789af3c3fee2d960a69a Mon Sep 17 00:00:00 2001 From: Kristin Martin Date: Thu, 8 Oct 2026 18:17:15 +0000 Subject: [PATCH] Add an overview page at the Sprites API root /sprites/api redirected to the first connector endpoint, so every link into the reference cost an extra hop and an agent fetching it landed on one operation rather than an entry point. It is the most-linked URL we have for the API. Content comes from api/openapi.json: base URL, bearer auth, and a link to the spec. Verified on a preview that the root serves 200 and the generated operation pages are unaffected. --- api/index.mdx | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 api/index.mdx diff --git a/api/index.mdx b/api/index.mdx new file mode 100644 index 0000000..e7c6930 --- /dev/null +++ b/api/index.mdx @@ -0,0 +1,25 @@ +--- +title: Overview +--- + +This section is the Sprites API reference, generated from the Sprites OpenAPI specification. For guides and worked examples, see [Working with Sprites](/sprites/working-with-sprites). + +## Base URL + +All requests are made against: + +``` +https://api.sprites.dev +``` + +## Authentication + +Every request takes a bearer token: + +``` +Authorization: Bearer +``` + +## Specification + +Download the [OpenAPI spec](https://api.sprites.dev/openapi.json) to generate a client or explore the API in another tool.