Skip to content

API Documentation

AI4Meta provides a RESTful API for programmatic access to your projects, studies, and analysis results.

Authentication

All API requests require a Bearer token. Generate one from Settings → API keys.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.ai4meta.net/v1/projects

Base URL

https://api.ai4meta.net/v1

Endpoints

Projects

MethodPathDescription
GET/projectsList all projects
POST/projectsCreate a new project
GET/projects/:idGet project details
PATCH/projects/:idUpdate project
DELETE/projects/:idDelete project

Studies

MethodPathDescription
GET/projects/:id/studiesList studies in project
POST/projects/:id/studies/importImport studies (RIS, BibTeX, CSV)
GET/studies/:idGet study details
PATCH/studies/:idUpdate study metadata
POST/studies/:id/screeningSubmit screening decision

Extraction

MethodPathDescription
GET/projects/:id/codebookGet codebook definition
PUT/projects/:id/codebookUpdate codebook
GET/projects/:id/extractionsGet extraction data
PUT/studies/:id/extractionUpdate extraction for a study

Analysis

POST /projects/:id/analysis
Content-Type: application/json

{
  "type": "meta-analysis",
  "model": "random-effects",
  "method": "REML",
  "effectMeasure": "SMD",
  "outcomeField": "primary_outcome",
  "subgroup": null
}

Export

MethodPathDescription
GET/projects/:id/export/prismaPRISMA flow diagram (SVG)
GET/projects/:id/export/forestForest plot (SVG/PNG)
GET/projects/:id/export/reportFull report (DOCX/PDF)

Rate Limits

API requests are limited to 100 requests/minute per API key. Batch endpoints count as a single request.

Error Handling

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Project with id 'abc123' not found",
    "status": 404
  }
}

Common error codes: UNAUTHORIZED (401), FORBIDDEN (403), NOT_FOUND (404), RATE_LIMITED (429), INTERNAL (500).

SDKs & Libraries

Official Python and R client libraries are implemented in source and are awaiting public registry publication. Until PyPI/CRAN releases are cut, use the REST API directly or install from the AI4Meta source release artifacts.

  • Python — SDK source ready; PyPI publication pending
  • R — SDK source ready; CRAN publication pending
  • JavaScript/TypeScript — not implemented yet