Files
Kokorone/.agents/skills/prisma-postgres/references/management-api.md
T
Jeffery f44200f543 feat: 完成 B 群組 — 資料層與核心領域模型
- 導入 Prisma 7.9.1 + SQLite(better-sqlite3 driver adapter),prisma.config.ts 管理連線設定
- 完整資料模型:User/Work/Character/CharacterAlias/EpisodicMemory/SemanticMemory/
  ProceduralRule/EmotionState/Relationship/SentimentLedgerEntry
- packages/db:Prisma Client 存取層(ESM,因 Prisma 7 產出的 generated client 僅支援 ESM)
- apps/api 隨之改為 ESM 以相容 packages/db
- packages/shared:新增角色/記憶/情緒/關係共用型別,api 與 web 皆從此匯入
- prisma/seed.ts:建立測試使用者與元氣型測試角色,含完整關係帳本與記憶種子資料
- apps/api:新增 GET /characters
- scripts/smoke/B.mjs:驗證資料表齊全、API 讀出種子角色、關係與記憶可寫入讀出
- 保留 Prisma 官方隨 CLI 附的 agent skill 文件(.agents/skills 等),供後續群組查閱

npm run restart && npm run smoke -- B 皆通過(B-V),A 群組冒煙測試無回歸。
2026-08-13 09:43:15 +08:00

3.2 KiB

management-api

Use Prisma Management API for programmatic provisioning and workspace/project/database management.

Priority

CRITICAL

Why It Matters

When you need backend automation, multi-tenant onboarding flows, or controlled resource provisioning, the Management API is the source of truth and is more reliable than interactive workflows.

Base URL

https://api.prisma.io/v1

API exploration

  • OpenAPI docs: https://api.prisma.io/v1/doc
  • Swagger Editor: https://api.prisma.io/v1/swagger-editor

Authentication methods

  • Service token: best for server-to-server operations in your own workspace
  • OAuth 2.0: best for acting on behalf of users across workspaces

Service token flow

  1. Create token in Prisma Console workspace settings.
  2. Send token as Bearer auth:
Authorization: Bearer $TOKEN

OAuth flow summary

  1. Redirect user to https://auth.prisma.io/authorize with client_id, redirect_uri, response_type=code, and scopes.
  2. Receive code on callback.
  3. Exchange code at https://auth.prisma.io/token.
  4. Use returned access token in Management API requests.

Resource model

Workspace -> Project -> Branch -> Database. Branches are a first-class resource: databases attach to a Branch, and branch-scoped env/databases are how preview isolation works.

Current resource inventory

The 1.55 OpenAPI surface includes:

  • workspaces, subscriptions, workspace integrations, workspace service tokens, and current-user metadata
  • projects, transfers, project databases, and project/branch environment variables
  • branches under a project plus branch get/update/delete operations
  • databases, usage, backups, restore, connections, and connection rotation
  • apps, deployments, promotion/rollback, runtime logs, domains, and build logs
  • buckets and bucket keys
  • source repositories, SCM installations/install intents, and repositories
  • integrations and regions

App/deployment, branch mutation, SCM, and bucket routes include experimental surfaces. Read the installed SDK types or live OpenAPI before building durable automation around them.

Connection create/rotate responses reveal credentials once. Later reads redact or omit the secret, so store the URL immediately. Use the structured direct/pooled endpoint returned by the concrete operation; do not assume a historical flat response shape.

Workspace service-token creation also returns the complete token value exactly once. List calls expose only metadata and a valueHint; delete revokes the token. Keep workspace and token ids opaque, and never log a create response.

Database create supports explicit project, region, branch, and source context. A source may be empty, a backup, or another database. Backup records are incremental; rely on current fields and documented units rather than old full-backup examples.

Notes

  • Management API mutation responses may include direct connection credentials; treat the entire response as secret until redacted.
  • Prefer an API-provided connection string over manually assembling one from fields.

References