SageOx Repository API

openapi: 3.1.0
info:
  title: SageOx Admin Repository API
  version: 1.0.0
  description: "# API Reference\n\n## Overview\n\nSageOx is a platform that captures team knowledge from discussions, decisions, and work context into a Ledger (per-repo historical record) and Team Context (team-wide shared knowledge). The SageOx API provides programmatic access to manage repositories, recordings, notifications, and team data with high performance and reliability.\n\n## Base URLs\n\n| Environment | URL |\n|---|---|\n| Local Development | `http://localhost:3000` |\n| Test | `https://test.sageox.ai` |\n| Production | `https://sageox.ai` |\n\n## Authentication\n\nAll requests to the SageOx API require authentication via JWT tokens issued by the Better Auth service.\n\nInclude your token in the `Authorization` header:\n```\nAuthorization: Bearer <token>\n```\n\n**Initial Auth Flow (CLI)**\n- CLI initiates device flow to obtain initial credentials\n- Exchange device code for JWT token\n- Store token securely for subsequent API requests\n- Refresh token when expired\n\n**Authenticated Endpoints**\n- Pass JWT in `Authorization: Bearer <token>` header\n- Tokens contain user identity and team membership\n- Invalid or expired tokens return 401 Unauthorized\n\n## Response Format\n\n### Success\nStandard response format with optional pagination metadata:\n```json\n{\n  \"success\": true,\n  \"data\": { ... }\n}\n```\n\n### Error\nAll errors follow a consistent format:\n```json\n{\n  \"success\": false,\n  \"error\": \"Human-readable error description\"\n}\n```\n\n**Status Codes**\n- `400` — Bad Request: Invalid parameters or malformed request\n- `401` — Unauthorized: Missing or invalid authentication token\n- `403` — Forbidden: Insufficient permissions for this resource\n- `404` — Not Found: Resource does not exist\n- `409` — Conflict: Request conflicts with current state (e.g., duplicate)\n- `429` — Rate Limited: Too many requests; retry with backoff\n- `500` — Internal Error: Server error; contact support if persistent\n\n## Pagination\n\nList endpoints support cursor-based pagination via query parameters:\n\n**Query Parameters**\n- `limit` — Number of results per page (default: 20, max: 100)\n- `offset` — Number of results to skip (default: 0)\n\n**Response Metadata**\nList responses include pagination info:\n```json\n{\n  \"success\": true,\n  \"data\": [ ... ],\n  \"meta\": {\n    \"total\": 150,\n    \"limit\": 20,\n    \"offset\": 0,\n    \"hasMore\": true\n  }\n}\n```\n\n## ID Formats\n\nResources use standardized ID formats for easy identification:\n\n| Resource | Format | Length | Example |\n|---|---|---|---|\n| Team | `team_<cuid2>` | 10 chars | `team_abc1234567` |\n| User | `usr_<cuid2>` | 10 chars | `usr_xyz9876543` |\n| Repository | `repo_<uuidv7>` | 36 chars | `repo_01934f5a-8b9c-7def-abcd-0123456789ab` |\n| Recording | `rec_<uuidv7>` | 36 chars | `rec_01934f5a-8b9c-7def-abcd-0123456789ab` |\n| Image | `img_<uuidv7>` | 36 chars | `img_01934f5a-8b9c-7def-abcd-0123456789ab` |\n| Notification | `notif_<cuid2>` | 14 chars | `notif_ab1cd2ef3g` |\n\nUse these IDs for all API operations. IDs are unique across environments.\n\n## Rate Limiting\n\nThe API applies rate limiting to protect against abuse and ensure fair access:\n\n**Authenticated Endpoints**\n- Limited per user: depends on subscription tier\n- Quota resets hourly\n\n**Unauthenticated Endpoints**\n- Limited per IP address\n- More restrictive than authenticated limits\n\nWhen rate limited, the API returns `429 Too Many Requests`. Retry requests with exponential backoff:\n```\nwait = min(2^attempt * 100ms, 10s)\n```\n\n## Timestamps\n\nAll timestamps in API responses use RFC 3339 / ISO 8601 format in UTC:\n```\n2025-12-03T10:30:00Z\n```\n\nUse this format when providing timestamps in requests as well. The API rejects timestamps in other formats.\n\n## SDKs & Tools\n\n- **OpenAPI Spec** — Full schema available at `/api/openapi.json`\n- **Postman Collection** — Import from `/api/postman.json` for interactive exploration\n- **CLI** — Use `ox` CLI for command-line access\n"
  contact:
    name: SageOx Team
  license:
    name: MIT
servers:
- url: http://localhost:3000
  description: Devcontainer
- url: https://test.sageox.ai
  description: Test
- url: https://sageox.ai
  description: Production
security:
- bearerAuth: []
tags:
- name: Repository
  description: 'Repository initialization and merge operations. `initRepo` creates or reconnects a repository with SageOx (idempotent). `mergeRepos` combines ledger data when repositories are merged.

    '
paths:
  /api/v1/repo/init:
    post:
      operationId: initRepo
      summary: Initialize repository tracking
      description: 'Registers a git repository with SageOx and creates an associated team.


        **Authentication:** Optional

        - **Authenticated:** User becomes owner of newly created team

        - **Unauthenticated:** Creates orphan team (can be claimed later)


        Idempotent: if repo_id already exists, returns existing repo/team info.

        Users can request to merge teams via /api/v1/repo/merge.

        '
      tags:
      - Repository
      security:
      - BearerAuth: []
      - {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - repo_id
              - type
              - init_at
              properties:
                repo_id:
                  type: string
                  description: Client-generated repo identifier (repo_<uuidv7>)
                  pattern: ^repo_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
                  example: repo_01934f5a-8b9c-7def-b012-3456789abcde
                type:
                  type: string
                  description: VCS type (git supported, svn planned)
                  enum:
                  - git
                  example: git
                init_at:
                  type: string
                  format: date-time
                  description: Timestamp from .repo_<id> marker file
                  example: '2025-12-18T16:30:00Z'
                repo_salt:
                  type: string
                  description: Initial commit hash for salted remote hashing (optional, omitted in --offline mode)
                  example: abc123def456789...
                repo_remote_hashes:
                  type: array
                  description: SHA256(repo_salt + remote_url) for each git remote (optional, omitted in --offline mode)
                  items:
                    type: string
                  example:
                  - sha256:a1b2c3d4...
                  - sha256:e5f6g7h8...
                is_public:
                  type: boolean
                  description: When true, prevents automatic merging with repos that have matching hashes (fork protection)
                  example: false
                created_by_email:
                  type: string
                  format: email
                  description: Git user.email from local config (optional, omitted in --offline mode)
                  example: jane@example.com
                created_by_name:
                  type: string
                  description: Git user.name from local config (optional, omitted in --offline mode)
                  example: Jane Dev
            examples:
              full:
                summary: Full request with all optional fields
                value:
                  repo_id: repo_01934f5a-8b9c-7def-b012-3456789abcde
                  type: git
                  init_at: '2025-12-18T16:30:00Z'
                  repo_salt: abc123def456789...
                  repo_remote_hashes:
                  - sha256:a1b2c3d4...
                  is_public: false
                  created_by_email: jane@example.com
                  created_by_name: Jane Dev
              offline:
                summary: Minimal request (--offline mode)
                value:
                  repo_id: repo_01934f5a-8b9c-7def-b012-3456789abcde
                  type: git
                  init_at: '2025-12-18T16:30:00Z'
      responses:
        '200':
          description: Repository already exists (idempotent response)
          content:
            application/json:
              schema:
                type: object
                required:
                - repo_id
                properties:
                  repo_id:
                    type: string
                    description: The existing repo_id
                    example: repo_01934f5a-8b9c-7def-b012-3456789abcde
                  team_id:
                    type: string
                    description: ID of the existing team
                    example: team_abc123xyz
                  web_base_url:
                    type: string
                    format: uri
                    description: Base URL for web UI (enterprise deployments)
                    example: https://sageox.ai
        '201':
          description: Repository registered successfully
          content:
            application/json:
              schema:
                type: object
                required:
                - repo_id
                - team_id
                properties:
                  repo_id:
                    type: string
                    description: The registered repo_id
                    example: repo_01934f5a-8b9c-7def-b012-3456789abcde
                  team_id:
                    type: string
                    description: ID of the newly created team
                    example: team_abc123xyz
                  web_base_url:
                    type: string
                    format: uri
                    description: Base URL for web UI (enterprise deployments)
                    example: https://sageox.ai
                  claim_code:
                    type: string
                    description: Code for claiming team ownership (unauthenticated requests only)
                    example: abc123xyz
                  claim_url:
                    type: string
                    format: uri
                    description: Full URL for browser-based team claiming (unauthenticated requests only)
                    example: https://sageox.ai/team/claim?code=abc123xyz&team=team_abc123xyz
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                missing_repo_id:
                  value:
                    error: repo_id is required
                invalid_repo_id:
                  value:
                    error: repo_id must be in format repo_<uuidv7>
                invalid_type:
                  value:
                    error: type must be 'git'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api/v1/repo/merge:
    post:
      operationId: mergeRepos
      summary: Merge concurrent repository registrations
      description: 'Called by ox-cli when it detects multiple .repo_* files (concurrent inits).

        Determines the canonical repo_id based on UUIDv7 timestamps (time-sortable).


        **Current implementation:** Logs the merge request and returns the canonical repo_id.

        Full merge logic is planned for a future release.

        '
      tags:
      - Repository
      security:
      - BearerAuth: []
      - {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - repo_ids
              properties:
                repo_ids:
                  type: array
                  description: Array of repo_<uuidv7> identifiers to merge
                  minItems: 2
                  items:
                    type: string
                    pattern: ^repo_[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
                  example:
                  - repo_01934f5a-8b9c-7def-b012-3456789abcde
                  - repo_01934f5b-1234-7abc-9012-def456789012
      responses:
        '200':
          description: Merge processed successfully
          content:
            application/json:
              schema:
                type: object
                required:
                - canonical_repo_id
                - merged
                properties:
                  canonical_repo_id:
                    type: string
                    description: The earliest repo_id by UUIDv7 timestamp (becomes canonical)
                    example: repo_01934f5a-8b9c-7def-b012-3456789abcde
                  merged:
                    type: boolean
                    description: Whether merge was processed (always true for now)
                    example: true
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                insufficient_ids:
                  value:
                    error: at least 2 repo_ids required for merge
                invalid_format:
                  value:
                    error: all repo_ids must be in format repo_<uuidv7>
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response returned by all endpoints on failure.
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          description: Always `false` for error responses.
          enum:
          - false
        error:
          type: string
          description: Human-readable error message describing what went wrong. Do not parse this programmatically — use HTTP status codes for control flow.
          example: Invalid request parameters
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'JWT token obtained from the auth service (/api/auth/token).

        Token is validated using JWKS from the auth service.

        Required claims: sub (user_id), email, name, tier.

        '