API Reference

🔌 API Reference

Uspeech Analytics exposes a REST API so you can drive the platform from your own scripts, services, and integrations. Everything you can do in the web app — upload audio, transcribe, list and download transcripts — has an API counterpart.

This first release of the reference covers the Transcription surface end-to-end. More endpoint groups (projects, analysis, survey processing) will be added here as they stabilize.

---

Base URL

All endpoints are mounted under /api/ on your Uspeech host:

https://app.uspeech.io/api/

If you self-host, replace the host with your own deployment URL.

---

Authentication

Every endpoint requires either a logged-in browser session or a user-scoped API key. For programmatic access, use an API key — see Authentication.

---

What’s documented here

• Authentication — How to create API keys, the header format, and how keys are scoped to a user’s projects.
• Transcription — Upload audio, poll status, list and retrieve transcripts, and download SRT or DOCX output.
• Status Codes & Errors — HTTP status codes you should expect, the shape of error responses, and transcription-specific failure reasons.

---

Interactive schema

A live, auto-generated OpenAPI 3 schema is available for every deployment:

• OpenAPI document — GET /api/schema/
• Swagger UI — /api/schema/swagger-ui/
• ReDoc — /api/schema/redoc/

These pages reflect the exact endpoints, parameters, and response shapes in your installed version. Use this written reference for the “how do I do X end-to-end” walkthrough, and the schema for the precise list of fields on any individual endpoint.

---

Conventions in this reference

• Request and response bodies are JSON unless stated otherwise. File uploads use multipart/form-data.
• Endpoint headers are written as ## METHOD /path.
• Example calls use curl with the Authorization: Api-Key … header. Substitute your own host and key.

💡 Tip: every example here assumes you’ve already created an API key — start at Authentication if you haven’t.