API 參考
依資源歸屬分層的 AppForges API。所有介面以 /v1/ 作為主版本;細粒度演進透過 API-Version: YYYY-MM-DD header 承載。頂部的「身分 × 憑證」篩選會在你瀏覽時依當前選擇隱藏不相容的介面。
10 services · 53 operations · spec v0.59.4
POST
Stable/v1/creative/assetsAssetService.UploadAsset直接上傳小文件(建議 < 4MB),文件數據通過 gRPC 消息體傳輸。大文件請使用預簽名上傳流程。
identity:useridentity:orgcred:oauth2cred:api_keycreative:write
POST
Stable/v1/creative/assets/sign-urlsAssetService.SignAssetUrls對已緩存 object_key 的資產,重新生成預簽名訪問 URL(原 URL 已過期或即將過期時使用)。
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
POST
Stable/v1/creative/platform-accounts/verifyPublishService.VerifyPlatformAccount驗證平臺賬號憑證是否有效,可在正式綁定或發佈前檢查憑證可用性。
identity:useridentity:orgcred:oauth2cred:api_keycreative:write
POST
Beta/v1/creative/wechat-mp/articlesPublishService.PublishToWechatMp直接把 Markdown 內容發佈到微信公眾號——一站式完成 Markdown 渲染、封面上傳、創建或更新草稿,並可選觸發群發;適合 CLI 工具直接調用的場景。
identity:useridentity:orgcred:oauth2cred:api_keycreative:writecreative:publish
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
GET
Stable/v1/creative/templates/{template_id}/promptTemplateService.GetPromptTemplate獲取指定模板的排版提示詞。提示詞描述了該模板的排版規則,可直接用於 LLM 指令。
identity:useridentity:orgcred:oauth2cred:api_keycreative:read
identity:usercred:oauth2
POST
Stable/v1/oauth/introspectOAuthAuthorizationService.IntrospectToken查詢 token 的有效性與元數據(RFC 7662)。
identity:nonecred:none
GET
Stable/v1/oauth/jwksOAuthAuthorizationService.GetJWKS返回當前活躍的 ID Token 簽名公鑰列表(JWKS 格式,RFC 7517 §5)。用於 OIDC 雙 token 模型中 id_token (JWT, RS256) 的本地驗簽。
identity:nonecred:none
POST
Stable/v1/oauth/revokeOAuthAuthorizationService.RevokeToken吊銷訪問 token 或刷新 token(RFC 7009)。
identity:nonecred:none
identity:nonecred:none
identity:nonecred:none
identity:nonecred:none
GET
Stable/v1/users/meUserService.GetProfileGetProfileRequest 是空消息——調用方身份完全由 OAuth access token 決定。URL 裡的 `me` 是保留字,含義為"當前 token 持有者";用 `/v1/users/{user_id}` 替代會被拒絕為 403 PERMISSION_DENIED。
identity:usercred:oauth2cred:api_keyuser:profile:read
GET
Stable/v1/users/{user_id}/pinpage-categoriesCategoryService.ListCategoriesList one level of direct child categories.
identity:usercred:oauth2pinpage:read
DELETE
Stable/v1/users/{user_id}/pinpage-categories/{category_id}CategoryService.DeleteCategoryRevoke a confirmed subtree and its pages, then schedule exact cleanup.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-categories/{category_id}:preview-deletionCategoryService.PreviewCategoryDeletionProduce a signed exact impact snapshot for one category subtree.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-categories:apply-organizationCategoryService.ApplyCategoryOrganizationApply one unexpired settled preview without a second charge.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-categories:estimate-organizationCategoryService.EstimateCategoryOrganizationCreate a durable estimate for one natural-language organization request.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-categories:preview-organizationCategoryService.PreviewCategoryOrganizationConsume an estimate and accept asynchronous organization planning.
identity:usercred:oauth2pinpage:write
GET
Stable/v1/users/{user_id}/pinpage-category-organization-jobs/{organization_job_id}CategoryService.GetCategoryOrganizationJobReturn one user-requested category organization job.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-category-organization-jobs/{organization_job_id}/previewCategoryService.GetCategoryOrganizationPreviewReturn the durable settled preview produced by a successful job.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-category-preferenceCategoryService.GetCategoryPreferenceReturn the user-scoped singleton category preference.
identity:usercred:oauth2pinpage:read
PUT
Stable/v1/users/{user_id}/pinpage-category-preferenceCategoryService.UpdateCategoryPreferenceFully replace or explicitly clear the singleton category preference.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-jobsJobService.CreateGenerationAtomically 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
Stable/v1/users/{user_id}/pinpage-jobs/{job_id}JobService.GetJobReturn the authoritative state of one generation job.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-jobs/{job_id}/progressJobService.GetGenerationProgressRead current state and immutable history without triggering recovery.
identity:usercred:oauth2pinpage:read
POST
Stable/v1/users/{user_id}/pinpage-jobs/{job_id}:retryJobService.RetryJobConsume a RETRY_JOB estimate and create a new job with frozen input.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-jobs:estimateJobService.EstimateGenerationCreate a durable, short-lived estimate without starting generation.
Deprecated. New clients call CreateGeneration directly.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-jobs:submitJobService.SubmitGenerationConsume a CREATE_PAGE estimate and atomically create a page and job.
Deprecated. New clients call CreateGeneration directly.
identity:usercred:oauth2pinpage:write
GET
Stable/v1/users/{user_id}/pinpage-pagesPageService.ListPagesList the user's recent pages or pages directly assigned to one category.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}PageService.GetPageReturn one authoritative page without embedding version HTML.
identity:usercred:oauth2pinpage:read
DELETE
Stable/v1/users/{user_id}/pinpage-pages/{page_id}PageService.DeletePageRevoke page access and accept its exact content scope for cleanup.
identity:usercred:oauth2pinpage:write
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/instructionsPageService.ListPageInstructionsRead private requirements for an owned page; never includes system prompts.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/promptPageService.GetPagePromptRead private requirements for an owned page; never includes system prompts.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/versionsPageService.ListPageVersionsList immutable published-version summaries for one page.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}PageService.GetPageVersionReturn one complete immutable version, including validated HTML.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}/exports/{export_id}PageService.GetPageExportRefresh the controlled download ticket for a published artifact.
identity:usercred:oauth2pinpage:read
GET
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}/metadataPageService.GetPageVersionMetadataReturn authoritative published-version metadata without HTML or download tickets.
identity:usercred:oauth2pinpage:read
POST
Stable/v1/users/{user_id}/pinpage-pages/{page_id}/versions/{version_id}:restorePageService.RestorePageVersionMake one immutable historical version current without creating a job.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-pages/{page_id}:preview-deletionPageService.PreviewPageDeletionProduce a signed, short-lived exact deletion-impact snapshot.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-pages/{page_id}:regeneratePageService.RegeneratePageConsume a REGENERATE_PAGE estimate and create a new logical job.
identity:usercred:oauth2pinpage:write
POST
Stable/v1/users/{user_id}/pinpage-pages/{page_id}:renamePageService.RenamePageSave a user display name without regenerating immutable artifacts.
identity:usercred:oauth2pinpage:write
GET
Stable/v1/users/{user_id}/pinpage-materials/{material_id}UploadService.GetMaterialReturn one user-owned material's validation and parsing fact.
identity:usercred:oauth2pinpage:read
DELETE
Stable/v1/users/{user_id}/pinpage-materials/{material_id}UploadService.DeleteMaterialRevoke access to one unbound material and schedule cleanup.
identity:usercred:oauth2pinpage:write
GET
Stable/v1/users/{user_id}/pinpage-storage-protectionUploadService.GetStorageProtectionReturn the user's authoritative hosted-content protection state.
identity:usercred:oauth2pinpage:read
POST
Stable/v1/users/{user_id}/pinpage-uploadsUploadService.CreateUploadConsume one estimate item and create a durable multipart session.
identity:usercred:oauth2pinpage:upload
GET
Stable/v1/users/{user_id}/pinpage-uploads/{upload_id}UploadService.GetUploadReturn and reconcile one durable multipart session.
identity:usercred:oauth2pinpage:upload
POST
Stable/v1/users/{user_id}/pinpage-uploads/{upload_id}:abortUploadService.AbortUploadAbort an unfinished multipart session without creating a material.
identity:usercred:oauth2pinpage:upload
POST
Stable/v1/users/{user_id}/pinpage-uploads/{upload_id}:completeUploadService.CompleteUploadComplete and verify multipart content, then create a material on success.
identity:usercred:oauth2pinpage:upload
POST
Stable/v1/users/{user_id}/pinpage-uploads/{upload_id}:sign-partsUploadService.SignUploadPartsSign short-lived PUT capabilities for explicitly requested parts.
identity:usercred:oauth2pinpage:upload
POST
Stable/v1/users/{user_id}/pinpage-uploads:estimateUploadService.EstimateUploadCreate 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