AI Integration

Connect your AI coding assistant directly to SprintFlint using the REST API. Get assigned tickets, update status, and add comments without leaving your editor.

How It Works

AI assistants like Cursor and Claude can use SprintFlint's REST API to work directly with your tickets. Use agent skills or custom tools to give your AI access to your sprint data.

API Endpoints

SprintFlint provides these REST API endpoints:

Endpoint	Methods	Description
`/api/v1/projects`	GET, POST	List and create projects
`/api/v1/projects/:id`	GET, PATCH, DELETE	Get, update, or delete a project
`/api/v1/projects/:id/sprints`	GET, POST	List and create sprints
`/api/v1/projects/:id/sprints/:id`	GET, PATCH, DELETE	Get, update, or delete a sprint
`/api/v1/projects/:id/sprints/:id/issues`	GET, POST	List and create issues
`/api/v1/projects/:id/sprints/:id/issues/:id`	GET, PATCH, DELETE	Get, update, or delete an issue
`/api/v1/.../issues/:id/comments`	GET, POST	List and create comments
`/api/v1/comments/:id`	GET, PATCH, DELETE	Get, update, or delete a comment

Setup

1. Generate an API Token

Click your avatar in the sidebar
Go to "My Profile"
Scroll to the "API Token" section
Click "Generate Token"
Copy and securely store your token

2. Use the API

Include your token in the X-API-Token header:

curl -H "X-API-Token: YOUR_API_TOKEN" \
  https://sprintflint.com/api/v1/projects

3. Configure Your AI Assistant

Add the SprintFlint agent skills to your AI assistant, or create custom tools that call the REST API.

Token Security - Your API token provides the same access as your logged-in account. Keep it secret and never commit it to version control.

Usage Examples

Once configured, you can ask your AI assistant things like:

"What issues are in the current sprint?"
"Show me the details of PROJ-123"
"Update PROJ-123 status to in_progress"
"Add a comment to PROJ-123: Started working on the API integration"
"Create a new issue: Fix login button styling"

Example API Calls

List Projects

GET /api/v1/projects
X-API-Token: YOUR_TOKEN

Create an Issue

POST /api/v1/projects/1/sprints/1/issues
X-API-Token: YOUR_TOKEN
Content-Type: application/json

{
  "issue": {
    "title": "Fix login button",
    "status": "todo",
    "story_points": 2
  }
}

Update Issue Status

PATCH /api/v1/projects/1/sprints/1/issues/123
X-API-Token: YOUR_TOKEN
Content-Type: application/json

{
  "issue": {
    "status": "done"
  }
}

Add a Comment

POST /api/v1/projects/1/sprints/1/issues/123/comments
X-API-Token: YOUR_TOKEN
Content-Type: application/json

{
  "comment": {
    "body": "Started working on this ticket"
  }
}

Typical Workflow

Start your day - List issues in the current sprint
Pick a ticket - Get details for a specific issue
Start work - Update status to in_progress
Track progress - Add comments as you work
Complete - Update status to done

AI-Readable Documentation

For AI systems that support it, SprintFlint provides machine-readable documentation at:

https://sprintflint.com/llms.txt

This file describes SprintFlint's data model and available API endpoints in a format optimised for AI consumption.

Full API Documentation

For complete API documentation including request/response schemas, see the API Reference.

Troubleshooting

Authentication Errors

If you get "Invalid API token" errors:

Check that your token is correctly copied (no extra spaces)
Verify the token hasn't been regenerated
Ensure the header format is X-API-Token: YOUR_TOKEN

404 Not Found

If resources aren't found:

Check that you have access to the project/sprint
Verify the IDs in your request are correct

Need Help?

If you have questions about AI integration or need assistance, contact us at [email protected].