Agents
Agents
Agents
Create an Agent
agents.create(AgentCreateParams**kwargs) -> agentAPIAgentAgentCreateResponse
post/v2/gen-ai/agents
Delete an Agent
agents.delete(struuid) -> agentAPIAgentAgentDeleteResponse
delete/v2/gen-ai/agents/{uuid}
List Agents
agents.list(AgentListParams**kwargs) -> agentslistlinksAPILinksmetaAPIMetaAgentListResponse
get/v2/gen-ai/agents
Retrieve an Existing Agent
agents.retrieve(struuid) -> agentAPIAgentAgentRetrieveResponse
get/v2/gen-ai/agents/{uuid}
Update an Agent
agents.update(strpath_uuid, AgentUpdateParams**kwargs) -> agentAPIAgentAgentUpdateResponse
put/v2/gen-ai/agents/{uuid}
Update Agent Status
agents.update_status(strpath_uuid, AgentUpdateStatusParams**kwargs) -> agentAPIAgentAgentUpdateStatusResponse
put/v2/gen-ai/agents/{uuid}/deployment_visibility
API Agent
APIAgentclass
An Agent
API Agent API Key Info
APIAgentAPIKeyInfoclass
Agent API Key Info
API Agent Model
APIAgentModelclass
Description of a Model
API Anthropic API Key Info
APIAnthropicAPIKeyInfoclass
Anthropic API Key Info
API Deployment Visibility
APIDeploymentVisibilitytype
Literal["VISIBILITY_UNKNOWN", "VISIBILITY_DISABLED", "VISIBILITY_PLAYGROUND", 2 more]
- VISIBILITY_UNKNOWN: The status of the deployment is unknown
- VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests
- VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state
- VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet
- VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys
API OpenAI API Key Info
APIOpenAIAPIKeyInfoclass
OpenAI API Key Info
API Retrieval Method
APIRetrievalMethodtype
Literal["RETRIEVAL_METHOD_UNKNOWN", "RETRIEVAL_METHOD_REWRITE", "RETRIEVAL_METHOD_STEP_BACK", 2 more]
- RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown
- RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite
- RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back
- RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries
- RETRIEVAL_METHOD_NONE: The retrieval method is none
API Workspace
APIWorkspaceclass
AgentsAPI Keys
Create an Agent API Key
agents.api_keys.create(strpath_agent_uuid, APIKeyCreateParams**kwargs) -> api_key_infoAPIAgentAPIKeyInfoAPIKeyCreateResponse
post/v2/gen-ai/agents/{agent_uuid}/api_keys
Delete API Key for an Agent
agents.api_keys.delete(strapi_key_uuid, APIKeyDeleteParams**kwargs) -> api_key_infoAPIAgentAPIKeyInfoAPIKeyDeleteResponse
delete/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}
List Agent API Keys
agents.api_keys.list(stragent_uuid, APIKeyListParams**kwargs) -> api_key_infoslistlinksAPILinksmetaAPIMetaAPIKeyListResponse
get/v2/gen-ai/agents/{agent_uuid}/api_keys
Regenerate API Key for an Agent
agents.api_keys.regenerate(strapi_key_uuid, APIKeyRegenerateParams**kwargs) -> api_key_infoAPIAgentAPIKeyInfoAPIKeyRegenerateResponse
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate
Update API Key for an Agent
agents.api_keys.update(strpath_api_key_uuid, APIKeyUpdateParams**kwargs) -> api_key_infoAPIAgentAPIKeyInfoAPIKeyUpdateResponse
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}
AgentsChat
AgentsChatCompletions
Creates a model response for the given chat conversation.
agents.chat.completions.create(CompletionCreateParams**kwargs) -> idstrchoiceslistcreatedintmodelstrobjectliteralusageCompletionUsageCompletionCreateResponse
post/chat/completions?agent=true
AgentsEvaluation Datasets
Create Evaluation Dataset
agents.evaluation_datasets.create(EvaluationDatasetCreateParams**kwargs) -> evaluation_dataset_uuidstrEvaluationDatasetCreateResponse
post/v2/gen-ai/evaluation_datasets
Create Presigned URLs for Evaluation Dataset File Upload
agents.evaluation_datasets.create_file_upload_presigned_urls(EvaluationDatasetCreateFileUploadPresignedURLsParams**kwargs) -> request_idstruploadslistEvaluationDatasetCreateFileUploadPresignedURLsResponse
post/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls
AgentsEvaluation Metrics
List Evaluation Metrics
agents.evaluation_metrics.list() -> metricslistEvaluationMetricListResponse
get/v2/gen-ai/evaluation_metrics
List Datacenter Regions
agents.evaluation_metrics.list_regions(EvaluationMetricListRegionsParams**kwargs) -> regionslistEvaluationMetricListRegionsResponse
get/v2/gen-ai/regions
AgentsEvaluation MetricsModels
List Available Models
agents.evaluation_metrics.models.list(ModelListParams**kwargs) -> linksAPILinksmetaAPIMetamodelslistModelListResponse
get/v2/gen-ai/models
AgentsEvaluation MetricsWorkspaces
Create a Workspace
agents.evaluation_metrics.workspaces.create(WorkspaceCreateParams**kwargs) -> workspaceAPIWorkspaceWorkspaceCreateResponse
post/v2/gen-ai/workspaces
Delete a Workspace
agents.evaluation_metrics.workspaces.delete(strworkspace_uuid) -> workspace_uuidstrWorkspaceDeleteResponse
delete/v2/gen-ai/workspaces/{workspace_uuid}
List Workspaces
agents.evaluation_metrics.workspaces.list() -> workspaceslistWorkspaceListResponse
get/v2/gen-ai/workspaces
List Evaluation Test Cases by Workspace
agents.evaluation_metrics.workspaces.list_evaluation_test_cases(strworkspace_uuid) -> evaluation_test_caseslistWorkspaceListEvaluationTestCasesResponse
get/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases
Retrieve an Existing Workspace
agents.evaluation_metrics.workspaces.retrieve(strworkspace_uuid) -> workspaceAPIWorkspaceWorkspaceRetrieveResponse
get/v2/gen-ai/workspaces/{workspace_uuid}
Update a Workspace
agents.evaluation_metrics.workspaces.update(strpath_workspace_uuid, WorkspaceUpdateParams**kwargs) -> workspaceAPIWorkspaceWorkspaceUpdateResponse
put/v2/gen-ai/workspaces/{workspace_uuid}
AgentsEvaluation MetricsWorkspacesAgents
List agents by Workspace
agents.evaluation_metrics.workspaces.agents.list(strworkspace_uuid, AgentListParams**kwargs) -> agentslistlinksAPILinksmetaAPIMetaAgentListResponse
get/v2/gen-ai/workspaces/{workspace_uuid}/agents
Move Agents to a Workspace
agents.evaluation_metrics.workspaces.agents.move(strpath_workspace_uuid, AgentMoveParams**kwargs) -> workspaceAPIWorkspaceAgentMoveResponse
put/v2/gen-ai/workspaces/{workspace_uuid}/agents
AgentsEvaluation Runs
Run an Evaluation Test Case
agents.evaluation_runs.create(EvaluationRunCreateParams**kwargs) -> evaluation_run_uuidslistEvaluationRunCreateResponse
post/v2/gen-ai/evaluation_runs
Retrieve Results of an Evaluation Run
agents.evaluation_runs.list_results(strevaluation_run_uuid, EvaluationRunListResultsParams**kwargs) -> evaluation_runAPIEvaluationRunlinksAPILinksmetaAPIMetapromptslistEvaluationRunListResultsResponse
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results
Retrieve Information About an Existing Evaluation Run
agents.evaluation_runs.retrieve(strevaluation_run_uuid) -> evaluation_runAPIEvaluationRunEvaluationRunRetrieveResponse
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}
Retrieve Results of an Evaluation Run Prompt
agents.evaluation_runs.retrieve_results(intprompt_id, EvaluationRunRetrieveResultsParams**kwargs) -> promptAPIEvaluationPromptEvaluationRunRetrieveResultsResponse
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}
API Evaluation Metric
APIEvaluationMetricclass
API Evaluation Metric Result
APIEvaluationMetricResultclass
API Evaluation Prompt
APIEvaluationPromptclass
API Evaluation Run
APIEvaluationRunclass
AgentsEvaluation Test Cases
Create Evaluation Test Case.
agents.evaluation_test_cases.create(EvaluationTestCaseCreateParams**kwargs) -> test_case_uuidstrEvaluationTestCaseCreateResponse
post/v2/gen-ai/evaluation_test_cases
List Evaluation Test Cases
agents.evaluation_test_cases.list() -> evaluation_test_caseslistEvaluationTestCaseListResponse
get/v2/gen-ai/evaluation_test_cases
List Evaluation Runs by Test Case
agents.evaluation_test_cases.list_evaluation_runs(strevaluation_test_case_uuid, EvaluationTestCaseListEvaluationRunsParams**kwargs) -> evaluation_runslistEvaluationTestCaseListEvaluationRunsResponse
get/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs
Retrieve Information About an Existing Evaluation Test Case
agents.evaluation_test_cases.retrieve(strtest_case_uuid, EvaluationTestCaseRetrieveParams**kwargs) -> evaluation_test_caseAPIEvaluationTestCaseEvaluationTestCaseRetrieveResponse
get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}
Update an Evaluation Test Case.
agents.evaluation_test_cases.update(strpath_test_case_uuid, EvaluationTestCaseUpdateParams**kwargs) -> test_case_uuidstrversionintEvaluationTestCaseUpdateResponse
put/v2/gen-ai/evaluation_test_cases/{test_case_uuid}
API Evaluation Test Case
APIEvaluationTestCaseclass
API Star Metric
APIStarMetricclass
AgentsFunctions
Add Function Route to an Agent
agents.functions.create(strpath_agent_uuid, FunctionCreateParams**kwargs) -> agentAPIAgentFunctionCreateResponse
post/v2/gen-ai/agents/{agent_uuid}/functions
Delete Function Route for an Agent
agents.functions.delete(strfunction_uuid, FunctionDeleteParams**kwargs) -> agentAPIAgentFunctionDeleteResponse
delete/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}
Update Function Route for an Agent
agents.functions.update(strpath_function_uuid, FunctionUpdateParams**kwargs) -> agentAPIAgentFunctionUpdateResponse
put/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}
AgentsKnowledge Bases
Attach Knowledge Bases to an Agent
agents.knowledge_bases.attach(stragent_uuid) -> agentAPIAgentAPILinkKnowledgeBaseOutput
post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases
Attach Knowledge Base to an Agent
agents.knowledge_bases.attach_single(strknowledge_base_uuid, KnowledgeBaseAttachSingleParams**kwargs) -> agentAPIAgentAPILinkKnowledgeBaseOutput
post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}
Detach Knowledge Base from an Agent
agents.knowledge_bases.detach(strknowledge_base_uuid, KnowledgeBaseDetachParams**kwargs) -> agentAPIAgentKnowledgeBaseDetachResponse
delete/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}
API Link Knowledge Base Output
APILinkKnowledgeBaseOutputclass
Information about a linked knowledge base
AgentsRoutes
Add Agent Route to an Agent
agents.routes.add(strpath_child_agent_uuid, RouteAddParams**kwargs) -> child_agent_uuidstrparent_agent_uuidstrRouteAddResponse
post/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
Delete Agent Route for an Agent
agents.routes.delete(strchild_agent_uuid, RouteDeleteParams**kwargs) -> child_agent_uuidstrparent_agent_uuidstrRouteDeleteResponse
delete/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
Update Agent Route for an Agent
agents.routes.update(strpath_child_agent_uuid, RouteUpdateParams**kwargs) -> child_agent_uuidstrparent_agent_uuidstrrollbackbooluuidstrRouteUpdateResponse
put/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
View Agent Routes
agents.routes.view(struuid) -> childrenlistRouteViewResponse
get/v2/gen-ai/agents/{uuid}/child_agents
AgentsVersions
List Agent Versions
agents.versions.list(struuid, VersionListParams**kwargs) -> agent_versionslistlinksAPILinksmetaAPIMetaVersionListResponse
get/v2/gen-ai/agents/{uuid}/versions
Rollback to Agent Version
agents.versions.update(strpath_uuid, VersionUpdateParams**kwargs) -> audit_headerAuditHeaderversion_hashstrVersionUpdateResponse
put/v2/gen-ai/agents/{uuid}/versions