Skip to content

docs: add agent app service api reference#836

Open
zyssyz123 wants to merge 1 commit into
mainfrom
docs/agent-app-service-api
Open

docs: add agent app service api reference#836
zyssyz123 wants to merge 1 commit into
mainfrom
docs/agent-app-service-api

Conversation

@zyssyz123

Copy link
Copy Markdown

Summary

  • Add a dedicated Agent App API OpenAPI reference for New Agent service API access.
  • Document the supported external service API endpoints: streaming chat, stop task, file upload, conversations, messages, parameters, info, and metadata.
  • Add the Agent App API group to the English Developer Resources API navigation.

Notes

  • This documents the end-user service API surface from DIFY-2537 / DIFY-2540.
  • Console API Access management endpoints still use agent_id, but public service API requests use the service API base URL and API key; agent_id is not part of the public service API path.

Validation

  • python -m json.tool docs.json
  • python -m json.tool en/api-reference/openapi_agent.json

@zyssyz123 zyssyz123 requested a review from RiskeyL as a code owner July 2, 2026 09:39
@dosubot dosubot Bot added size:XS This PR changes 0-9 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 2, 2026
@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
dify-core-product 🟢 Ready View Preview Jul 2, 2026, 9:50 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant