API Reference
Archust Platform API — tRPC + REST (324 operations, 304 paths). Auth via Clerk JWT. Base URL /api/trpc.
API Reference
Tài liệu API tự động generate từ openapi.json — quét toàn bộ Archust/server/routers/* (60 routers) + app/api/** (18 REST). Đủ cho tenant sử dụng — không cần admin.
- 324 operations / 304 paths — Documents, Jobs, Job Instances, Drafts, Publishers, Chat (SSE), SEO (67 ops), SEO Plans (14), Analytics (22), Billing/Credits (14), Dashboard (6), Website Scan (22), Workflows (15), Media (10), Notifications (6), Settings/Team/TenantRules, Activity Log, Support, Features
- Auth:
Authorization: Bearer <Clerk JWT>+x-clerk-org-id.protectedProcedure→ tenant member;tenantAdmin→org:admin;admin→superadmin(chỉ/api/admin/*) - Credits:
documents.ingest/generation.blog/chat.messagecó reservation + idempotencyKey - Base URL:
https://app.archust.com— tRPC:POST /api/trpc/<router.procedure>(trong docs map sang/v1/*để dễ đọc,x-trpcghi procedure gốc)
Documents
Knowledge base & RAG — upload, ingest, chunks (14 ops)
Jobs
Tạo & schedule job, trigger, bulk (25 ops)
Job Instances
Scheduled instances — skip, generate, stats
Drafts
Vòng đời draft + review + publish (21 ops)
Publishers
WordPress / Webflow / Ghost / Shopify / Haravan / Webhook (14 ops)
Chat
Conversations + SSE stream + websearch quota (15 ops)
SEO
Control Center, audits, GSC, actions, rank, geo (67 ops)
SEO Plans
Monthly planning — readiness, draft, approve (14 ops)
Analytics
Content / automation / AI usage — overview, posts, distribution
Website Scan
Crawler & intelligence snapshots (22 ops)
Workflows
Generation pipeline — retry node, duplicate run
Media
Assets & rights — upload, attach, confirm
Billing & Credits
Stripe, quota, reservations, checkout
Team & Settings
Members, brand voice, tenant rules
Notifications
Preferences, mark read, unread count
OpenAPI JSON
Raw spec — 304 paths
Regenerate:
bun run generate:openapisau khi đổiserver/routers/*— spec sync tự động.
Quy ước Tenant
- Tenant member (
org:member): đọc + tạo draft, trigger job, chat, xem analytics - Tenant admin (
org:admin): quản lý jobs, publishers, documents bulk, team, settings, seo connect - Public:
GET /api/blogs(x-tenant-id),POST /api/contactkhông cần auth - Admin:
/api/admin/*vàadmin.*tRPC chỉ superadmin — không cần cho tenant
Pagination & Errors
Tất cả list/page trả { data, total, page, limit } hoặc { data, total }. Lỗi chuẩn TRPCError code UNAUTHORIZED/FORBIDDEN/NOT_FOUND/BAD_REQUEST/CONFLICT/TOO_MANY_REQUESTS.