Skip to content
Gradient SDK Docs
  • Auto
  • Light
  • Dark

Agents

Agents

Agents

Create an Agent
post/v2/gen-ai/agents
Delete an Agent
delete/v2/gen-ai/agents/{uuid}
List Agents
get/v2/gen-ai/agents
Retrieve an Existing Agent
get/v2/gen-ai/agents/{uuid}
Update an Agent
put/v2/gen-ai/agents/{uuid}
Update Agent Status
put/v2/gen-ai/agents/{uuid}/deployment_visibility
API Agent
APIAgentobject

An Agent

ShowShow
anthropic_api_keycreated_atstringcreated_bystringdeleted_atstringnamestringupdated_atstringuuidstringAPIAnthropicAPIKeyInfo
optional

Anthropic API Key Info

api_key_infosarray of created_atstringcreated_bystringdeleted_atstringnamestringsecret_keystringuuidstringAPIAgentAPIKeyInfo
optional

Api key infos

api_keysarray of object
optional

Api keys

Hide ParametersShow Parameters
api_keystring
optional

Api key

chatbotobject
optional

A Chatbot

Hide ParametersShow Parameters
button_background_colorstring
optional
namestring
optional

Name of chatbot

primary_colorstring
optional
secondary_colorstring
optional
starting_messagestring
optional
chatbot_identifiersarray of object
optional

Chatbot identifiers

Hide ParametersShow Parameters
agent_chatbot_identifierstring
optional

Agent chatbot identifier

child_agentsarray of anthropic_api_keyAPIAnthropicAPIKeyInfoapi_key_infosarray of APIAgentAPIKeyInfoapi_keysarray of objectchatbotobjectchatbot_identifiersarray of objectchild_agentsarray of APIAgentconversation_logs_enabledbooleancreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBaselogging_configobjectmax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringversion_hashstringworkspaceAPIWorkspaceAPIAgent
optional

Child agents

conversation_logs_enabledboolean
optional

Whether conversation logs are enabled for the agent

created_atstring
optional

Creation date / time

formatdate-time
deploymentobject
optional

Description of deployment

Hide ParametersShow Parameters
created_atstring
optional

Creation date / time

formatdate-time
namestring
optional

Name

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

Last modified

formatdate-time
urlstring
optional

Access your deployed agent here

uuidstring
optional

Unique id

visibilityAPIDeploymentVisibility
optional
  • 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
descriptionstring
optional

Description of agent

functionsarray of object
optional
Hide ParametersShow Parameters
api_keystring
optional

Api key

created_atstring
optional

Creation date / time

formatdate-time
created_bystring
optional

Created by user id from DO

formatuint64
descriptionstring
optional

Agent description

faas_namestring
optional
faas_namespacestring
optional
input_schemaunknown
optional
namestring
optional

Name

output_schemaunknown
optional
updated_atstring
optional

Last modified

formatdate-time
urlstring
optional

Download your agent here

uuidstring
optional

Unique id

guardrailsarray of object
optional

The guardrails the agent is attached to

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

Knowledge bases

logging_configobject
optional
Hide ParametersShow Parameters
galileo_project_idstring
optional

Galileo project identifier

galileo_project_namestring
optional

Name of the Galileo project

log_stream_idstring
optional

Identifier for the log stream

log_stream_namestring
optional

Name of the log stream

max_tokensnumber
optional
formatint64
modelagreementAPIAgreementcreated_atstringinference_namestringinference_versionstringis_foundationalbooleanmetadataunknownnamestringparent_uuidstringproviderenumupdated_atstringupload_completebooleanurlstringusecasesarray of enumuuidstringversionAPIModelVersionAPIAgentModel
optional

Description of a Model

namestring
optional

Agent name

openai_api_keycreated_atstringcreated_bystringdeleted_atstringmodelsarray of APIAgentModelnamestringupdated_atstringuuidstringAPIOpenAIAPIKeyInfo
optional

OpenAI API Key Info

parent_agentsarray of anthropic_api_keyAPIAnthropicAPIKeyInfoapi_key_infosarray of APIAgentAPIKeyInfoapi_keysarray of objectchatbotobjectchatbot_identifiersarray of objectchild_agentsarray of APIAgentconversation_logs_enabledbooleancreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBaselogging_configobjectmax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringversion_hashstringworkspaceAPIWorkspaceAPIAgent
optional

Parent agents

project_idstring
optional
provide_citationsboolean
optional

Whether the agent should provide in-response citations

regionstring
optional

Region code

retrieval_methodAPIRetrievalMethod
optional
  • 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
route_created_atstring
optional

Creation of route date / time

formatdate-time
route_created_bystring
optional
formatuint64
route_namestring
optional

Route name

route_uuidstring
optional
tagsarray of string
optional

Agent tag to organize related resources

temperaturenumber
optional
formatfloat
templateobject
optional

Represents an AgentTemplate entity

Hide ParametersShow Parameters
created_atstring
optional

The agent template's creation date

formatdate-time
descriptionstring
optional

Deprecated - Use summary instead

guardrailsarray of object
optional

List of guardrails associated with the agent template

Hide ParametersShow Parameters
prioritynumber
optional

Priority of the guardrail

formatint32
uuidstring
optional

Uuid of the guardrail

instructionstring
optional

Instructions for the agent template

knumber
optional

The 'k' value for the agent template

formatint64
knowledge_basesarray of added_to_agent_atstringcreated_atstringdatabase_idstringembedding_model_uuidstringis_publicbooleanlast_indexing_jobAPIIndexingJobnamestringproject_idstringregionstringtagsarray of stringupdated_atstringuser_idstringuuidstringAPIKnowledgeBase
optional

List of knowledge bases associated with the agent template

long_descriptionstring
optional

The long description of the agent template

max_tokensnumber
optional

The max_tokens setting for the agent template

formatint64
modelagreementAPIAgreementcreated_atstringinference_namestringinference_versionstringis_foundationalbooleanmetadataunknownnamestringparent_uuidstringproviderenumupdated_atstringupload_completebooleanurlstringusecasesarray of enumuuidstringversionAPIModelVersionAPIAgentModel
optional

Description of a Model

namestring
optional

Name of the agent template

short_descriptionstring
optional

The short description of the agent template

summarystring
optional

The summary of the agent template

tagsarray of string
optional

List of tags associated with the agent template

temperaturenumber
optional

The temperature setting for the agent template

formatfloat
template_typeenum
optional
"AGENT_TEMPLATE_TYPE_STANDARD" OR "AGENT_TEMPLATE_TYPE_ONE_CLICK"
  • AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template
  • AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template
Hide ParametersShow Parameters
"AGENT_TEMPLATE_TYPE_STANDARD"
"AGENT_TEMPLATE_TYPE_ONE_CLICK"
top_pnumber
optional

The top_p setting for the agent template

formatfloat
updated_atstring
optional

The agent template's last updated date

formatdate-time
uuidstring
optional

Unique id

top_pnumber
optional
formatfloat
updated_atstring
optional

Last modified

formatdate-time
urlstring
optional

Access your agent under this url

user_idstring
optional

Id of user that created the agent

formatuint64
uuidstring
optional

Unique agent id

version_hashstring
optional

The latest version of the agent

workspaceagentsarray of APIAgentcreated_atstringcreated_bystringcreated_by_emailstringdeleted_atstringdescriptionstringevaluation_test_casesarray of APIEvaluationTestCasenamestringupdated_atstringuuidstringAPIWorkspace
optional
API Agent API Key Info
APIAgentAPIKeyInfoobject

Agent API Key Info

ShowShow
created_atstring
optional

Creation date

formatdate-time
created_bystring
optional

Created by

formatuint64
deleted_atstring
optional

Deleted date

formatdate-time
namestring
optional

Name

secret_keystring
optional
uuidstring
optional

Uuid

API Agent Model
APIAgentModelobject

Description of a Model

ShowShow
agreementdescriptionstringnamestringurlstringuuidstringAPIAgreement
optional

Agreement Description

created_atstring
optional

Creation date / time

formatdate-time
inference_namestring
optional

Internally used name

inference_versionstring
optional

Internally used version

is_foundationalboolean
optional

True if it is a foundational model provided by do

metadataunknown
optional

Additional meta data

namestring
optional

Name of the model

parent_uuidstring
optional

Unique id of the model, this model is based on

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

Last modified

formatdate-time
upload_completeboolean
optional

Model has been fully uploaded

urlstring
optional

Download url

usecasesarray of enum
optional

Usecases of the model

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

Unique id

versionmajornumberminornumberpatchnumberAPIModelVersion
optional

Version Information about a Model

API Anthropic API Key Info
APIAnthropicAPIKeyInfoobject

Anthropic API Key Info

ShowShow
created_atstring
optional

Key creation date

formatdate-time
created_bystring
optional

Created by user id from DO

formatuint64
deleted_atstring
optional

Key deleted date

formatdate-time
namestring
optional

Name

updated_atstring
optional

Key last updated date

formatdate-time
uuidstring
optional

Uuid

API Deployment Visibility
APIDeploymentVisibilityenum
  • 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
ShowShow
"VISIBILITY_UNKNOWN"
"VISIBILITY_DISABLED"
"VISIBILITY_PLAYGROUND"
"VISIBILITY_PUBLIC"
"VISIBILITY_PRIVATE"
API OpenAI API Key Info
APIOpenAIAPIKeyInfoobject

OpenAI API Key Info

ShowShow
created_atstring
optional

Key creation date

formatdate-time
created_bystring
optional

Created by user id from DO

formatuint64
deleted_atstring
optional

Key deleted date

formatdate-time
modelsarray of agreementAPIAgreementcreated_atstringinference_namestringinference_versionstringis_foundationalbooleanmetadataunknownnamestringparent_uuidstringproviderenumupdated_atstringupload_completebooleanurlstringusecasesarray of enumuuidstringversionAPIModelVersionAPIAgentModel
optional

Models supported by the openAI api key

namestring
optional

Name

updated_atstring
optional

Key last updated date

formatdate-time
uuidstring
optional

Uuid

API Retrieval Method
APIRetrievalMethodenum
  • 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
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 APIAgentconversation_logs_enabledbooleancreated_atstringdeploymentobjectdescriptionstringfunctionsarray of objectguardrailsarray of objectif_casestringinstructionstringknumberknowledge_basesarray of APIKnowledgeBaselogging_configobjectmax_tokensnumbermodelAPIAgentModelnamestringopenai_api_keyAPIOpenAIAPIKeyInfoparent_agentsarray of APIAgentproject_idstringprovide_citationsbooleanregionstringretrieval_methodAPIRetrievalMethodroute_created_atstringroute_created_bystringroute_namestringroute_uuidstringtagsarray of stringtemperaturenumbertemplateobjecttop_pnumberupdated_atstringurlstringuser_idstringuuidstringversion_hashstringworkspaceAPIWorkspaceAPIAgent
optional

Agents

created_atstring
optional

Creation date

formatdate-time
created_bystring
optional

The id of user who created this workspace

formatuint64
created_by_emailstring
optional

The email of the user who created this workspace

deleted_atstring
optional

Deleted date

formatdate-time
descriptionstring
optional

Description of the workspace

evaluation_test_casesarray of archived_atstringcreated_atstringcreated_by_user_emailstringcreated_by_user_idstringdatasetobjectdataset_namestringdataset_uuidstringdescriptionstringlatest_version_number_of_runsnumbermetricsarray of APIEvaluationMetricnamestringstar_metricAPIStarMetrictest_case_uuidstringtotal_runsnumberupdated_atstringupdated_by_user_emailstringupdated_by_user_idstringversionnumberAPIEvaluationTestCase
optional

Evaluations

namestring
optional

Name of the workspace

updated_atstring
optional

Update date

formatdate-time
uuidstring
optional

Unique id

AgentsAPI Keys

Create an Agent API Key
post/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}
List Agent API Keys
get/v2/gen-ai/agents/{agent_uuid}/api_keys
Regenerate API Key for an Agent
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate
Update API Key for an Agent
put/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}

AgentsChat

AgentsChatCompletions

Creates a model response for the given chat conversation.
post/chat/completions?agent=true

AgentsEvaluation Datasets

Create Evaluation Dataset
post/v2/gen-ai/evaluation_datasets
Create Presigned URLs for Evaluation Dataset File Upload
post/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls

AgentsEvaluation Metrics

List Evaluation Metrics
get/v2/gen-ai/evaluation_metrics
List Datacenter Regions
get/v2/gen-ai/regions

AgentsEvaluation MetricsModels

List Available Models
get/v2/gen-ai/models

AgentsEvaluation MetricsWorkspaces

Create a Workspace
post/v2/gen-ai/workspaces
Delete a Workspace
delete/v2/gen-ai/workspaces/{workspace_uuid}
List Workspaces
get/v2/gen-ai/workspaces
List Evaluation Test Cases by Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases
Retrieve an Existing Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}
Update a Workspace
put/v2/gen-ai/workspaces/{workspace_uuid}

AgentsEvaluation MetricsWorkspacesAgents

List agents by Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}/agents
Move Agents to a Workspace
put/v2/gen-ai/workspaces/{workspace_uuid}/agents

AgentsEvaluation Runs

Run an Evaluation Test Case
post/v2/gen-ai/evaluation_runs
Retrieve Results of an Evaluation Run
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results
Retrieve Information About an Existing Evaluation Run
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}
Retrieve Results of an Evaluation Run Prompt
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}
API Evaluation Metric
APIEvaluationMetricobject
ShowShow
descriptionstring
optional
invertedboolean
optional

If true, the metric is inverted, meaning that a lower value is better.

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" OR "METRIC_VALUE_TYPE_PERCENTAGE"
Hide ParametersShow Parameters
"METRIC_VALUE_TYPE_UNSPECIFIED"
"METRIC_VALUE_TYPE_NUMBER"
"METRIC_VALUE_TYPE_STRING"
"METRIC_VALUE_TYPE_PERCENTAGE"
range_maxnumber
optional

The maximum value for the metric.

formatfloat
range_minnumber
optional

The minimum value for the metric.

formatfloat
API Evaluation Metric Result
APIEvaluationMetricResultobject
ShowShow
error_descriptionstring
optional

Error description if the metric could not be calculated.

metric_namestring
optional

Metric name

metric_value_typeenum
optional
"METRIC_VALUE_TYPE_UNSPECIFIED" OR "METRIC_VALUE_TYPE_NUMBER" OR "METRIC_VALUE_TYPE_STRING" OR "METRIC_VALUE_TYPE_PERCENTAGE"
Hide ParametersShow Parameters
"METRIC_VALUE_TYPE_UNSPECIFIED"
"METRIC_VALUE_TYPE_NUMBER"
"METRIC_VALUE_TYPE_STRING"
"METRIC_VALUE_TYPE_PERCENTAGE"
number_valuenumber
optional

The value of the metric as a number.

formatdouble
reasoningstring
optional

Reasoning of the metric result.

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
input_tokensstring
optional

The number of input tokens used in the prompt.

formatuint64
outputstring
optional
output_tokensstring
optional

The number of output tokens used in the prompt.

formatuint64
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

Prompt ID

formatint64
prompt_level_metric_resultsarray of error_descriptionstringmetric_namestringmetric_value_typeenumnumber_valuenumberreasoningstringstring_valuestringAPIEvaluationMetricResult
optional

The metric results for the prompt.

API Evaluation Run
APIEvaluationRunobject
ShowShow
agent_deletedboolean
optional

Whether agent is deleted

agent_namestring
optional

Agent name

agent_uuidstring
optional

Agent UUID.

agent_version_hashstring
optional

Version hash

agent_workspace_uuidstring
optional

Agent workspace uuid

created_by_user_emailstring
optional
created_by_user_idstring
optional
formatuint64
error_descriptionstring
optional

The error description

evaluation_run_uuidstring
optional

Evaluation run UUID.

evaluation_test_case_workspace_uuidstring
optional

Evaluation test case workspace uuid

finished_atstring
optional

Run end time.

formatdate-time
pass_statusboolean
optional

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

queued_atstring
optional

Run queued time.

formatdate-time
run_level_metric_resultsarray of error_descriptionstringmetric_namestringmetric_value_typeenumnumber_valuenumberreasoningstringstring_valuestringAPIEvaluationMetricResult
optional
run_namestring
optional

Run name.

star_metric_resulterror_descriptionstringmetric_namestringmetric_value_typeenumnumber_valuenumberreasoningstringstring_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

Evaluation Run Statuses

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_descriptionstring
optional

Test case description.

test_case_namestring
optional

Test case name.

test_case_uuidstring
optional

Test-case UUID.

test_case_versionnumber
optional

Test-case-version.

formatint64

AgentsEvaluation Test Cases

Create Evaluation Test Case.
post/v2/gen-ai/evaluation_test_cases
List Evaluation Test Cases
get/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
Retrieve Information About an Existing Evaluation Test Case
get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}
Update an Evaluation Test Case.
put/v2/gen-ai/evaluation_test_cases/{test_case_uuid}
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
datasetobject
optional
Hide ParametersShow Parameters
created_atstring
optional

Time created at.

formatdate-time
dataset_namestring
optional

Name of the dataset.

dataset_uuidstring
optional

UUID of the dataset.

file_sizestring
optional

The size of the dataset uploaded file in bytes.

formatuint64
has_ground_truthboolean
optional

Does the dataset have a ground truth column?

row_countnumber
optional

Number of rows in the dataset.

formatint64
dataset_namestring
optional
dataset_uuidstring
optional
descriptionstring
optional
latest_version_number_of_runsnumber
optional
formatint32
metricsarray of descriptionstringinvertedbooleanmetric_namestringmetric_typeenummetric_uuidstringmetric_value_typeenumrange_maxnumberrange_minnumberAPIEvaluationMetric
optional
namestring
optional
star_metricmetric_uuidstringnamestringsuccess_thresholdnumbersuccess_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_thresholdnumber
optional

The success threshold for the star metric. This is a value that the metric must reach to be considered successful.

formatfloat
success_threshold_pctnumber
optional

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

formatint32

AgentsFunctions

Add Function Route to an Agent
post/v2/gen-ai/agents/{agent_uuid}/functions
Delete Function Route for an Agent
delete/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}
Update Function Route for an Agent
put/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}

AgentsKnowledge Bases

Attach Knowledge Bases to an Agent
post/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}
Detach Knowledge Base from an Agent
delete/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}
API Link Knowledge Base Output
APILinkKnowledgeBaseOutputobject

Information about a linked knowledge base

ShowShow

AgentsRoutes

Add Agent Route to an Agent
post/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}
Update Agent Route for an Agent
put/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}
View Agent Routes
get/v2/gen-ai/agents/{uuid}/child_agents

AgentsVersions

List Agent Versions
get/v2/gen-ai/agents/{uuid}/versions
Rollback to Agent Version
put/v2/gen-ai/agents/{uuid}/versions