Skip to main content

Projects API

Manage projects and trigger analysis.

List Projects​

GET /v1/projects

Response:

{
  "success": true,
  "projects": [
    {
      "id": "proj_abc123",
      "name": "my-app",
      "status": "indexed",
      "filesCount": 234,
      "symbolsCount": 1847,
      "lastIndexedAt": "2024-01-15T10:30:00Z",
      "createdAt": "2024-01-10T08:00:00Z"
    }
  ]
}

Get Project​

GET /v1/projects/:id

Response:

{
  "success": true,
  "project": {
    "id": "proj_abc123",
    "name": "my-app",
    "status": "indexed",
    "filesCount": 234,
    "symbolsCount": 1847,
    "languages": ["typescript", "javascript"],
    "stats": {
      "linesOfCode": 15420,
      "avgComplexity": 4.2,
      "duplicatePercentage": 3.1
    },
    "lastIndexedAt": "2024-01-15T10:30:00Z",
    "createdAt": "2024-01-10T08:00:00Z"
  }
}

Create Project​

POST /v1/projects

Request Body:

{
  "name": "my-new-project",
  "githubRepo": "owner/repo",
  "branch": "main"
}

Response:

{
  "success": true,
  "project": {
    "id": "proj_xyz789",
    "name": "my-new-project",
    "status": "pending"
  }
}

Delete Project​

DELETE /v1/projects/:id

Response:

{
  "success": true
}

Trigger Indexing​

POST /v1/projects/:id/index

Request Body (optional):

{
  "force": true
}

Response:

{
  "success": true,
  "message": "Indexing started",
  "estimatedTime": 120
}

Get Index Progress​

GET /v1/projects/:id/index-progress

Response (Server-Sent Events):

event: progress
data: {"phase": "scanning", "progress": 25, "filesScanned": 58}

event: progress
data: {"phase": "extracting", "progress": 50, "symbolsExtracted": 450}

event: progress
data: {"phase": "embedding", "progress": 75, "chunksProcessed": 120}

event: complete
data: {"status": "indexed", "filesCount": 234, "symbolsCount": 1847}

Archive Project​

POST /v1/projects/:id/archive

Unarchive Project​

POST /v1/projects/:id/unarchive