Skip to content

List of Agent Platform APIs

APIs for Agent Protocol

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
User input to an agent within a session and receives a response. Runs API
Upload or delete attachments to a conversation. These attachments can be referenced during an agent run as context. File Attachment APIs
Create a new Agentic App. Create App API

API for File Management

Use cases API
Upload a small or large public file in the supported formats. File Upload API

API to View Process Status

Use cases API
Check the status of an ongoing or completed job related to tools or models. Get Dock Status API

APIs to Manage Tools

Use cases APIs
Import a new tool into the system. Import a New Tool API
Import new configurations, datasets, or updates into an already existing tool within the system. Import to an Existing Tool API
Export an existing 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

APIs to Manage Models

Use cases APIs
Import a model in chunks into the system. Import a Model API
Export a trained AI model from the system. Export a Model API
Deploy a model into the environment in the Ready to Deploy state and configure its parameters. The initial deployment must be done 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

APIs to Manage Guardrails

Use cases APIs
Deploy predefined guardrails into the system. Deploy Guardrails API
Undeploy predefined guardrails from the system. Undeploy Guardrails API