chatgpt-api/apps/api
Travis Fischer 012f488931 2025-07-16 13:57:03 -04:00
..
src 2025-07-16 13:57:03 -04:00
.env.example feat: add s3/r2 storage support to backend api and api-client 2025-07-02 04:58:30 -05:00
drizzle.config.ts
package.json chore: release v8.4.3 2025-07-08 19:37:35 -07:00
readme.md feat: add s3/r2 storage support to backend api and api-client 2025-07-02 04:58:30 -05:00
tsconfig.json
tsup.config.ts
vitest.config.ts

readme.md

Agentic

Build Status Prettier Code Formatting

Agentic API

Backend API for the Agentic platform.

Dependencies

  • Postgres
    • DATABASE_URL - Postgres connection string
    • On macOS: brew install postgresql && brew services start postgresql
    • You'll need to run pnpm drizzle-kit push to set up your database schema
  • S3 - Required to use file attachments
    • Any S3-compatible provider is supported, such as Cloudflare R2
    • Alterantively, you can use a local S3 server like MinIO or LocalStack
      • To run LocalStack on macOS: brew install localstack/tap/localstack-cli && localstack start -d
      • To run MinIO macOS: brew install minio/stable/minio && minio server /data
    • I recommend using Cloudflare R2, though – it's amazing and should be free for most use cases!
    • S3_BUCKET - Required
    • S3_REGION - Optional; defaults to auto
    • S3_ENDPOINT - Required; example: https://<id>.r2.cloudflarestorage.com
    • ACCESS_KEY_ID - Required (cloudflare R2 docs)
    • SECRET_ACCESS_KEY - Required (cloudflare R2 docs)

License

GNU AGPL 3.0