Agent REST Endpoints

Sort by

Task Path Method

Agent

The operations from the Agent category.

Copy an Agent

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/actions/copy

Create an Agent

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents

Delete an Agent

Method: delete

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}

Delete an Agent Deployment.

Method: delete

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/deployments/{agentDeploymentKey}

Delete an Agent Session.

Method: delete

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/sessions/{sessionId}

Deploy an Agent.

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/deployments/actions/deploy

Get Agent deployment details.

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/deployments/{agentDeploymentKey}

Get Agent details

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}

Get Agent permissions

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/permissions

Get Agent Session chat messages

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/sessions/{sessionId}/chatHistory

Get Agent Session details

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/sessions/{sessionId}

Get Agent Session trace for a given message key

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/sessions/{sessionId}/traces/{traceKey}

Get Agents in schema

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents

List all deployments of an Agent.

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/deployments

List all test sessions of an agent.

Method: get

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/sessions

Preview agent card

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/actions/previewAgentCard

Redeploy an Agent.

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/deployments/actions/redeploy

Update agent card details

Method: put

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/actions/updateDeploymentMetadata

Update Agent permissions

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/actions/managePermission

Update an Agent

Method: put

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}

Validate Agent diagram

Method: post

Path: /20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/actions/validate