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

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 agent deployments

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