Requirements API
List Requirements
http
GET /api/v1/projects/{project_id}/requirements
Authorization: Bearer <token>Response 200 OK
json
[
{
"id": "uuid",
"project_id": "uuid",
"title": "User Registration API",
"description": "Create a REST API endpoint for user registration...",
"priority": "high",
"status": "analyzed",
"structured_spec": { ... },
"created_at": "2026-01-01T00:00:00Z"
}
]Create Requirement
http
POST /api/v1/projects/{project_id}/requirements
Authorization: Bearer <token>
Content-Type: application/json
{
"title": "User Registration API",
"description": "Create a REST API endpoint for user registration with email validation and password hashing",
"priority": "high"
}Analyze Requirement
Triggers AI analysis to generate a structured specification.
http
POST /api/v1/requirements/{requirement_id}/analyze
Authorization: Bearer <token>Response 200 OK
json
{
"id": "uuid",
"status": "analyzed",
"structured_spec": {
"functional_requirements": [...],
"non_functional_requirements": [...],
"acceptance_criteria": [...],
"estimated_complexity": "medium",
"suggested_work_items": [...]
}
}Approve Requirement
http
POST /api/v1/requirements/{requirement_id}/approve
Authorization: Bearer <token>Approving a requirement makes it ready for plan generation.
Get Requirement
http
GET /api/v1/requirements/{requirement_id}
Authorization: Bearer <token>