跳转到内容
Agent as a BusinessAgent as a Business Documentation

概览

Agent as a Business 运行时 API 1.0.0

Section titled “Agent as a Business 运行时 API 1.0.0”

用于创建、调用、发布和运营 Agent Business 的运行时 API。兼容路径与 Schema 可能继续保留 Application 标识。

信息

  • OpenAPI 版本： 3.0.3

操作

Section titled “操作”
GET
/api/app/
POST
/api/app/
GET
/api/app/{app_slug}/analytics/invocations/
GET
/api/app/{app_slug}/analytics/performance/
GET
/api/app/{app_slug}/analytics/usage/
POST
/api/app/{app_slug}/chat-messages
POST
/api/app/{app_slug}/completion-messages
GET
/api/app/{app_slug}/single-agent/
PATCH
/api/app/{app_slug}/single-agent/
POST
/api/app/{app_slug}/single-agent/preview/
GET
/api/app/{app_slug}/workflow/tool-catalog/
GET
/api/app/{app_slug}/workflow/connections/
POST
/api/app/{app_slug}/workflow/connections/
GET
/api/app/{app_slug}/workflow/connections/recovery/{mutation_id}/
DELETE
/api/app/{app_slug}/workflow/connections/{connection_id}/
PATCH
/api/app/{app_slug}/workflow/connections/{connection_id}/
POST
/api/app/{app_slug}/workflow/connections/{connection_id}/test/
POST
/api/app/{app_slug}/workflows/run
POST
/api/app/{app_slug}/create-payment-intent/
GET
/api/app/{app_slug}/payment-methods/
POST
/api/app/{app_slug}/payment-methods/
GET
/api/app/{app_slug}/payment-methods/{id}/
PUT
/api/app/{app_slug}/payment-methods/{id}/
DELETE
/api/app/{app_slug}/payment-methods/{id}/
PATCH
/api/app/{app_slug}/payment-methods/{id}/
POST
/api/app/{app_slug}/payment-methods/{id}/set_default/
GET
/api/app/{app_slug}/subscriptions/
POST
/api/app/{app_slug}/subscriptions/
GET
/api/app/{app_slug}/subscriptions/{id}/
PUT
/api/app/{app_slug}/subscriptions/{id}/
DELETE
/api/app/{app_slug}/subscriptions/{id}/
PATCH
/api/app/{app_slug}/subscriptions/{id}/
POST
/api/app/{app_slug}/subscriptions/{id}/cancel/
POST
/api/app/{app_slug}/upload/
GET
/api/app/{app_slug}/usage/
GET
/api/app/{app_slug}/usage/{id}/
GET
/api/app/{slug}/
PUT
/api/app/{slug}/
DELETE
/api/app/{slug}/
PATCH
/api/app/{slug}/
POST
/api/app/{slug}/duplicate/
PATCH
/api/app/{slug}/update_status/
POST
/api/app/create_prompt/
POST
/api/app/create_workflow/
GET
/api/app/my_prompts/
GET
/api/app/my_workflows/
GET
/api/app/public_applications/
POST
/api/auth/logout/
GET
/api/auth/profile/
PATCH
/api/auth/profile/
GET
/api/auth/roles/
POST
/api/create-payment-intent/
GET
/api/creators/
POST
/api/creators/
GET
/api/creators/{id}/
PUT
/api/creators/{id}/
DELETE
/api/creators/{id}/
PATCH
/api/creators/{id}/
GET
/api/creators/me/
GET
/api/packages/
GET
/api/packages/{id}/
GET
/api/schema/

身份验证

Section titled “身份验证”

creatorBearerAuth

Section titled “creatorBearerAuth”

仅转发到已配置身份验证器的创作者凭据。生产 Logto 使用 Access Token；配置的 Better Auth 验证器也可以接受 Authorization。禁止使用公开 pk_app_ Runtime Token。

安全方案类型： http

Bearer format: Logto access token

creatorSessionCookieAuth

Section titled “creatorSessionCookieAuth”

转发到已配置 Session 验证器的创作者 Better Auth Session Cookie。规范的非安全名称是 better-auth.session_token；HTTPS 或自定义部署可能使用 __Secure-better-auth.session_token 或其他配置名称，并由浏览器自动发送。

安全方案类型： apiKey

Cookie 参数名称： better-auth.session_token

runtimeBearerAuth

Section titled “runtimeBearerAuth”

限定到 Agent Business 的公开运行时 Token。

安全方案类型： http

Bearer format: pk_app_

runtimeApiKeyAuth

Section titled “runtimeApiKeyAuth”

通过兼容 API Key Header 发送、限定到 Agent Business 的公开运行时 Token。

安全方案类型： apiKey

请求头参数名称： X-API-Key

cookieAuth

Section titled “cookieAuth”

安全方案类型： apiKey

Cookie 参数名称： sessionid

tokenAuth

Section titled “tokenAuth”

基于 Token 的身份验证，必须使用前缀“Token”

安全方案类型： apiKey

请求头参数名称： Authorization