Agents
APIs for creating and interacting with agentic systems.
Agents API (Experimental)โ
๐งช EXPERIMENTAL: This API is in preview and may change based on user feedback. Great for exploring new capabilities and providing feedback to influence the final design.
Main functionalities provided by this API:
- Create agents with specific instructions and ability to use tools.
- Interactions with agents are grouped into sessions ("threads"), and each interaction is called a "turn".
- Agents can be provided with various tools (see the ToolGroups and ToolRuntime APIs for more details).
- Agents can be provided with various shields (see the Safety API for more details).
- Agents can also use Memory to retrieve information from knowledge bases. See the RAG Tool and Vector IO APIs for more details.
๐งช Feedback Welcomeโ
This API is actively being developed. We welcome feedback on:
- API design and usability
- Performance characteristics
- Missing features or capabilities
- Integration patterns
Provide Feedback: GitHub Discussions or GitHub Issues
๐๏ธ List all agents.
List all agents.
๐๏ธ Create an agent with the given configuration.
Create an agent with the given configuration.
๐๏ธ Describe an agent by its ID.
Describe an agent by its ID.
๐๏ธ Delete an agent by its ID and its associated sessions and turns.
Delete an agent by its ID and its associated sessions and turns.
๐๏ธ Create a new session for an agent.
Create a new session for an agent.
๐๏ธ Retrieve an agent session by its ID.
Retrieve an agent session by its ID.
๐๏ธ Delete an agent session by its ID and its associated turns.
Delete an agent session by its ID and its associated turns.
๐๏ธ Create a new turn for an agent.
Create a new turn for an agent.
๐๏ธ Retrieve an agent turn by its ID.
Retrieve an agent turn by its ID.
๐๏ธ Resume an agent turn with executed tool call responses.
Resume an agent turn with executed tool call responses.
๐๏ธ Retrieve an agent step by its ID.
Retrieve an agent step by its ID.
๐๏ธ List all session(s) of a given agent.
List all session(s) of a given agent.