René's URL Explorer Experiment


Title: docs(api): guide for building and running workflows with the API by waleedlatif1 · Pull Request #9901 · simstudioai/sim · GitHub

Open Graph Title: docs(api): guide for building and running workflows with the API by waleedlatif1 · Pull Request #9901 · simstudioai/sim

X Title: docs(api): guide for building and running workflows with the API by waleedlatif1 · Pull Request #9901 · simstudioai/sim

Description: Summary Add an API guide that walks through building, dry-running, applying, testing, deploying, running, debugging, and resuming a workflow, with curl and sim CLI examples side by side and the Sim MCP equivalent. Linked both ways with the CLI workflows page (back-link added at its generator source). Point coding agents at the existing Sim skills for the step-by-step loop instead of adding a second, overlapping skill to the MCP plugin. X-Run-Id is documented as a one-shot claim (reuse returns 409 RUN_ID_CONFLICT), matching the contract. Test plan bun scripts/compile-content.ts in apps/docs (all pages compile, internal links valid) bun run check:cli-docs Review the rendered page at /api-reference/build-and-run-workflows

Open Graph Description: Summary Add an API guide that walks through building, dry-running, applying, testing, deploying, running, debugging, and resuming a workflow, with curl and sim CLI examples side by side and the Si...

X Description: Summary Add an API guide that walks through building, dry-running, applying, testing, deploying, running, debugging, and resuming a workflow, with curl and sim CLI examples side by side and the Si...

Opengraph URL: https://github.com/simstudioai/sim/pull/9901

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:f39a945b-8073-4e6b-260a-415666e75ded
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id998E:1D7E5A:DE4B22:1310C41:6AFB5C78
html-safe-nonceaf6b6413211c3228201dd8a35645a022c491b88fa31f97e8c7c433c0a03a2fad
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5OThFOjFEN0U1QTpERTRCMjI6MTMxMEM0MTo2QUZCNUM3OCIsInZpc2l0b3JfaWQiOiI1ODAyMTY4ODMzODcyNjAwMjQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac43f94915720fdb03b8824fc5c29bebd7f94c06e5185c28d857dd2cf74a3e4d00
hovercard-subject-tagpull_request:5267162316
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/simstudioai/sim/pull/9901/files
twitter:imagehttps://avatars.githubusercontent.com/u/40672544?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/40672544?s=400&v=4
og:image:altSummary Add an API guide that walks through building, dry-running, applying, testing, deploying, running, debugging, and resuming a workflow, with curl and sim CLI examples side by side and the Si...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Noneea33d13c96d0ff66bd8fa906b193d2213536b78cb06b0c50a4632c58b1418f94
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/simstudioai/sim git https://github.com/simstudioai/sim.git
octolytics-dimension-user_id199344406
octolytics-dimension-user_loginsimstudioai
octolytics-dimension-repository_id912559512
octolytics-dimension-repository_nwosimstudioai/sim
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id912559512
octolytics-dimension-repository_network_root_nwosimstudioai/sim
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release59ef97164c52cf59bd10558ddec9c4f482763988
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/simstudioai/sim/pull/9901/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fpull%2F9901%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fpull%2F9901%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=simstudioai%2Fsim
Reloadhttps://github.com/simstudioai/sim/pull/9901/files
Reloadhttps://github.com/simstudioai/sim/pull/9901/files
Reloadhttps://github.com/simstudioai/sim/pull/9901/files
simstudioaihttps://github.com/simstudioai
simhttps://github.com/simstudioai/sim
Codehttps://github.com/simstudioai/sim
Issues129 (129)https://github.com/simstudioai/sim/issues
Pull requests197 (197)https://github.com/simstudioai/sim/pulls
Actionshttps://github.com/simstudioai/sim/actions
Projectshttps://github.com/simstudioai/sim/projects
Security and qualityhttps://github.com/simstudioai/sim/security
Insightshttps://github.com/simstudioai/sim/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fsimstudioai%2Fsim%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fsimstudioai%2Fsim%2Fissues%2Fnew%2Fchoose
waleedlatif1https://github.com/waleedlatif1
staginghttps://github.com/simstudioai/sim/tree/staging
docs/agent-authoring-guidehttps://github.com/simstudioai/sim/tree/docs/agent-authoring-guide
Conversation 18 https://github.com/simstudioai/sim/pull/9901
Commits 4 https://github.com/simstudioai/sim/pull/9901/commits
Checks 83 https://github.com/simstudioai/sim/pull/9901/checks
Files changed https://github.com/simstudioai/sim/pull/9901/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/9901/files
docs(api): guide for building and running workflows with the API https://github.com/simstudioai/sim/pull/9901/files#top
Show all changes 4 commits https://github.com/simstudioai/sim/pull/9901/files
5b6908d docs(api): add a guide for building and running workflows with the API waleedlatif1 Nov 11, 2026 https://github.com/simstudioai/sim/pull/9901/commits/5b6908dae924b020aa4b630d3a46f3f8640cca1a
b2d4e57 docs(api): point the workflow guide at the Sim skills waleedlatif1 Nov 11, 2026 https://github.com/simstudioai/sim/pull/9901/commits/b2d4e5721e79ac7c8d4bc27481c08bc00c0a0d82
a7daebd docs(api): pass only the operations array to the CLI in the workflow … waleedlatif1 Nov 11, 2026 https://github.com/simstudioai/sim/pull/9901/commits/a7daebd38c71669c87507a12c97f82be1c662ab2
622b27f docs(api): keep polling while a run is redacting waleedlatif1 Nov 11, 2026 https://github.com/simstudioai/sim/pull/9901/commits/622b27fe2867c8c4561145aa071d1b5e0bcc4beb
Clear filters https://github.com/simstudioai/sim/pull/9901/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/9901/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/9901/files
build-and-run-workflows.mdx https://github.com/simstudioai/sim/pull/9901/files#diff-60d4a37761f0291b0ad947fa89603f524cae2148bff74d191d9201cf12d8e15b
meta.json https://github.com/simstudioai/sim/pull/9901/files#diff-7fcacbe6d5366f2ca7c322f5cbd75e9a6d7cf24e5ce6d2cc32b1ca3affc88303
workflows.mdx https://github.com/simstudioai/sim/pull/9901/files#diff-b38b4f49b582ee25593d5da516070296ade6a399be50daab25d6d8c050831863
generate-cli-docs.ts https://github.com/simstudioai/sim/pull/9901/files#diff-0aa378f7eeb9307d7d984a3774e4e932e57f7d7e0d685c03012706e7654b9515
apps/docs/content/docs/api-reference/build-and-run-workflows.mdxhttps://github.com/simstudioai/sim/pull/9901/files#diff-60d4a37761f0291b0ad947fa89603f524cae2148bff74d191d9201cf12d8e15b
View file https://github.com/simstudioai/sim/blob/622b27fe2867c8c4561145aa071d1b5e0bcc4beb/apps/docs/content/docs/api-reference/build-and-run-workflows.mdx
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/9901/{{ revealButtonHref }}
apps/docs/content/docs/api-reference/meta.jsonhttps://github.com/simstudioai/sim/pull/9901/files#diff-7fcacbe6d5366f2ca7c322f5cbd75e9a6d7cf24e5ce6d2cc32b1ca3affc88303
View file https://github.com/simstudioai/sim/blob/622b27fe2867c8c4561145aa071d1b5e0bcc4beb/apps/docs/content/docs/api-reference/meta.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/9901/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/9901/files#diff-7fcacbe6d5366f2ca7c322f5cbd75e9a6d7cf24e5ce6d2cc32b1ca3affc88303
https://github.com/simstudioai/sim/pull/9901/files#diff-7fcacbe6d5366f2ca7c322f5cbd75e9a6d7cf24e5ce6d2cc32b1ca3affc88303
apps/docs/content/docs/cli/workflows.mdxhttps://github.com/simstudioai/sim/pull/9901/files#diff-b38b4f49b582ee25593d5da516070296ade6a399be50daab25d6d8c050831863
View file https://github.com/simstudioai/sim/blob/622b27fe2867c8c4561145aa071d1b5e0bcc4beb/apps/docs/content/docs/cli/workflows.mdx
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/9901/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/9901/files#diff-b38b4f49b582ee25593d5da516070296ade6a399be50daab25d6d8c050831863
scripts/generate-cli-docs.tshttps://github.com/simstudioai/sim/pull/9901/files#diff-0aa378f7eeb9307d7d984a3774e4e932e57f7d7e0d685c03012706e7654b9515
View file https://github.com/simstudioai/sim/blob/622b27fe2867c8c4561145aa071d1b5e0bcc4beb/scripts/generate-cli-docs.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/9901/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/9901/files#diff-0aa378f7eeb9307d7d984a3774e4e932e57f7d7e0d685c03012706e7654b9515
https://github.com/simstudioai/sim/pull/9901/files#diff-0aa378f7eeb9307d7d984a3774e4e932e57f7d7e0d685c03012706e7654b9515
Please reload this pagehttps://github.com/simstudioai/sim/pull/9901/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.