Skip to content

Projects API

Base path: /api/v1/projects

Endpoints

MethodEndpointDescription
GET/projectsList projects (paginated)
POST/projectsCreate project
GET/projects/{id}Get project
PUT/projects/{id}Update project
DELETE/projects/{id}Delete project
POST/projects/{id}/pipeline/runRun full pipeline (crawl → OCR → index) for all pending papers
POST/projects/{id}/pipeline/paper/{paper_id}Run pipeline for a single paper

Query Parameters (List)

  • page — Page number (default: 1)
  • page_size — Items per page (default: 20)

Request Body (Create/Update)

json
{
  "name": "My Research",
  "description": "Optional description",
  "domain": "Optional domain",
  "settings": {}
}

Response

Project includes paper_count and keyword_count when fetched individually or listed.

Released under the MIT License.