API 参考

按资源归属分层的 AppForges API。所有接口以 /v1/ 作为主版本;细粒度演进通过 API-Version: YYYY-MM-DD header 承载。顶部的「身份 × 凭据」筛选会在你浏览时按当前选择隐藏不兼容的接口。

10 services · 53 operations · spec v0.59.4

POST/v1/creative/assets
StableAssetService.UploadAsset
直接上传小文件(建议 < 4MB),文件数据通过 gRPC 消息体传输。大文件请使用预签名上传流程。
identity:useridentity:orgcred:oauth2cred:api_keycreative:write
POST/v1/creative/assets/sign-urls
StableAssetService.SignAssetUrls
对已缓存 object_key 的资产,重新生成预签名访问 URL(原 URL 已过期或即将过期时使用)。
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
POST/v1/creative/platform-accounts/verify
StablePublishService.VerifyPlatformAccount
验证平台账号凭证是否有效,可在正式绑定或发布前检查凭证可用性。
identity:useridentity:orgcred:oauth2cred:api_keycreative:write
POST/v1/creative/wechat-mp/articles
BetaPublishService.PublishToWechatMp
直接把 Markdown 或 HTML 内容发布到微信公众号——一站式完成正文预处理、封面上传、创建或更新草稿,并可选触发群发;适合 CLI 工具直接调用的场景。
identity:useridentity:orgcred:oauth2cred:api_keycreative:writecreative:publish
GET/v1/creative/template-presets
StableTemplateService.ListPresets
列出当前用户的所有自定义预设。
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
GET/v1/creative/templates
StableTemplateService.ListTemplates
列出所有系统排版模板。
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
GET/v1/creative/templates/{template_id}/prompt
StableTemplateService.GetPromptTemplate
获取指定模板的排版提示词。提示词描述了该模板的排版规则,可直接用于 LLM 指令。
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
POST/v1/oauth/authorize
StableOAuthAuthorizationService.Authorize
用户在同意页授权后生成授权码。
identity:usercred:oauth2
POST/v1/oauth/introspect
StableOAuthAuthorizationService.IntrospectToken
查询 token 的有效性与元数据(RFC 7662)。
identity:nonecred:none
GET/v1/oauth/jwks
StableOAuthAuthorizationService.GetJWKS
返回当前活跃的 ID Token 签名公钥列表(JWKS 格式,RFC 7517 §5)。用于 OIDC 双 token 模型中 id_token (JWT, RS256) 的本地验签。
identity:nonecred:none
POST/v1/oauth/revoke
StableOAuthAuthorizationService.RevokeToken
吊销访问 token 或刷新 token(RFC 7009)。
identity:nonecred:none
POST/v1/oauth/token
StableOAuthAuthorizationService.Token
用授权码、刷新 token 或客户端凭证换取 token 对。
identity:nonecred:none
GET/v1/scopes
StableScopeService.ListScopes
列出所有可用的 scope,可按 category 过滤。
identity:nonecred:none
GET/v1/scopes/{name}
StableScopeService.GetScope
按名称查询单个 scope。
identity:nonecred:none
GET/v1/users/me
StableUserService.GetProfile
GetProfileRequest 是空消息——调用方身份完全由 OAuth access token 决定。URL 里的 `me` 是保留字,含义为"当前 token 持有者";用 `/v1/users/{user_id}` 替代会被拒绝为 403 PERMISSION_DENIED。
identity:usercred:oauth2cred:api_keyuser:profile:read
GET/v1/users/{user_id}/pinpage-categories
StableCategoryService.ListCategories
List one level of direct child categories.
identity:usercred:oauth2pinpage:read
DELETE/v1/users/{user_id}/pinpage-categories/{category_id}
StableCategoryService.DeleteCategory
Revoke a confirmed subtree and its pages, then schedule exact cleanup.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-categories/{category_id}:preview-deletion
StableCategoryService.PreviewCategoryDeletion
Produce a signed exact impact snapshot for one category subtree.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-categories:apply-organization
StableCategoryService.ApplyCategoryOrganization
Apply one unexpired settled preview without a second charge.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-categories:estimate-organization
StableCategoryService.EstimateCategoryOrganization
Create a durable estimate for one natural-language organization request.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-categories:preview-organization
StableCategoryService.PreviewCategoryOrganization
Consume an estimate and accept asynchronous organization planning.
identity:usercred:oauth2pinpage:write
GET/v1/users/{user_id}/pinpage-category-organization-jobs/{organization_job_id}
StableCategoryService.GetCategoryOrganizationJob
Return one user-requested category organization job.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-category-organization-jobs/{organization_job_id}/preview
StableCategoryService.GetCategoryOrganizationPreview
Return the durable settled preview produced by a successful job.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-category-preference
StableCategoryService.GetCategoryPreference
Return the user-scoped singleton category preference.
identity:usercred:oauth2pinpage:read
PUT/v1/users/{user_id}/pinpage-category-preference
StableCategoryService.UpdateCategoryPreference
Fully replace or explicitly clear the singleton category preference.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-jobs
StableJobService.CreateGeneration
Atomically freeze the user input and create a page plus generation job. Vertex owns LLM charging and quota admission; this request deliberately carries no quote, balance, budget, or user-authorized charge fields.
identity:usercred:oauth2pinpage:write
GET/v1/users/{user_id}/pinpage-jobs/{job_id}
StableJobService.GetJob
Return the authoritative state of one generation job.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-jobs/{job_id}/progress
StableJobService.GetGenerationProgress
Read current state and immutable history without triggering recovery.
identity:usercred:oauth2pinpage:read
POST/v1/users/{user_id}/pinpage-jobs/{job_id}:retry
StableJobService.RetryJob
Consume a RETRY_JOB estimate and create a new job with frozen input.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-jobs:estimate
StableJobService.EstimateGeneration
Create a durable, short-lived estimate without starting generation. Deprecated. New clients call CreateGeneration directly.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-jobs:submit
StableJobService.SubmitGeneration
Consume a CREATE_PAGE estimate and atomically create a page and job. Deprecated. New clients call CreateGeneration directly.
identity:usercred:oauth2pinpage:write
GET/v1/users/{user_id}/pinpage-pages
StablePageService.ListPages
List the user's recent pages or pages directly assigned to one category.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-pages/{page_id}
StablePageService.GetPage
Return one authoritative page without embedding version HTML.
identity:usercred:oauth2pinpage:read
DELETE/v1/users/{user_id}/pinpage-pages/{page_id}
StablePageService.DeletePage
Revoke page access and accept its exact content scope for cleanup.
identity:usercred:oauth2pinpage:write
GET/v1/users/{user_id}/pinpage-pages/{page_id}/instructions
StablePageService.ListPageInstructions
Read private requirements for an owned page; never includes system prompts.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-pages/{page_id}/prompt
StablePageService.GetPagePrompt
Read private requirements for an owned page; never includes system prompts.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-pages/{page_id}/versions
StablePageService.ListPageVersions
List immutable published-version summaries for one page.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}
StablePageService.GetPageVersion
Return one complete immutable version, including validated HTML.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}/exports/{export_id}
StablePageService.GetPageExport
Refresh the controlled download ticket for a published artifact.
identity:usercred:oauth2pinpage:read
GET/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}/metadata
StablePageService.GetPageVersionMetadata
Return authoritative published-version metadata without HTML or download tickets.
identity:usercred:oauth2pinpage:read
POST/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}:restore
StablePageService.RestorePageVersion
Make one immutable historical version current without creating a job.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-pages/{page_id}:preview-deletion
StablePageService.PreviewPageDeletion
Produce a signed, short-lived exact deletion-impact snapshot.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-pages/{page_id}:regenerate
StablePageService.RegeneratePage
Consume a REGENERATE_PAGE estimate and create a new logical job.
identity:usercred:oauth2pinpage:write
POST/v1/users/{user_id}/pinpage-pages/{page_id}:rename
StablePageService.RenamePage
Save a user display name without regenerating immutable artifacts.
identity:usercred:oauth2pinpage:write
GET/v1/users/{user_id}/pinpage-materials/{material_id}
StableUploadService.GetMaterial
Return one user-owned material's validation and parsing fact.
identity:usercred:oauth2pinpage:read
DELETE/v1/users/{user_id}/pinpage-materials/{material_id}
StableUploadService.DeleteMaterial
Revoke access to one unbound material and schedule cleanup.
identity:usercred:oauth2pinpage:write
GET/v1/users/{user_id}/pinpage-storage-protection
StableUploadService.GetStorageProtection
Return the user's authoritative hosted-content protection state.
identity:usercred:oauth2pinpage:read
POST/v1/users/{user_id}/pinpage-uploads
StableUploadService.CreateUpload
Consume one estimate item and create a durable multipart session.
identity:usercred:oauth2pinpage:upload
GET/v1/users/{user_id}/pinpage-uploads/{upload_id}
StableUploadService.GetUpload
Return and reconcile one durable multipart session.
identity:usercred:oauth2pinpage:upload
POST/v1/users/{user_id}/pinpage-uploads/{upload_id}:abort
StableUploadService.AbortUpload
Abort an unfinished multipart session without creating a material.
identity:usercred:oauth2pinpage:upload
POST/v1/users/{user_id}/pinpage-uploads/{upload_id}:complete
StableUploadService.CompleteUpload
Complete and verify multipart content, then create a material on success.
identity:usercred:oauth2pinpage:upload
POST/v1/users/{user_id}/pinpage-uploads/{upload_id}:sign-parts
StableUploadService.SignUploadParts
Sign short-lived PUT capabilities for explicitly requested parts.
identity:usercred:oauth2pinpage:upload
POST/v1/users/{user_id}/pinpage-uploads:estimate
StableUploadService.EstimateUpload
Create a durable file-service estimate before reserving or signing work.
identity:usercred:oauth2pinpage:upload
OpenAPI spec v0.59.4 · synced 10/11/2026, 11:27:14 PM