Create agent
Create a new agent with the specified model, instructions, tools, and knowledge bases. Supports fallback models and configurable execution settings.
Authorizations
Body
The path where the agent will be stored in the project structure. The first element identifies the project, followed by nested folders (auto-created as needed).
With project-based API keys, the first element is treated as a folder name, as the project is predetermined by the API key.
"Default Project"
A model ID string (e.g., openai/gpt-5.6-sol or anthropic/claude-sonnet-5). The agent can be run with a wide range of models with different capabilities, performance characteristics, and price points. Only models that support tool calling (function_calling) can be used to run agents. See supported models documentation for the complete list of available models.
Optional array of fallback models used when the primary model fails. Fallbacks are attempted in order. All models must support tool calling.
A fallback model ID string (e.g., openai/gpt-4o-mini). Will be used if the primary model request fails. Must support tool calling.
Response
Agent successfully created and ready for use. Returns the complete agent manifest including the generated ID, configuration, and all settings.
The status of the agent. Live is the latest version of the agent. Draft is a version that is not yet published. Pending is a version that is pending approval. Published is a version that was live and has been replaced by a new version.
live, draft, pending, published Entity storage path.
With workspace-level API keys, use the format project/folder/subfolder/.... The first element must be the display name of an existing project, followed by nested folders (auto-created as needed). Example: Default Project/agents.
With project-level API keys, the project is predetermined by the API key, so the path is relative to that project. Example: agents. For backward compatibility, a leading project name is ignored when it matches the scoped project.
"Default Project"