API Reference

Agents

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Evaluation Metrics

List Evaluation Metrics

agents.evaluation_metrics.list() -> EvaluationMetricListResponse

get/v2/gen-ai/evaluation_metrics

List Datacenter Regions

agents.evaluation_metrics.list_regions(EvaluationMetricListRegionsParams**kwargs) -> EvaluationMetricListRegionsResponse

get/v2/gen-ai/regions

Evaluation MetricsWorkspaces

List Workspaces

agents.evaluation_metrics.workspaces.list() -> WorkspaceListResponse

get/v2/gen-ai/workspaces

Create a Workspace

agents.evaluation_metrics.workspaces.create(WorkspaceCreateParams**kwargs) -> WorkspaceCreateResponse

post/v2/gen-ai/workspaces

Retrieve an Existing Workspace

agents.evaluation_metrics.workspaces.retrieve(strworkspace_uuid) -> WorkspaceRetrieveResponse

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

Delete a Workspace

agents.evaluation_metrics.workspaces.delete(strworkspace_uuid) -> WorkspaceDeleteResponse

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

Update a Workspace

agents.evaluation_metrics.workspaces.update(strpath_workspace_uuid, WorkspaceUpdateParams**kwargs) -> WorkspaceUpdateResponse

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

List Evaluation Test Cases by Workspace

agents.evaluation_metrics.workspaces.list_evaluation_test_cases(strworkspace_uuid) -> WorkspaceListEvaluationTestCasesResponse

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

Evaluation MetricsWorkspacesAgents

List agents by Workspace

agents.evaluation_metrics.workspaces.agents.list(strworkspace_uuid, AgentListParams**kwargs) -> AgentListResponse

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

Move Agents to a Workspace

agents.evaluation_metrics.workspaces.agents.move(strpath_workspace_uuid, AgentMoveParams**kwargs) -> AgentMoveResponse

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

Evaluation MetricsAnthropic

Evaluation MetricsAnthropicKeys

List Anthropic API Keys

agents.evaluation_metrics.anthropic.keys.list(KeyListParams**kwargs) -> KeyListResponse

get/v2/gen-ai/anthropic/keys

Create Anthropic API Key

agents.evaluation_metrics.anthropic.keys.create(KeyCreateParams**kwargs) -> KeyCreateResponse

post/v2/gen-ai/anthropic/keys

Get Anthropic API Key

agents.evaluation_metrics.anthropic.keys.retrieve(strapi_key_uuid) -> KeyRetrieveResponse

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

Update Anthropic API Key

agents.evaluation_metrics.anthropic.keys.update(strpath_api_key_uuid, KeyUpdateParams**kwargs) -> KeyUpdateResponse

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

Delete Anthropic API Key

agents.evaluation_metrics.anthropic.keys.delete(strapi_key_uuid) -> KeyDeleteResponse

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

List agents by Anthropic key

agents.evaluation_metrics.anthropic.keys.list_agents(struuid, KeyListAgentsParams**kwargs) -> KeyListAgentsResponse

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

Evaluation MetricsOpenAI

Evaluation MetricsOpenAIKeys

List OpenAI API Keys

agents.evaluation_metrics.openai.keys.list(KeyListParams**kwargs) -> KeyListResponse

get/v2/gen-ai/openai/keys

Create OpenAI API Key

agents.evaluation_metrics.openai.keys.create(KeyCreateParams**kwargs) -> KeyCreateResponse

post/v2/gen-ai/openai/keys

Get OpenAI API Key

agents.evaluation_metrics.openai.keys.retrieve(strapi_key_uuid) -> KeyRetrieveResponse

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

Update OpenAI API Key

agents.evaluation_metrics.openai.keys.update(strpath_api_key_uuid, KeyUpdateParams**kwargs) -> KeyUpdateResponse

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

Delete OpenAI API Key

agents.evaluation_metrics.openai.keys.delete(strapi_key_uuid) -> KeyDeleteResponse

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

List agents by OpenAI key

agents.evaluation_metrics.openai.keys.list_agents(struuid, KeyListAgentsParams**kwargs) -> KeyListAgentsResponse

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

Evaluation MetricsOauth2

Get Oauth2 URL

agents.evaluation_metrics.oauth2.generate_url(Oauth2GenerateURLParams**kwargs) -> Oauth2GenerateURLResponse

get/v2/gen-ai/oauth2/url

Evaluation MetricsOauth2Dropbox

Get Oauth2 Dropbox Tokens

agents.evaluation_metrics.oauth2.dropbox.create_tokens(DropboxCreateTokensParams**kwargs) -> DropboxCreateTokensResponse

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

Evaluation MetricsScheduled Indexing

Create scheduled indexing for knowledge base

agents.evaluation_metrics.scheduled_indexing.create(ScheduledIndexingCreateParams**kwargs) -> ScheduledIndexingCreateResponse

post/v2/gen-ai/scheduled-indexing

Get Scheduled Indexing for Knowledge Base

agents.evaluation_metrics.scheduled_indexing.retrieve(strknowledge_base_uuid) -> ScheduledIndexingRetrieveResponse

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

Delete Scheduled Indexing

agents.evaluation_metrics.scheduled_indexing.delete(struuid) -> ScheduledIndexingDeleteResponse

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