Agents

Agents

Agents

agents

Methods

Create an Agent

post/v2/gen-ai/agents

To create a new agent, send a POST request to /v2/gen-ai/agents. The response body contains a JSON object with the newly created agent object.

Retrieve an Existing Agent

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

To retrieve details of an agent, GET request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.

Update an Agent

put/v2/gen-ai/agents/{uuid}

To update an agent, send a PUT request to /v2/gen-ai/agents/{uuid}. The response body is a JSON object containing the agent.

List Agents

get/v2/gen-ai/agents

To list all agents, send a GET request to /v2/gen-ai/agents.

Delete an Agent

delete/v2/gen-ai/agents/{uuid}

To delete an agent, send a DELETE request to /v2/gen-ai/agents/{uuid}.

Update Agent Status

put/v2/gen-ai/agents/{uuid}/deployment_visibility

Check whether an agent is public or private. To update the agent status, send a PUT request to /v2/gen-ai/agents/{uuid}/deployment_visibility.

Domain Types

API Agent

APIAgentobject

ShowShow

anthropic_api_keycreated_atstringcreated_bystringdeleted_atstringnamestringupdated_atstringuuidstringAPIAnthropicAPIKeyInfo

optional

api_key_infosarray of created_atstringcreated_bystringdeleted_atstringnamestringsecret_keystringuuidstringAPIAgentAPIKeyInfo

optional

api_keysarray of object

optional

Hide ParametersShow Parameters

api_keystring

optional

chatbotobject

optional

Hide ParametersShow Parameters

button_background_colorstring

optional

logostring

optional

namestring

optional

primary_colorstring

optional

secondary_colorstring

optional

starting_messagestring

optional

chatbot_identifiersarray of object

optional

Hide ParametersShow Parameters

agent_chatbot_identifierstring

optional

child_agentsarray of anthropic_api_keyAPIAnthropicAPIKeyInfoapi_key_infosarray of APIAgentAPIKeyInfoapi_keysarray of objectchatbotobjectchatbot_identifiersarray of objectchild_agentsarray of APIAgentcreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBasemax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringworkspaceAPIWorkspaceAPIAgent

optional

created_atstring

optional

formatdate-time

deploymentobject

optional

Hide ParametersShow Parameters

created_atstring

optional

formatdate-time

namestring

optional

statusenum

optional

"STATUS_UNKNOWN" OR "STATUS_WAITING_FOR_DEPLOYMENT" OR "STATUS_DEPLOYING" OR 6 more

Hide ParametersShow Parameters

"STATUS_UNKNOWN"

"STATUS_WAITING_FOR_DEPLOYMENT"

"STATUS_DEPLOYING"

"STATUS_RUNNING"

"STATUS_FAILED"

"STATUS_WAITING_FOR_UNDEPLOYMENT"

"STATUS_UNDEPLOYING"

"STATUS_UNDEPLOYMENT_FAILED"

"STATUS_DELETED"

updated_atstring

optional

formatdate-time

urlstring

optional

uuidstring

optional

visibilityAPIDeploymentVisibility

optional

descriptionstring

optional

functionsarray of object

optional

Hide ParametersShow Parameters

api_keystring

optional

created_atstring

optional

formatdate-time

created_bystring

optional

formatuint64

descriptionstring

optional

faas_namestring

optional

faas_namespacestring

optional

input_schemaunknown

optional

namestring

optional

output_schemaunknown

optional

updated_atstring

optional

formatdate-time

urlstring

optional

uuidstring

optional

guardrailsarray of object

optional

Hide ParametersShow Parameters

agent_uuidstring

optional

created_atstring

optional

formatdate-time

default_responsestring

optional

descriptionstring

optional

guardrail_uuidstring

optional

is_attachedboolean

optional

is_defaultboolean

optional

metadataunknown

optional

namestring

optional

prioritynumber

optional

formatint32

typeenum

optional

"GUARDRAIL_TYPE_UNKNOWN" OR "GUARDRAIL_TYPE_JAILBREAK" OR "GUARDRAIL_TYPE_SENSITIVE_DATA" OR "GUARDRAIL_TYPE_CONTENT_MODERATION"

Hide ParametersShow Parameters

"GUARDRAIL_TYPE_UNKNOWN"

"GUARDRAIL_TYPE_JAILBREAK"

"GUARDRAIL_TYPE_SENSITIVE_DATA"

"GUARDRAIL_TYPE_CONTENT_MODERATION"

updated_atstring

optional

formatdate-time

uuidstring

optional

if_casestring

optional

instructionstring

optional

Agent instruction. Instructions help your agent to perform its job effectively. See Write Effective Agent Instructions for best practices.

knumber

optional

formatint64

knowledge_basesarray of added_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase

optional

max_tokensnumber

optional

formatint64

modelagreementAPIAgreementcreated_atstringinference_namestringinference_versionstringis_foundationalbooleanmetadataunknownnamestringparent_uuidstringproviderenumupdated_atstringupload_completebooleanurlstringusecasesarray of enumuuidstringversionAPIModelVersionAPIAgentModel

optional

namestring

optional

openai_api_keycreated_atstringcreated_bystringdeleted_atstringmodelsarray of APIAgentModelnamestringupdated_atstringuuidstringAPIOpenAIAPIKeyInfo

optional

parent_agentsarray of anthropic_api_keyAPIAnthropicAPIKeyInfoapi_key_infosarray of APIAgentAPIKeyInfoapi_keysarray of objectchatbotobjectchatbot_identifiersarray of objectchild_agentsarray of APIAgentcreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBasemax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringworkspaceAPIWorkspaceAPIAgent

optional

project_idstring

optional

provide_citationsboolean

optional

regionstring

optional

retrieval_methodAPIRetrievalMethod

optional

route_created_atstring

optional

formatdate-time

route_created_bystring

optional

formatuint64

route_namestring

optional

route_uuidstring

optional

tagsarray of string

optional

temperaturenumber

optional

formatfloat

templateobject

optional

Hide ParametersShow Parameters

created_atstring

optional

formatdate-time

descriptionstring

optional

guardrailsarray of object

optional

Hide ParametersShow Parameters

prioritynumber

optional

formatint32

uuidstring

optional

instructionstring

optional

knumber

optional

formatint64

knowledge_basesarray of added_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase

optional

long_descriptionstring

optional

max_tokensnumber

optional

formatint64

modelagreementAPIAgreementcreated_atstringinference_namestringinference_versionstringis_foundationalbooleanmetadataunknownnamestringparent_uuidstringproviderenumupdated_atstringupload_completebooleanurlstringusecasesarray of enumuuidstringversionAPIModelVersionAPIAgentModel

optional

namestring

optional

short_descriptionstring

optional

summarystring

optional

tagsarray of string

optional

temperaturenumber

optional

formatfloat

template_typeenum

optional

"AGENT_TEMPLATE_TYPE_STANDARD" OR "AGENT_TEMPLATE_TYPE_ONE_CLICK"

Hide ParametersShow Parameters

"AGENT_TEMPLATE_TYPE_STANDARD"

"AGENT_TEMPLATE_TYPE_ONE_CLICK"

top_pnumber

optional

formatfloat

updated_atstring

optional

formatdate-time

uuidstring

optional

top_pnumber

optional

formatfloat

updated_atstring

optional

formatdate-time

urlstring

optional

user_idstring

optional

formatuint64

uuidstring

optional

workspaceagentsarray of APIAgentcreated_atstringcreated_bystringcreated_by_emailstringdeleted_atstringdescriptionstringevaluation_test_casesarray of APIEvaluationTestCasenamestringupdated_atstringuuidstringAPIWorkspace

optional

API Agent API Key Info

APIAgentAPIKeyInfoobject

ShowShow

created_atstring

optional

formatdate-time

created_bystring

optional

formatuint64

deleted_atstring

optional

formatdate-time

namestring

optional

secret_keystring

optional

uuidstring

optional

API Agent Model

APIAgentModelobject

ShowShow

agreementdescriptionstringnamestringurlstringuuidstringAPIAgreement

optional

created_atstring

optional

formatdate-time

inference_namestring

optional

inference_versionstring

optional

is_foundationalboolean

optional

metadataunknown

optional

namestring

optional

parent_uuidstring

optional

providerenum

optional

"MODEL_PROVIDER_DIGITALOCEAN" OR "MODEL_PROVIDER_ANTHROPIC" OR "MODEL_PROVIDER_OPENAI"

Hide ParametersShow Parameters

"MODEL_PROVIDER_DIGITALOCEAN"

"MODEL_PROVIDER_ANTHROPIC"

"MODEL_PROVIDER_OPENAI"

updated_atstring

optional

formatdate-time

upload_completeboolean

optional

urlstring

optional

usecasesarray of enum

optional

Hide ParametersShow Parameters

"MODEL_USECASE_UNKNOWN"

"MODEL_USECASE_AGENT"

"MODEL_USECASE_FINETUNED"

"MODEL_USECASE_KNOWLEDGEBASE"

"MODEL_USECASE_GUARDRAIL"

"MODEL_USECASE_REASONING"

"MODEL_USECASE_SERVERLESS"

uuidstring

optional

versionmajornumberminornumberpatchnumberAPIModelVersion

optional

API Anthropic API Key Info

APIAnthropicAPIKeyInfoobject

ShowShow

created_atstring

optional

formatdate-time

created_bystring

optional

formatuint64

deleted_atstring

optional

formatdate-time

namestring

optional

updated_atstring

optional

formatdate-time

uuidstring

optional

API Deployment Visibility

APIDeploymentVisibilityenum

ShowShow

"VISIBILITY_UNKNOWN"

"VISIBILITY_DISABLED"

"VISIBILITY_PLAYGROUND"

"VISIBILITY_PUBLIC"

"VISIBILITY_PRIVATE"

API OpenAI API Key Info

APIOpenAIAPIKeyInfoobject

ShowShow

created_atstring

optional

formatdate-time

created_bystring

optional

formatuint64

deleted_atstring

optional

formatdate-time

modelsarray of agreementAPIAgreementcreated_atstringinference_namestringinference_versionstringis_foundationalbooleanmetadataunknownnamestringparent_uuidstringproviderenumupdated_atstringupload_completebooleanurlstringusecasesarray of enumuuidstringversionAPIModelVersionAPIAgentModel

optional

namestring

optional

updated_atstring

optional

formatdate-time

uuidstring

optional

API Retrieval Method

APIRetrievalMethodenum

ShowShow

"RETRIEVAL_METHOD_UNKNOWN"

"RETRIEVAL_METHOD_REWRITE"

"RETRIEVAL_METHOD_STEP_BACK"

"RETRIEVAL_METHOD_SUB_QUERIES"

"RETRIEVAL_METHOD_NONE"

API Workspace

APIWorkspaceobject

ShowShow

agentsarray of anthropic_api_keyAPIAnthropicAPIKeyInfoapi_key_infosarray of APIAgentAPIKeyInfoapi_keysarray of objectchatbotobjectchatbot_identifiersarray of objectchild_agentsarray of APIAgentcreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBasemax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringworkspaceAPIWorkspaceAPIAgent

optional

created_atstring

optional

formatdate-time

created_bystring

optional

formatuint64

created_by_emailstring

optional

deleted_atstring

optional

formatdate-time

descriptionstring

optional

evaluation_test_casesarray of archived_atstringcreated_atstringcreated_by_user_emailstringcreated_by_user_idstringdataset_namestringdataset_uuidstringdescriptionstringlatest_version_number_of_runsnumbermetricsarray of APIEvaluationMetricnamestringstar_metricAPIStarMetrictest_case_uuidstringtotal_runsnumberupdated_atstringupdated_by_user_emailstringupdated_by_user_idstringversionnumberAPIEvaluationTestCase

optional

namestring

optional

updated_atstring

optional

formatdate-time

uuidstring

optional

AgentsAPI Keys

agents.api_keys

Methods

Create an Agent API Key

post/v2/gen-ai/agents/{agent_uuid}/api_keys

To create an agent API key, send a POST request to /v2/gen-ai/agents/{agent_uuid}/api_keys.

Update API Key for an Agent

put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

To update an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

List Agent API Keys

get/v2/gen-ai/agents/{agent_uuid}/api_keys

To list all agent API keys, send a GET request to /v2/gen-ai/agents/{agent_uuid}/api_keys.

Delete API Key for an Agent

delete/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

To delete an API key for an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}.

Regenerate API Key for an Agent

put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate

To regenerate an agent API key, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate.

AgentsChat

agents.chat

AgentsChatCompletions

agents.chat.completions

Methods

Creates a model response for the given chat conversation.

post/chat/completions?agent=true

Creates a model response for the given chat conversation.

AgentsEvaluation Datasets

agents.evaluation_datasets

Methods

Create Evaluation Dataset

post/v2/gen-ai/evaluation_datasets

To create an evaluation dataset, send a POST request to /v2/gen-ai/evaluation_datasets.

Create Presigned URLs for Evaluation Dataset File Upload

post/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls

To create presigned URLs for evaluation dataset file upload, send a POST request to /v2/gen-ai/evaluation_datasets/file_upload_presigned_urls.

AgentsEvaluation Metrics

agents.evaluation_metrics

Methods

List Evaluation Metrics

get/v2/gen-ai/evaluation_metrics

To list all evaluation metrics, send a GET request to /v2/gen-ai/evaluation_metrics.

AgentsEvaluation MetricsWorkspaces

agents.evaluation_metrics.workspaces

Methods

Create a Workspace

post/v2/gen-ai/workspaces

To create a new workspace, send a POST request to /v2/gen-ai/workspaces. The response body contains a JSON object with the newly created workspace object.

Retrieve an Existing Workspace

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

To retrieve details of a workspace, GET request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.

Update a Workspace

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

To update a workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.

List Workspaces

get/v2/gen-ai/workspaces

To list all workspaces, send a GET request to /v2/gen-ai/workspaces.

Delete a Workspace

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

To delete a workspace, send a DELETE request to /v2/gen-ai/workspace/{workspace_uuid}.

List Evaluation Test Cases by Workspace

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

To list all evaluation test cases by a workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases.

AgentsEvaluation MetricsWorkspacesAgents

agents.evaluation_metrics.workspaces.agents

Methods

List agents by Workspace

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

To list all agents by a Workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.

Move Agents to a Workspace

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

To move all listed agetns a given workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}/agents.

AgentsEvaluation Runs

agents.evaluation_runs

Methods

Run an Evaluation Test Case

post/v2/gen-ai/evaluation_runs

To run an evaluation test case, send a POST request to /v2/gen-ai/evaluation_runs.

Retrieve Information About an Existing Evaluation Run

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}

To retrive information about an existing evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}.

Retrieve Results of an Evaluation Run

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results

To retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results.

Retrieve Results of an Evaluation Run Prompt

get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}

To retrieve results of an evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}.

Domain Types

API Evaluation Metric

APIEvaluationMetricobject

ShowShow

descriptionstring

optional

metric_namestring

optional

metric_typeenum

optional

"METRIC_TYPE_UNSPECIFIED" OR "METRIC_TYPE_GENERAL_QUALITY" OR "METRIC_TYPE_RAG_AND_TOOL"

Hide ParametersShow Parameters

"METRIC_TYPE_UNSPECIFIED"

"METRIC_TYPE_GENERAL_QUALITY"

"METRIC_TYPE_RAG_AND_TOOL"

metric_uuidstring

optional

metric_value_typeenum

optional

"METRIC_VALUE_TYPE_UNSPECIFIED" OR "METRIC_VALUE_TYPE_NUMBER" OR "METRIC_VALUE_TYPE_STRING"

Hide ParametersShow Parameters

"METRIC_VALUE_TYPE_UNSPECIFIED"

"METRIC_VALUE_TYPE_NUMBER"

"METRIC_VALUE_TYPE_STRING"

API Evaluation Metric Result

APIEvaluationMetricResultobject

ShowShow

metric_namestring

optional

number_valuenumber

optional

The value of the metric as a number.

formatdouble

string_valuestring

optional

The value of the metric as a string.

API Evaluation Prompt

APIEvaluationPromptobject

ShowShow

ground_truthstring

optional

The ground truth for the prompt.

inputstring

optional

outputstring

optional

prompt_chunksarray of object

optional

The list of prompt chunks.

Hide ParametersShow Parameters

chunk_usage_pctnumber

optional

The usage percentage of the chunk.

formatdouble

chunk_usedboolean

optional

Indicates if the chunk was used in the prompt.

index_uuidstring

optional

The index uuid (Knowledge Base) of the chunk.

source_namestring

optional

The source name for the chunk, e.g., the file name or document title.

textstring

optional

Text content of the chunk.

prompt_idnumber

optional

formatint64

prompt_level_metric_resultsarray of metric_namestringnumber_valuenumberstring_valuestringAPIEvaluationMetricResult

optional

The metric results for the prompt.

API Evaluation Run

APIEvaluationRunobject

ShowShow

agent_deletedboolean

optional

agent_namestring

optional

agent_uuidstring

optional

Agent UUID.

agent_version_hashstring

optional

agent_workspace_uuidstring

optional

created_by_user_emailstring

optional

created_by_user_idstring

optional

formatuint64

error_descriptionstring

optional

evaluation_run_uuidstring

optional

Evaluation run UUID.

finished_atstring

optional

Run end time.

formatdate-time

pass_statusboolean

optional

The pass status of the evaluation run based on the star metric.

run_level_metric_resultsarray of metric_namestringnumber_valuenumberstring_valuestringAPIEvaluationMetricResult

optional

run_namestring

optional

Run name.

star_metric_resultmetric_namestringnumber_valuenumberstring_valuestringAPIEvaluationMetricResult

optional

started_atstring

optional

Run start time.

formatdate-time

statusenum

optional

"EVALUATION_RUN_STATUS_UNSPECIFIED" OR "EVALUATION_RUN_QUEUED" OR "EVALUATION_RUN_RUNNING_DATASET" OR 6 more

Hide ParametersShow Parameters

"EVALUATION_RUN_STATUS_UNSPECIFIED"

"EVALUATION_RUN_QUEUED"

"EVALUATION_RUN_RUNNING_DATASET"

"EVALUATION_RUN_EVALUATING_RESULTS"

"EVALUATION_RUN_CANCELLING"

"EVALUATION_RUN_CANCELLED"

"EVALUATION_RUN_SUCCESSFUL"

"EVALUATION_RUN_PARTIALLY_SUCCESSFUL"

"EVALUATION_RUN_FAILED"

test_case_uuidstring

optional

Test-case UUID.

test_case_versionnumber

optional

Test-case-version.

formatint64

AgentsEvaluation Test Cases

agents.evaluation_test_cases

Methods

Create Evaluation Test Case.

post/v2/gen-ai/evaluation_test_cases

To create an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases.

Retrieve Information About an Existing Evaluation Test Case

get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

To retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation_test_case/{test_case_uuid}.

Update an Evaluation Test Case.

post/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

To update an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases/{test_case_uuid}.

List Evaluation Test Cases

get/v2/gen-ai/evaluation_test_cases

To list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation_test_cases.

List Evaluation Runs by Test Case

get/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs

To list all evaluation runs by test case, send a GET request to /v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs.

Domain Types

API Evaluation Test Case

APIEvaluationTestCaseobject

ShowShow

archived_atstring

optional

formatdate-time

created_atstring

optional

formatdate-time

created_by_user_emailstring

optional

created_by_user_idstring

optional

formatuint64

dataset_namestring

optional

dataset_uuidstring

optional

descriptionstring

optional

latest_version_number_of_runsnumber

optional

formatint32

metricsarray of descriptionstringmetric_namestringmetric_typeenummetric_uuidstringmetric_value_typeenumAPIEvaluationMetric

optional

namestring

optional

star_metricmetric_uuidstringnamestringsuccess_threshold_pctnumberAPIStarMetric

optional

test_case_uuidstring

optional

total_runsnumber

optional

formatint32

updated_atstring

optional

formatdate-time

updated_by_user_emailstring

optional

updated_by_user_idstring

optional

formatuint64

versionnumber

optional

formatint64

API Star Metric

APIStarMetricobject

ShowShow

metric_uuidstring

optional

namestring

optional

success_threshold_pctnumber

optional

The success threshold for the star metric. This is a percentage value between 0 and 100.

formatint32

AgentsFunctions

agents.functions

Methods

Add Function Route to an Agent

post/v2/gen-ai/agents/{agent_uuid}/functions

To create a function route for an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/functions.

Update Function Route for an Agent

put/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}

To update the function route, send a PUT request to /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}.

Delete Function Route for an Agent

delete/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}

To delete a function route from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}.

AgentsKnowledge Bases

agents.knowledge_bases

Methods

Attach Knowledge Bases to an Agent

post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases

To attach knowledge bases to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases

Attach Knowledge Base to an Agent

post/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

To attach a knowledge base to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

Detach Knowledge Base from an Agent

delete/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

To detach a knowledge base from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}.

Domain Types

API Link Knowledge Base Output

APILinkKnowledgeBaseOutputobject

ShowShow

agentanthropic_api_keyAPIAnthropicAPIKeyInfoapi_key_infosarray of APIAgentAPIKeyInfoapi_keysarray of objectchatbotobjectchatbot_identifiersarray of objectchild_agentsarray of APIAgentcreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBasemax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringworkspaceAPIWorkspaceAPIAgent

optional

AgentsRoutes

agents.routes

Methods

Update Agent Route for an Agent

put/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

To update an agent route for an agent, send a PUT request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

Delete Agent Route for an Agent

delete/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

To delete an agent route from a parent agent, send a DELETE request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

Add Agent Route to an Agent

post/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

To add an agent route to an agent, send a POST request to /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}.

View Agent Routes

get/v2/gen-ai/agents/{uuid}/child_agents

To view agent routes for an agent, send a GET requtest to /v2/gen-ai/agents/{uuid}/child_agents.

AgentsVersions

agents.versions

Methods

Rollback to Agent Version

put/v2/gen-ai/agents/{uuid}/versions

To update to a specific agent version, send a PUT request to /v2/gen-ai/agents/{uuid}/versions.

List Agent Versions

get/v2/gen-ai/agents/{uuid}/versions

To list all agent versions, send a GET request to /v2/gen-ai/agents/{uuid}/versions.