List of Agent Platform APIs¶
Agentic App APIs¶
The following APIs let users interact with agents and manage sessions.
| Use Cases | APIs |
|---|---|
| Create, retrieve, or end a session with an agent to maintain conversation context. | Sessions API |
| Send user input to an agent within a session and receive the agent's response. | Runs API |
| Upload or delete attachments to a conversation. You can reference these attachments as context during an agent run. | File Attachment APIs |
| Create a new Agentic App. | Create App API |
File Management API¶
| Use Cases | API |
|---|---|
| Upload a small or large public file in the supported formats. | File Upload API |
View Process Status API¶
| Use Cases | API |
|---|---|
| Check the status of an ongoing or completed job related to tools or models. | Get Dock Status API |
Manage Tools APIs¶
| Use Cases | APIs |
|---|---|
| Import a new tool. | Import a New Tool API |
| Import new configurations, datasets, or updates into a tool. | Import to an Existing Tool API |
| Export a tool's configuration and associated data, including its flow, for backup, sharing, or reuse. | Export a Tool API |
| Deploy a specific tool into an environment. | Deploy a Tool API |
| Undeploy a specific tool from an environment. | Undeploy a Tool API |
Manage Models APIs¶
| Use Cases | APIs |
|---|---|
| Import a model in chunks. | Import a Model API |
| Export a trained AI model. | Export a Model API |
| Deploy a model into the environment in the Ready to Deploy state and configure its parameters. You must perform the initial deployment manually in the Agent Platform account. Consecutive deployments must happen via the public API. | Deploy a Model API |
| Undeploy a model from the environment. | Undeploy a Model API |
| Manage external model connections. | External Model Connection APIs |
Manage Guardrails APIs¶
| Use Cases | APIs |
|---|---|
| Deploy predefined guardrails. | Deploy Guardrails API |
| Undeploy predefined guardrails. | Undeploy Guardrails API |