API overview

Plain API 还在 beta,字段可能变。锁版本生产用建议先 email hi@inplain.app。

Base URL

https://inplain.app/api

所有非公开端点要 Bearer token。两种:

PAT 在 inplain.app/account → API Keys 创建。

Endpoint	用途	Auth
`POST /api/agent`	自然语言 → deck/doc/sheet,流式 NDJSON	✓
`POST /api/agent/demo`	公开 demo(landing 用),5/天/IP 限流	—
`POST /api/render`	任意 source → HTML(交付的是链接,不是文件)	—
`POST /api/export`	source → HTML/PDF/PNG(web-native 导出)	✓
`GET/POST /api/workspace/documents`	CRUD documents	✓
`POST /api/brands`	上传公司 PPT/Doc/Sheet 模板(Office 只进不出)	✓
`POST /api/brands/[id]/generate`	用 brand 模板生成单份 artifact	✓
`POST /api/brands/[id]/batch`	批量生成 N 份 artifact → zip	✓
`POST /api/showcase/fork`	把 showcase demo 复制到自己工作区	✓
`POST /api/onboarding/seed`	现场为新用户生成三件套	✓
`POST /api/onboarding/reset`	清空工作区 + 重弹 welcome	✓

{ "error": "rate_limit_minute", "message": "请稍等一分钟再试" }

HTTP	error code	含义
400	`invalid_json` / `prompt_too_short`	请求参数不合法
401	`unauthorized`	没带 cookie 或 PAT
413	`prompt_too_long` / `file_too_large`	超长
429	`rate_limit_minute` / `rate_limit_day`	触发限流
5xx	`internal_error`	我们的锅,带 trace 联系我们

继续看: