API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Evaluation Metrics

List Evaluation Metrics

client.Agents.EvaluationMetrics.List(ctx) (*AgentEvaluationMetricListResponse, error)

get/v2/gen-ai/evaluation_metrics

List Datacenter Regions

client.Agents.EvaluationMetrics.ListRegions(ctx, query) (*AgentEvaluationMetricListRegionsResponse, error)

get/v2/gen-ai/regions

Evaluation MetricsWorkspaces

List Workspaces

client.Agents.EvaluationMetrics.Workspaces.List(ctx) (*AgentEvaluationMetricWorkspaceListResponse, error)

get/v2/gen-ai/workspaces

Create a Workspace

client.Agents.EvaluationMetrics.Workspaces.New(ctx, body) (*AgentEvaluationMetricWorkspaceNewResponse, error)

post/v2/gen-ai/workspaces

Retrieve an Existing Workspace

client.Agents.EvaluationMetrics.Workspaces.Get(ctx, workspaceUuid) (*AgentEvaluationMetricWorkspaceGetResponse, error)

get/v2/gen-ai/workspaces/{workspace_uuid}

Delete a Workspace

client.Agents.EvaluationMetrics.Workspaces.Delete(ctx, workspaceUuid) (*AgentEvaluationMetricWorkspaceDeleteResponse, error)

delete/v2/gen-ai/workspaces/{workspace_uuid}

Update a Workspace

client.Agents.EvaluationMetrics.Workspaces.Update(ctx, workspaceUuid, body) (*AgentEvaluationMetricWorkspaceUpdateResponse, error)

put/v2/gen-ai/workspaces/{workspace_uuid}

List Evaluation Test Cases by Workspace

client.Agents.EvaluationMetrics.Workspaces.ListEvaluationTestCases(ctx, workspaceUuid) (*AgentEvaluationMetricWorkspaceListEvaluationTestCasesResponse, error)

get/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases

Evaluation MetricsWorkspacesAgents

List agents by Workspace

client.Agents.EvaluationMetrics.Workspaces.Agents.List(ctx, workspaceUuid, query) (*AgentEvaluationMetricWorkspaceAgentListResponse, error)

get/v2/gen-ai/workspaces/{workspace_uuid}/agents

Move Agents to a Workspace

client.Agents.EvaluationMetrics.Workspaces.Agents.Move(ctx, workspaceUuid, body) (*AgentEvaluationMetricWorkspaceAgentMoveResponse, error)

put/v2/gen-ai/workspaces/{workspace_uuid}/agents

Evaluation MetricsAnthropic

Evaluation MetricsAnthropicKeys

List Anthropic API Keys

client.Agents.EvaluationMetrics.Anthropic.Keys.List(ctx, query) (*AgentEvaluationMetricAnthropicKeyListResponse, error)

get/v2/gen-ai/anthropic/keys

Create Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.New(ctx, body) (*AgentEvaluationMetricAnthropicKeyNewResponse, error)

post/v2/gen-ai/anthropic/keys

Get Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.Get(ctx, apiKeyUuid) (*AgentEvaluationMetricAnthropicKeyGetResponse, error)

get/v2/gen-ai/anthropic/keys/{api_key_uuid}

Update Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.Update(ctx, apiKeyUuid, body) (*AgentEvaluationMetricAnthropicKeyUpdateResponse, error)

put/v2/gen-ai/anthropic/keys/{api_key_uuid}

Delete Anthropic API Key

client.Agents.EvaluationMetrics.Anthropic.Keys.Delete(ctx, apiKeyUuid) (*AgentEvaluationMetricAnthropicKeyDeleteResponse, error)

delete/v2/gen-ai/anthropic/keys/{api_key_uuid}

List agents by Anthropic key

client.Agents.EvaluationMetrics.Anthropic.Keys.ListAgents(ctx, uuid, query) (*AgentEvaluationMetricAnthropicKeyListAgentsResponse, error)

get/v2/gen-ai/anthropic/keys/{uuid}/agents

Evaluation MetricsOpenAI

Evaluation MetricsOpenAIKeys

List OpenAI API Keys

client.Agents.EvaluationMetrics.OpenAI.Keys.List(ctx, query) (*AgentEvaluationMetricOpenAIKeyListResponse, error)

get/v2/gen-ai/openai/keys

Create OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.New(ctx, body) (*AgentEvaluationMetricOpenAIKeyNewResponse, error)

post/v2/gen-ai/openai/keys

Get OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.Get(ctx, apiKeyUuid) (*AgentEvaluationMetricOpenAIKeyGetResponse, error)

get/v2/gen-ai/openai/keys/{api_key_uuid}

Update OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.Update(ctx, apiKeyUuid, body) (*AgentEvaluationMetricOpenAIKeyUpdateResponse, error)

put/v2/gen-ai/openai/keys/{api_key_uuid}

Delete OpenAI API Key

client.Agents.EvaluationMetrics.OpenAI.Keys.Delete(ctx, apiKeyUuid) (*AgentEvaluationMetricOpenAIKeyDeleteResponse, error)

delete/v2/gen-ai/openai/keys/{api_key_uuid}

List agents by OpenAI key

client.Agents.EvaluationMetrics.OpenAI.Keys.ListAgents(ctx, uuid, query) (*AgentEvaluationMetricOpenAIKeyListAgentsResponse, error)

get/v2/gen-ai/openai/keys/{uuid}/agents

Evaluation MetricsOauth2

Get Oauth2 URL

client.Agents.EvaluationMetrics.Oauth2.GenerateURL(ctx, query) (*AgentEvaluationMetricOauth2GenerateURLResponse, error)

get/v2/gen-ai/oauth2/url

Evaluation MetricsOauth2Dropbox

Get Oauth2 Dropbox Tokens

client.Agents.EvaluationMetrics.Oauth2.Dropbox.NewTokens(ctx, body) (*AgentEvaluationMetricOauth2DropboxNewTokensResponse, error)

post/v2/gen-ai/oauth2/dropbox/tokens

Evaluation MetricsScheduled Indexing

Create scheduled indexing for knowledge base

client.Agents.EvaluationMetrics.ScheduledIndexing.New(ctx, body) (*AgentEvaluationMetricScheduledIndexingNewResponse, error)

post/v2/gen-ai/scheduled-indexing

Get Scheduled Indexing for Knowledge Base

client.Agents.EvaluationMetrics.ScheduledIndexing.Get(ctx, knowledgeBaseUuid) (*AgentEvaluationMetricScheduledIndexingGetResponse, error)

get/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}

Delete Scheduled Indexing

client.Agents.EvaluationMetrics.ScheduledIndexing.Delete(ctx, uuid) (*AgentEvaluationMetricScheduledIndexingDeleteResponse, error)

delete/v2/gen-ai/scheduled-indexing/{uuid}