Skip to content

docs: add graph execution example to API guide#9276

Open
wunianze666-netizen wants to merge 2 commits into
invoke-ai:mainfrom
wunianze666-netizen:docs/add-api-graph-execution-guide
Open

docs: add graph execution example to API guide#9276
wunianze666-netizen wants to merge 2 commits into
invoke-ai:mainfrom
wunianze666-netizen:docs/add-api-graph-execution-guide

Conversation

@wunianze666-netizen

Copy link
Copy Markdown

Summary

This PR adds a small programmatic graph-execution section to the API guide.

Motivation

While reviewing the API docs, I noticed there is already good endpoint coverage, but it is still easy to get stuck on one key distinction: saved workflows are not executed directly, while enqueue_batch expects an executable graph. This came up in #8340, where a user could fetch workflows but was unsure how to actually run them through the HTTP API.

Changes

  • add a short explanation of workflow vs executable graph
  • add a minimal enqueue_batch example using a simple math graph
  • document how to poll queue item status and where image outputs can be downloaded
  • note that multi-user mode requires a Bearer token on these requests

Testing

  • Not run: documentation-only change.

Notes

This is intended as a small and focused documentation improvement. I am happy to adjust the wording or scope if needed.

@github-actions github-actions Bot added the docs PRs that change docs label Jun 8, 2026
@Pfannkuchensack

Copy link
Copy Markdown
Collaborator

Isn't there a better place for this than in the MultiUser documentation?

@wunianze666-netizen

Copy link
Copy Markdown
Author

Thanks, that makes sense. I moved the graph-execution example out of the Multi-User API docs into a dedicated development guide, and left a short pointer in the original page for multi-user readers who land there first.

@lstein lstein left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution.

@lstein lstein self-assigned this Jun 17, 2026
@lstein lstein added the 6.13.5 Library Updates label Jun 17, 2026
@lstein lstein moved this to 6.13.5 LIBRARY UPDATES in Invoke - Community Roadmap Jun 17, 2026
@lstein

lstein commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

@wunianze666-netizen Could you rebase this on the main branch and push it back here? The branch will need to be up to date with main in order to merge.

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

Labels

6.13.5 Library Updates docs PRs that change docs

Projects

Status: 6.13.5 LIBRARY UPDATES

Development

Successfully merging this pull request may close these issues.

3 participants