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(RequestOptionsoptions?): EvaluationMetricListResponse { metrics }

get/v2/gen-ai/evaluation_metrics

List Datacenter Regions

client.agents.evaluationMetrics.listRegions(EvaluationMetricListRegionsParams { serves_batch, serves_inference } query?, RequestOptionsoptions?): EvaluationMetricListRegionsResponse { regions }

get/v2/gen-ai/regions

Evaluation MetricsWorkspaces

List Workspaces

client.agents.evaluationMetrics.workspaces.list(RequestOptionsoptions?): WorkspaceListResponse { workspaces }

get/v2/gen-ai/workspaces

Create a Workspace

client.agents.evaluationMetrics.workspaces.create(WorkspaceCreateParams { agent_uuids, description, name } body?, RequestOptionsoptions?): WorkspaceCreateResponse { workspace }

post/v2/gen-ai/workspaces

Retrieve an Existing Workspace

client.agents.evaluationMetrics.workspaces.retrieve(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceRetrieveResponse { workspace }

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

Delete a Workspace

client.agents.evaluationMetrics.workspaces.delete(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceDeleteResponse { workspace_uuid }

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

Update a Workspace

client.agents.evaluationMetrics.workspaces.update(stringworkspaceUuid, WorkspaceUpdateParams { description, name, workspace_uuid } body?, RequestOptionsoptions?): WorkspaceUpdateResponse { workspace }

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

List Evaluation Test Cases by Workspace

client.agents.evaluationMetrics.workspaces.listEvaluationTestCases(stringworkspaceUuid, RequestOptionsoptions?): WorkspaceListEvaluationTestCasesResponse { evaluation_test_cases }

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

Evaluation MetricsWorkspacesAgents

List agents by Workspace

client.agents.evaluationMetrics.workspaces.agents.list(stringworkspaceUuid, AgentListParams { only_deployed, page, per_page } query?, RequestOptionsoptions?): AgentListResponse { agents, links, meta }

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

Move Agents to a Workspace

client.agents.evaluationMetrics.workspaces.agents.move(stringworkspaceUuid, AgentMoveParams { agent_uuids, workspace_uuid } body?, RequestOptionsoptions?): AgentMoveResponse { workspace }

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

Evaluation MetricsAnthropic

Evaluation MetricsAnthropicKeys

List Anthropic API Keys

client.agents.evaluationMetrics.anthropic.keys.list(KeyListParams { page, per_page } query?, RequestOptionsoptions?): KeyListResponse { api_key_infos, links, meta }

get/v2/gen-ai/anthropic/keys

Create Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.create(KeyCreateParams { api_key, name } body?, RequestOptionsoptions?): KeyCreateResponse { api_key_info }

post/v2/gen-ai/anthropic/keys

Get Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.retrieve(stringapiKeyUuid, RequestOptionsoptions?): KeyRetrieveResponse { api_key_info }

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

Update Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.update(stringapiKeyUuid, KeyUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): KeyUpdateResponse { api_key_info }

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

Delete Anthropic API Key

client.agents.evaluationMetrics.anthropic.keys.delete(stringapiKeyUuid, RequestOptionsoptions?): KeyDeleteResponse { api_key_info }

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

List agents by Anthropic key

client.agents.evaluationMetrics.anthropic.keys.listAgents(stringuuid, KeyListAgentsParams { page, per_page } query?, RequestOptionsoptions?): KeyListAgentsResponse { agents, links, meta }

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

Evaluation MetricsOpenAI

Evaluation MetricsOpenAIKeys

List OpenAI API Keys

client.agents.evaluationMetrics.openai.keys.list(KeyListParams { page, per_page } query?, RequestOptionsoptions?): KeyListResponse { api_key_infos, links, meta }

get/v2/gen-ai/openai/keys

Create OpenAI API Key

client.agents.evaluationMetrics.openai.keys.create(KeyCreateParams { api_key, name } body?, RequestOptionsoptions?): KeyCreateResponse { api_key_info }

post/v2/gen-ai/openai/keys

Get OpenAI API Key

client.agents.evaluationMetrics.openai.keys.retrieve(stringapiKeyUuid, RequestOptionsoptions?): KeyRetrieveResponse { api_key_info }

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

Update OpenAI API Key

client.agents.evaluationMetrics.openai.keys.update(stringapiKeyUuid, KeyUpdateParams { api_key, api_key_uuid, name } body?, RequestOptionsoptions?): KeyUpdateResponse { api_key_info }

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

Delete OpenAI API Key

client.agents.evaluationMetrics.openai.keys.delete(stringapiKeyUuid, RequestOptionsoptions?): KeyDeleteResponse { api_key_info }

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

List agents by OpenAI key

client.agents.evaluationMetrics.openai.keys.listAgents(stringuuid, KeyListAgentsParams { page, per_page } query?, RequestOptionsoptions?): KeyListAgentsResponse { agents, links, meta }

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

Evaluation MetricsOauth2

Get Oauth2 URL

client.agents.evaluationMetrics.oauth2.generateURL(Oauth2GenerateURLParams { redirect_url, type } query?, RequestOptionsoptions?): Oauth2GenerateURLResponse { url }

get/v2/gen-ai/oauth2/url

Evaluation MetricsOauth2Dropbox

Get Oauth2 Dropbox Tokens

client.agents.evaluationMetrics.oauth2.dropbox.createTokens(DropboxCreateTokensParams { code, redirect_url } body?, RequestOptionsoptions?): DropboxCreateTokensResponse { token, refresh_token }

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

Evaluation MetricsScheduled Indexing

Create scheduled indexing for knowledge base

client.agents.evaluationMetrics.scheduledIndexing.create(ScheduledIndexingCreateParams { days, knowledge_base_uuid, time } body?, RequestOptionsoptions?): ScheduledIndexingCreateResponse { indexing_info }

post/v2/gen-ai/scheduled-indexing

Get Scheduled Indexing for Knowledge Base

client.agents.evaluationMetrics.scheduledIndexing.retrieve(stringknowledgeBaseUuid, RequestOptionsoptions?): ScheduledIndexingRetrieveResponse { indexing_info }

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

Delete Scheduled Indexing

client.agents.evaluationMetrics.scheduledIndexing.delete(stringuuid, RequestOptionsoptions?): ScheduledIndexingDeleteResponse { indexing_info }

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