SPB Git

Repository Public

agent-builder.md 4.6 KB 84 lines markdown

1# Agent Builder23> For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL.45**Agent Builder** is a visual canvas for building multi-step agent workflows.67You can start from templates, drag and drop nodes for each step in your workflow, provide typed inputs and outputs, and preview runs using live data. When you're ready to deploy, embed the workflow into your site with ChatKit, or download the SDK code to run it yourself.89OpenAI is deprecating Agent Builder. Existing users can continue using it10  during the transition window, and the product is scheduled to shut down on11  November 30, 2026. ChatKit remains available. See the [deprecations12  page](https://developers.openai.com/api/docs/deprecations#2026-06-03-agent-builder) for the current13  timeline.1415Use this guide to learn the process and parts of building agents.1617## Agents and workflows1819To build useful agents, you create workflows for them. A **workflow** is a combination of agents, tools, and control-flow logic. A workflow encapsulates all steps and actions involved in handling your tasks or powering your chats, with working code you can deploy when you're ready.20212223Open Agent Builder2425262728293031There are three main steps in building agents to handle tasks:32331. Design a workflow in [Agent Builder](https://platform.openai.com/agent-builder). This defines your agents and how they'll work.341. Publish your workflow. It's an object with an ID and versioning.351. Deploy your workflow. Pass the ID into your [ChatKit](https://developers.openai.com/api/docs/guides/chatkit) integration, or download the Agents SDK code to deploy your workflow yourself.3637## Compose with nodes3839In Agent Builder, insert and connect nodes to create your workflow. Each connection between nodes becomes a typed edge. Click a node to configure its inputs and outputs, observe the data contract between steps, and ensure downstream nodes receive the properties they expect.4041### Examples and templates4243Agent Builder provides templates for common workflow patterns. Start with a template to see how nodes work together, or start from scratch.4445Here's a homework helper workflow. It uses agents to take questions, reframe them for better answers, route them to other specialized agents, and return an answer.4647![prompts chat](https://cdn.openai.com/API/docs/images/homework-helper2.png)4849### Available nodes5051Nodes are the building blocks for agents. To see all available nodes and their configuration options, see the [node reference documentation](https://developers.openai.com/api/docs/guides/node-reference).5253### Preview and debug5455As you build, you can test your workflow by using the **Preview** feature. Here, you can interactively run your workflow, attach sample files, and observe the execution of each node.5657### Safety and risks5859Building agent workflows comes with risks, like prompt injection and data leakage. See [safety in building agents](https://developers.openai.com/api/docs/guides/agent-builder-safety) to learn about and help mitigate the risks of agent workflows.6061### Evaluate your workflow6263Run [trace graders](https://developers.openai.com/api/docs/guides/trace-grading) inside of Agent Builder. In the top navigation, click **Evaluate**. Here, you can select a trace (or set of traces) and run custom graders to assess overall workflow performance.6465## Publish your workflow6667Agent Builder autosaves your work as you go. When you're happy with your workflow, publish it to create a new major version that acts as a snapshot. You can then use your workflow in [ChatKit](https://developers.openai.com/api/docs/guides/chatkit), an OpenAI framework for embedding chat experiences.6869You can create new versions or specify an older version in your API calls.7071## Deploy in your product7273When you're ready to implement the agent workflow you created, click **Code** in the top navigation. You have two options for implementing your workflow in production:7475**ChatKit**: Follow the [ChatKit quickstart](https://developers.openai.com/api/docs/guides/chatkit) and pass in your workflow ID to embed this workflow into your application. If you're not sure, we recommend this option.7677**Advanced integration**: Copy the workflow code and use it anywhere. You can run ChatKit on your own infrastructure and use the Agents SDK to build and customize agent chat experiences.7879## Next steps8081Now that you've created an agent workflow, bring it into your product with ChatKit.8283- [ChatKit quickstart](https://developers.openai.com/api/docs/guides/chatkit) →84- [Advanced integration](https://developers.openai.com/api/docs/guides/custom-chatkit) →
Files main
Menu

Theme