API Reference

The TEA Platform provides a RESTful API built with Next.js 15 App Router and Prisma ORM.

Authentication

The TEA Platform uses NextAuth.js  for authentication. API routes are protected and require a valid session.

Authentication Flow

1. Sign in via the web interface using GitHub OAuth or email/password
2. Session cookies are automatically managed by NextAuth.js
3. API requests include session cookies for authentication

Making Authenticated Requests

When using tools like curl or Postman, you’ll need to include the session cookie:

curl -X GET http://localhost:3000/api/cases \
     -H 'Cookie: next-auth.session-token=YOUR_SESSION_TOKEN'

API Overview

The TEA Platform API is organised around REST principles. All endpoints:

• Accept and return JSON
• Use standard HTTP methods (GET, POST, PUT, DELETE)
• Return appropriate HTTP status codes
• Require authentication (except public endpoints)

Base URL

Core Resources

API Endpoints

Cases

Elements

Teams

Users

Response Format

Success Response

{
  "id": 1,
  "name": "Example Case",
  "description": "An example assurance case",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T14:45:00Z"
}

Error Response

{
  "error": "Not Found",
  "message": "Case with ID 999 not found",
  "statusCode": 404
}

HTTP Status Codes

Database Schema

The TEA Platform uses Prisma ORM with PostgreSQL. The schema defines:

• AssuranceCase - Top-level container for assurance arguments
• Element - Nodes in the assurance case (goals, strategies, claims, evidence, context)
• User - User accounts
• Team - Groups for collaboration
• Comment - Discussions on elements

For the complete schema, see the Prisma schema file .

Further Resources

• NextAuth.js Documentation  - Authentication
• Prisma Documentation  - Database ORM
• Next.js API Routes  - Route handlers