Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.bigspin.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Bigspin public API lets you push conversation data into Bigspin and read back the results of analysis. The two resources you’ll work with are Projects (containers for the transcripts you want analyzed) and Transcripts (the conversations themselves, plus turn-level annotations once analysis runs).

​
Base URL

All public API endpoints are served from: 
https://app.bigspin.ai/public/api/v1
Every endpoint path in this reference is relative to this base URL. For example, the full URL for the create-project endpoint is: 
https://app.bigspin.ai/public/api/v1/projects

​
Authentication

All requests must include an API key in the Authorization header as a Bearer token: 
Authorization: Bearer YOUR_API_KEY
You can generate API keys from your Bigspin dashboard under Settings → API Keys. See the Authentication page for full details, including how to handle authentication errors and how to scope keys with permissions.

​
Rate limiting

Rate limiting details are not currently published. If you encounter 429 Too Many Requests responses or need to understand the limits that apply to your plan, contact Bigspin support.

​
Available APIs

Authentication

How to create and use API keys to authenticate every request.

Projects

Create, list, and retrieve Bigspin projects.

Transcripts

Upload conversation transcripts into a project; list and fetch transcripts with turns and annotations.