Skip to content

docs: Add documentation for durable execution feature#2849

Closed
inkeep[bot] wants to merge 4 commits intomainfrom
docs-writer-ai-update-2026-03-26T20-17-19-063Z-kdj317
Closed

docs: Add documentation for durable execution feature#2849
inkeep[bot] wants to merge 4 commits intomainfrom
docs-writer-ai-update-2026-03-26T20-17-19-063Z-kdj317

Conversation

@inkeep
Copy link
Copy Markdown
Contributor

@inkeep inkeep Bot commented Mar 26, 2026

Summary

This PR adds documentation for the new durable execution feature introduced in #2615.

Changes

Chat API (agents-docs/content/talk-to-your-agents/chat-api.mdx)

  • Added x-workflow-run-id response header documentation for durable mode
  • Added tip callout explaining automatic durable execution when agent is configured in durable mode
  • Added new "Durable execution mode" subsection under Tool approval explaining how approvals work differently
  • Added comprehensive "Durable Executions" section covering:
    • All four executions endpoints (create, get status, reconnect stream, approve tool call)
    • cURL examples for creating executions and reconnecting to streams
    • Execution status response format with status descriptions table
  • Updated Development Notes to include /run/api/executions endpoint

Core Concepts (agents-docs/content/concepts.mdx)

  • Added new "Execution modes" section explaining:
    • Classic mode (default) - HTTP connection stays open
    • Durable mode - workflow-backed with reconnection support
    • When to use each mode
    • Link to configuration options

Tool Approvals - TypeScript SDK (agents-docs/content/typescript-sdk/tools/tool-approvals.mdx)

  • Added note in Runtime Behavior section about durable mode differences
  • Added new "Durable execution mode" subsection explaining:
    • How workflow suspends instead of holding connection
    • REST endpoint for approvals (POST /run/api/executions/:executionId/approvals/:toolCallId)
    • cURL examples for approving and denying tool calls
    • Automatic workflow resumption and stream reconnection

Tool Approvals - Visual Builder (agents-docs/content/visual-builder/tools/tool-approvals.mdx)

  • Added tip callout in Runtime behavior section about durable mode behavior

Related PR

inkeep Bot added 4 commits March 26, 2026 20:19
- Add x-workflow-run-id response header info to Endpoint section
- Add durable execution mode subsection under Tool approval
- Add new Durable Executions section with endpoint reference, status tracking, and stream reconnection
- Update Development Notes with executions endpoint
@inkeep inkeep Bot requested a review from anubra266 March 26, 2026 20:23
@vercel
Copy link
Copy Markdown

vercel Bot commented Mar 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agents-api Ready Ready Preview, Comment Mar 26, 2026 8:26pm
agents-docs Ready Ready Preview, Comment Mar 26, 2026 8:26pm
agents-manage-ui Ready Ready Preview, Comment Mar 26, 2026 8:26pm

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 26, 2026

⚠️ No Changeset found

Latest commit: e655a08

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant