---
title: "API reference"
description: "The seven public Fellowverse API endpoints, with a downloadable OpenAPI 3.1 contract."
generated: true
---

# API reference

Base URL: `https://play.fellowverse.app`. Every request uses a server-held bearer key.

| Method | Endpoint | Purpose |
| --- | --- | --- |
| POST | [`/v1/search`](/api/search) | Search by words or a reference |
| POST | [`/v1/voice-search`](/api/voice-search) | Search by a spoken request |
| POST | [`/v1/uploads`](/api/uploads) | Upload a recording to align |
| POST | [`/v1/alignments`](/api/alignments) | Align an upload to the text it reads |
| GET | [`/v1/jobs/{id}`](/api/jobs) | See a job's state and result |
| GET | [`/v1/jobs/{id}/files/{name}`](/api/clips) | Fetch a clip an alignment made |
| GET | [`/v1/usage`](/api/usage) | See metered use over a period |

## OpenAPI 3.1

Browse the [OpenAPI viewer](/api/openapi) or download the canonical [YAML](/api/content/assets/openapi.yaml) or equivalent [JSON](/api/content/assets/openapi.json). The viewer is read-only. It does not send requests or ask for your API key.

New to the API? Start with the [quickstart](/start/quickstart). For practical examples, read the [integration guides](/guides).
