- You’re building in a language other than Node.js and want to use your graph through a hosted API endpoint
- You don’t want to manage graph execution directly and prefer a cloud-managed deployment that scales automatically.
Deploy your graph
To deploy your graph, you’ll need to have the Inworld CLI installed. Once installed, run the following command with the path to your graph file (for example,graph.ts). Once deployment completes, you’ll see the persistent endpoint URL printed in your console output.
| Command | Description |
|---|---|
--info | Check deployment information, status, and health metrics for an existing deployment |
--package-only | Package graph for deployment without actually deploying (creates graph-deployment.zip in current directory) |
--package-only ./my-deployment.zip | Package graph for deployment without actually deploying (creates graph-deployment.zip in custom output path) |
How it works
When you deploy a graph, Inworld creates a persistent endpoint - a stable URL that your clients can integrate with once. Here’s how it works:- Initial deployment: Creates the endpoint (e.g.,
https://api.inworld.ai/cloud/workspaces/[workspace-id]/graphs/[graph-id]/v1/graph) - Subsequent deployments: Update the graph behind the same endpoint
- Client experience: No changes needed - requests continue to work seamlessly
- Zero downtime: Updates happen instantly without service interruption
Best practices
- Test locally first: Always test your graph with
inworld servebefore deploying - Package and inspect: Use
--package-onlyto review what will be deployed - Deploy to cloud: Use the basic deploy command to create your persistent endpoint
- Verify deployment: Use
--infoto check deployment status and details
Having issues? Check the CLI Troubleshooting Guide for comprehensive setup, development, and deployment troubleshooting.