API Authentication
SprintVibe provides a REST API for programmatic access to your projects, sprints, and stories. The API requires Bearer token authentication via API keys.
Requirements
- Pro or Teams subscription (Hobby tier does not have API access)
- An API key generated from Settings
Generating an API key
- Go to Settings → API Keys
- Click Generate New Key
- Enter a name for the key (e.g., "CI Pipeline", "Cursor MCP")
- Select scopes:
| Scope | Permissions |
|---|---|
| read | GET requests — list and view projects, sprints, stories |
| write | POST, PATCH, DELETE — create stories, update status, add comments |
- Click Generate
- Copy the key immediately — it's only shown once
API keys use the format sv_ followed by 64 hex characters.
Using your API key
Include the key in the Authorization header of every request:
curl -H "Authorization: Bearer sv_your_api_key_here" \
https://gosprintvibe.com/api/v1/me
Rate limits
| Tier | Requests per hour |
|---|---|
| Hobby | No API access |
| Pro | 1,000 |
| Teams | 5,000 |
When you exceed the limit, the API returns 429 Too Many Requests with a Retry-After header.
Revoking a key
Go to Settings → API Keys and click Revoke next to any key. Revoked keys stop working immediately and cannot be restored.