Skip to content

Repository navigation

Add an overview page at the Sprites API root #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcmartin merged 1 commit into from
Oct 8, 2026
Merged

Add an overview page at the Sprites API root #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <token>
```

## Specification

Download the [OpenAPI spec](https://api.sprites.dev/openapi.json) to generate a client or explore the API in another tool.
Loading