definitions.yml

apiAWSDataSource:
  description: AWS S3 Data Source
  properties:
    bucket_name:
      description: Spaces bucket name
      example: example name
      type: string
    item_path:
      example: example string
      type: string
    key_id:
      description: The AWS Key ID
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    region:
      description: Region of bucket
      example: example string
      type: string
    secret_key:
      description: The AWS Secret Key
      example: example string
      type: string
  type: object
apiAWSDataSourceDisplay:
  description: AWS S3 Data Source for Display
  properties:
    bucket_name:
      description: Spaces bucket name
      example: example name
      type: string
    item_path:
      example: example string
      type: string
    region:
      description: Region of bucket
      example: example string
      type: string
  type: object
apiAcceptAgreementOutput:
  description: AcceptAgreementOutput Description
  properties:
    team_agreement:
      $ref: '#/apiTeamAgreement'
  type: object
apiAgent:
  description: An Agent
  properties:
    anthropic_api_key:
      $ref: '#/apiAnthropicAPIKeyInfo'
    api_key_infos:
      description: Api key infos
      items:
        $ref: '#/apiAgentAPIKeyInfo'
      type: array
    api_keys:
      description: Api keys
      items:
        $ref: '#/apiAgentAPIKey'
      type: array
    chatbot:
      $ref: '#/apiChatbot'
    chatbot_identifiers:
      description: Chatbot identifiers
      items:
        $ref: '#/apiAgentChatbotIdentifier'
      type: array
    child_agents:
      description: Child agents
      items:
        $ref: '#/apiAgent'
      type: array
    conversation_logs_enabled:
      description: Whether conversation logs are enabled for the agent
      example: true
      type: boolean
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    deployment:
      $ref: '#/apiDeployment'
    description:
      description: Description of agent
      example: example string
      type: string
    functions:
      items:
        $ref: '#/apiAgentFunction'
      type: array
    guardrails:
      description: The guardrails the agent is attached to
      items:
        $ref: '#/apiAgentGuardrail'
      type: array
    if_case:
      example: example string
      type: string
    instruction:
      description: Agent instruction. Instructions help your agent to perform its
        job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
        for best practices.
      example: example string
      type: string
    k:
      example: 123
      format: int64
      type: integer
    knowledge_bases:
      description: Knowledge bases
      items:
        $ref: '#/apiKnowledgeBase'
      type: array
    logging_config:
      $ref: '#/apiAgentLoggingConfig'
    max_tokens:
      example: 123
      format: int64
      type: integer
    model:
      $ref: '#/apiModel'
    model_provider_key:
      $ref: '#/apiModelProviderKeyInfo'
    name:
      description: Agent name
      example: example name
      type: string
    openai_api_key:
      $ref: '#/apiOpenAIAPIKeyInfo'
    parent_agents:
      description: Parent agents
      items:
        $ref: '#/apiAgent'
      type: array
    project_id:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    provide_citations:
      description: Whether the agent should provide in-response citations
      example: true
      type: boolean
    region:
      description: Region code
      example: example string
      type: string
    retrieval_method:
      $ref: '#/apiRetrievalMethod'
    route_created_at:
      description: Creation of route date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    route_created_by:
      example: "12345"
      format: uint64
      type: string
    route_name:
      description: Route name
      example: example name
      type: string
    route_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    tags:
      description: Agent tag to organize related resources
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    temperature:
      example: 123
      format: float
      type: number
    template:
      $ref: '#/apiAgentTemplate'
    top_p:
      example: 123
      format: float
      type: number
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    url:
      description: Access your agent under this url
      example: example string
      type: string
    user_id:
      description: Id of user that created the agent
      example: "12345"
      format: uint64
      type: string
    uuid:
      description: Unique agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    version_hash:
      description: The latest version of the agent
      example: example string
      type: string
    vpc_egress_ips:
      description: VPC Egress IPs
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    vpc_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    workspace:
      $ref: '#/apiWorkspace'
  type: object
apiAgentAPIKey:
  description: Agent API Key
  properties:
    api_key:
      description: Api key
      example: example string
      type: string
  type: object
apiAgentAPIKeyInfo:
  description: Agent API Key Info
  properties:
    created_at:
      description: Creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by
      example: "12345"
      format: uint64
      type: string
    deleted_at:
      description: Deleted date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    name:
      description: Name
      example: example name
      type: string
    secret_key:
      example: example string
      type: string
    uuid:
      description: Uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentChatbotIdentifier:
  description: Agent Chatbot Identifier
  properties:
    agent_chatbot_identifier:
      description: Agent chatbot identifier
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentChildRelationshipVerion:
  properties:
    agent_name:
      description: Name of the child agent
      example: example name
      type: string
    child_agent_uuid:
      description: Child agent unique identifier
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    if_case:
      description: If case
      example: example string
      type: string
    is_deleted:
      description: Child agent is deleted
      example: true
      type: boolean
    route_name:
      description: Route name
      example: example name
      type: string
  type: object
apiAgentConversationLogConfig:
  description: Response for getting or creating an agent conversation log location
  properties:
    agent_uuid:
      description: Agent UUID
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    spaces_data_source:
      $ref: '#/apiSpacesDataSource'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
  type: object
apiAgentDeploymentCodeArtifact:
  description: File to upload
  properties:
    agent_code_file_path:
      description: The agent code  file path
      example: example string
      type: string
    size_in_bytes:
      description: The size of the file in bytes
      example: "12345"
      format: uint64
      type: string
    stored_object_key:
      description: The object key the file was stored as
      example: example string
      type: string
  type: object
apiAgentDeploymentRelease:
  description: An Agent Deployment Release
  properties:
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by_user_email:
      description: Email of user that created the agent deployment release
      example: example@example.com
      type: string
    created_by_user_id:
      description: Id of user that created the agent deployment release
      example: "12345"
      format: uint64
      type: string
    error_msg:
      description: A error message provinding a hint which part of the system experienced
        an error
      example: example string
      type: string
    status:
      $ref: '#/apiReleaseStatus'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique release id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentFunction:
  description: Description missing
  properties:
    api_key:
      description: Api key
      example: example string
      type: string
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by user id from DO
      example: "12345"
      format: uint64
      type: string
    description:
      description: Agent description
      example: example string
      type: string
    faas_name:
      example: example name
      type: string
    faas_namespace:
      example: example name
      type: string
    input_schema:
      type: object
    name:
      description: Name
      example: example name
      type: string
    output_schema:
      type: object
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    url:
      description: Download your agent here
      example: example string
      type: string
    uuid:
      description: Unique id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentFunctionVersion:
  description: Function represents a function configuration for an agent
  properties:
    description:
      description: Description of the function
      example: example string
      type: string
    faas_name:
      description: FaaS name of the function
      example: example name
      type: string
    faas_namespace:
      description: FaaS namespace of the function
      example: example name
      type: string
    is_deleted:
      description: Whether the function is deleted
      example: true
      type: boolean
    name:
      description: Name of the function
      example: example name
      type: string
  type: object
apiAgentGuardrail:
  description: A Agent Guardrail
  properties:
    agent_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    created_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    default_response:
      example: example string
      type: string
    description:
      example: example string
      type: string
    guardrail_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    is_attached:
      example: true
      type: boolean
    is_default:
      example: true
      type: boolean
    metadata:
      type: object
    name:
      example: example name
      type: string
    priority:
      example: 123
      format: int32
      type: integer
    type:
      $ref: '#/apiGuardrailType'
    updated_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentGuardrailInput:
  properties:
    guardrail_uuid:
      description: Guardrail uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    priority:
      description: Priority of the guardrail
      example: 123
      format: int64
      type: integer
  type: object
apiAgentGuardrailVersion:
  description: Agent Guardrail version
  properties:
    is_deleted:
      description: Whether the guardrail is deleted
      example: true
      type: boolean
    name:
      description: Guardrail Name
      example: example name
      type: string
    priority:
      description: Guardrail Priority
      example: 123
      format: int64
      type: integer
    uuid:
      description: Guardrail UUID
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentKnowledgeBaseVersion:
  properties:
    is_deleted:
      description: Deletet at date / time
      example: true
      type: boolean
    name:
      description: Name of the knowledge base
      example: example name
      type: string
    uuid:
      description: Unique id of the knowledge base
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentLogInsightsPrice:
  properties:
    attributes:
      items:
        $ref: '#/apiBillingAttribute'
      type: array
    display_name:
      example: example name
      type: string
    prices:
      items:
        $ref: '#/apiBillingPrice'
      type: array
  type: object
apiAgentLoggingConfig:
  properties:
    galileo_project_id:
      description: Galileo project identifier
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    galileo_project_name:
      description: Name of the Galileo project
      example: example name
      type: string
    insights_enabled:
      description: Whether insights are enabled
      example: true
      type: boolean
    insights_enabled_at:
      description: Timestamp when insights were enabled
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    log_stream_id:
      description: Identifier for the log stream
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    log_stream_name:
      description: Name of the log stream
      example: example name
      type: string
  type: object
apiAgentModelUsage:
  properties:
    agent_name:
      description: Agent name
      example: example name
      type: string
    agent_uuid:
      description: Agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    requests_used:
      description: Requests used
      example: "12345"
      format: uint64
      type: string
    tokens_used:
      description: Tokens  used
      example: "12345"
      format: uint64
      type: string
  type: object
apiAgentPrice:
  properties:
    attributes:
      items:
        $ref: '#/apiBillingAttribute'
      type: array
    display_name:
      example: example name
      type: string
    model_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    prices:
      items:
        $ref: '#/apiBillingPrice'
      type: array
  type: object
apiAgentPublic:
  description: A GenAI Agent's configuration
  properties:
    chatbot:
      $ref: '#/apiChatbot'
    chatbot_identifiers:
      description: Chatbot identifiers
      items:
        $ref: '#/apiAgentChatbotIdentifier'
      type: array
    created_at:
      description: Creation date / time
      example: "2021-01-01T00:00:00Z"
      format: date-time
      type: string
    deployment:
      $ref: '#/apiDeployment'
    description:
      description: Description of agent
      example: This is a chatbot that can help you with your questions.
      type: string
    if_case:
      description: Instructions to the agent on how to use the route
      example: if talking about the weather use this route
      type: string
    instruction:
      description: Agent instruction. Instructions help your agent to perform its
        job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
        for best practices.
      example: Hello, how can I help you?
      type: string
    k:
      description: How many results should be considered from an attached knowledge
        base
      example: 5
      format: int64
      type: integer
    max_tokens:
      description: Specifies the maximum number of tokens the model can process in
        a single input or output, set as a number between 1 and 512. This determines
        the length of each response.
      example: 100
      format: int64
      type: integer
    model:
      $ref: '#/apiModel'
    name:
      description: Agent name
      example: My Agent
      type: string
    project_id:
      description: The DigitalOcean project ID associated with the agent
      example: 12345678-1234-1234-1234-123456789012
      type: string
    provide_citations:
      description: Whether the agent should provide in-response citations
      example: true
      type: boolean
    region:
      description: Region code
      example: '"tor1"'
      type: string
    retrieval_method:
      $ref: '#/apiRetrievalMethod'
    route_created_at:
      description: Creation of route date / time
      example: "2021-01-01T00:00:00Z"
      format: date-time
      type: string
    route_created_by:
      description: Id of user that created the route
      example: "12345678"
      format: uint64
      type: string
    route_name:
      description: Route name
      example: Route Name
      type: string
    route_uuid:
      description: Route uuid
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    tags:
      description: A set of abitrary tags to organize your agent
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    temperature:
      description: Controls the model’s creativity, specified as a number between
        0 and 1. Lower values produce more predictable and conservative responses,
        while higher values encourage creativity and variation.
      example: 0.5
      format: float
      type: number
    template:
      $ref: '#/apiAgentTemplate'
    top_p:
      description: Defines the cumulative probability threshold for word selection,
        specified as a number between 0 and 1. Higher values allow for more diverse
        outputs, while lower values ensure focused and coherent responses.
      example: 0.9
      format: float
      type: number
    updated_at:
      description: Last modified
      example: "2021-01-01T00:00:00Z"
      format: date-time
      type: string
    url:
      description: Access your agent under this url
      example: https://example.com/agent
      type: string
    user_id:
      description: Id of user that created the agent
      example: "12345678"
      format: uint64
      type: string
    uuid:
      description: Unique agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    version_hash:
      description: The latest version of the agent
      example: example string
      type: string
  type: object
apiAgentTemplate:
  description: Represents an AgentTemplate entity
  properties:
    created_at:
      description: The agent template's creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    description:
      description: Deprecated - Use summary instead
      example: example string
      type: string
    guardrails:
      description: List of guardrails associated with the agent template
      items:
        $ref: '#/apiAgentTemplateGuardrail'
      type: array
    instruction:
      description: Instructions for the agent template
      example: example string
      type: string
    k:
      description: The 'k' value for the agent template
      example: 123
      format: int64
      type: integer
    knowledge_bases:
      description: List of knowledge bases associated with the agent template
      items:
        $ref: '#/apiKnowledgeBase'
      type: array
    long_description:
      description: The long description of the agent template
      example: '"Enhance your customer service with an AI agent designed to provide
        consistent, helpful, and accurate support across multiple channels. This template
        creates an agent that can answer product questions, troubleshoot common issues,
        process simple requests, and maintain a friendly, on-brand voice throughout
        customer interactions. Reduce response times, handle routine inquiries efficiently,
        and ensure your customers feel heard and helped."'
      type: string
    max_tokens:
      description: The max_tokens setting for the agent template
      example: 123
      format: int64
      type: integer
    model:
      $ref: '#/apiModel'
    name:
      description: Name of the agent template
      example: example name
      type: string
    short_description:
      description: The short description of the agent template
      example: '"This template has been designed with question-answer and conversational
        use cases in mind. It comes with validated agent instructions, fine-tuned
        model settings, and preconfigured guardrails defined for customer support-related
        use cases."'
      type: string
    summary:
      description: The summary of the agent template
      example: example string
      type: string
    tags:
      description: List of tags associated with the agent template
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    temperature:
      description: The temperature setting for the agent template
      example: 123
      format: float
      type: number
    template_type:
      $ref: '#/apiAgentTemplateType'
    top_p:
      description: The top_p setting for the agent template
      example: 123
      format: float
      type: number
    updated_at:
      description: The agent template's last updated date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentTemplateGuardrail:
  properties:
    priority:
      description: Priority of the guardrail
      example: 123
      format: int32
      type: integer
    uuid:
      description: Uuid of the guardrail
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentTemplateType:
  default: AGENT_TEMPLATE_TYPE_STANDARD
  description: |-
    - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template
     - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template
  enum:
  - AGENT_TEMPLATE_TYPE_STANDARD
  - AGENT_TEMPLATE_TYPE_ONE_CLICK
  example: AGENT_TEMPLATE_TYPE_STANDARD
  type: string
apiAgentVersion:
  description: Represents an AgentVersion entity
  properties:
    agent_uuid:
      description: Uuid of the agent this version belongs to
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    attached_child_agents:
      description: List of child agent relationships
      items:
        $ref: '#/apiAgentChildRelationshipVerion'
      type: array
    attached_functions:
      description: List of function versions
      items:
        $ref: '#/apiAgentFunctionVersion'
      type: array
    attached_guardrails:
      description: List of guardrail version
      items:
        $ref: '#/apiAgentGuardrailVersion'
      type: array
    attached_knowledgebases:
      description: List of knowledge base agent versions
      items:
        $ref: '#/apiAgentKnowledgeBaseVersion'
      type: array
    can_rollback:
      description: Whether the version is able to be rolled back to
      example: true
      type: boolean
    created_at:
      description: Creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by_email:
      description: User who created this version
      example: example@example.com
      type: string
    currently_applied:
      description: Whether this is the currently applied configuration
      example: true
      type: boolean
    description:
      description: Description of the agent
      example: example string
      type: string
    id:
      description: Unique identifier
      example: "12345"
      format: uint64
      type: string
    instruction:
      description: Instruction for the agent
      example: example string
      type: string
    k:
      description: K value for the agent's configuration
      example: 123
      format: int64
      type: integer
    max_tokens:
      description: Max tokens setting for the agent
      example: 123
      format: int64
      type: integer
    model_name:
      description: Name of model associated to the agent version
      example: example name
      type: string
    name:
      description: Name of the agent
      example: example name
      type: string
    provide_citations:
      description: Whether the agent should provide in-response citations
      example: true
      type: boolean
    retrieval_method:
      $ref: '#/apiRetrievalMethod'
    tags:
      description: Tags associated with the agent
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    temperature:
      description: Temperature setting for the agent
      example: 123
      format: float
      type: number
    top_p:
      description: Top_p setting for the agent
      example: 123
      format: float
      type: number
    trigger_action:
      description: Action triggering the configuration update
      example: example string
      type: string
    version_hash:
      description: Version hash
      example: example string
      type: string
  type: object
apiAgentWorkspace:
  description: An Agent Workspace
  properties:
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by_user_email:
      description: Email of user that created the agent workspace
      example: example@example.com
      type: string
    created_by_user_id:
      description: Id of user that created the agent workspace
      example: "12345"
      format: uint64
      type: string
    deployments:
      description: The deployments the agent workspace has
      items:
        $ref: '#/apiAgentWorkspaceDeployment'
      type: array
    name:
      description: Agent name
      example: example name
      type: string
    project_id:
      description: The project id the agent workspace belogs to
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    team_id:
      description: Team id the agent workspace belongs to
      example: "12345"
      format: uint64
      type: string
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgentWorkspaceDeployment:
  description: An Agent Workspace Deployment
  properties:
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by_user_email:
      description: Email of user that created the agent workspace
      example: example@example.com
      type: string
    created_by_user_id:
      description: Id of user that created the agent workspace
      example: "12345"
      format: uint64
      type: string
    latest_release:
      $ref: '#/apiAgentDeploymentRelease'
    logging_config:
      $ref: '#/apiAgentLoggingConfig'
    name:
      description: Agent name
      example: example name
      type: string
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAgreement:
  description: Agreement Description
  properties:
    description:
      example: example string
      type: string
    name:
      example: example name
      type: string
    url:
      example: example string
      type: string
    uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAnthropicAPIKeyInfo:
  description: Anthropic API Key Info
  properties:
    created_at:
      description: Key creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by user id from DO
      example: "12345"
      format: uint64
      type: string
    deleted_at:
      description: Key deleted date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    name:
      description: Name
      example: example name
      type: string
    updated_at:
      description: Key last updated date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiAuditHeader:
  description: An alternative way to provide auth information. for internal use only.
  properties:
    actor_id:
      example: "12345"
      format: uint64
      type: string
    actor_ip:
      example: example string
      type: string
    actor_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    context_urn:
      example: example string
      type: string
    origin_application:
      example: example string
      type: string
    user_id:
      example: "12345"
      format: uint64
      type: string
    user_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiBatchJobPhase:
  default: BATCH_JOB_PHASE_UNKNOWN
  enum:
  - BATCH_JOB_PHASE_UNKNOWN
  - BATCH_JOB_PHASE_PENDING
  - BATCH_JOB_PHASE_RUNNING
  - BATCH_JOB_PHASE_SUCCEEDED
  - BATCH_JOB_PHASE_FAILED
  - BATCH_JOB_PHASE_ERROR
  - BATCH_JOB_PHASE_CANCELLED
  example: BATCH_JOB_PHASE_UNKNOWN
  type: string
apiBillingAttribute:
  properties:
    name:
      example: example name
      type: string
    value:
      example: example string
      type: string
  type: object
apiBillingPrice:
  properties:
    rate:
      example: example string
      type: string
    region:
      example: example string
      type: string
  type: object
apiCancelKnowledgeBaseIndexingJobInputPublic:
  description: CancelKnowledgeBaseIndexingJobInputPublic description
  properties:
    uuid:
      description: A unique identifier for an indexing job.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiCancelKnowledgeBaseIndexingJobOutput:
  description: CancelKnowledgeBaseIndexingJobOutput description
  properties:
    job:
      $ref: '#/apiIndexingJob'
  type: object
apiChatbot:
  description: A Chatbot
  properties:
    allowed_domains:
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    button_background_color:
      example: example string
      type: string
    logo:
      example: example string
      type: string
    name:
      description: Name of chatbot
      example: example name
      type: string
    primary_color:
      example: example string
      type: string
    secondary_color:
      example: example string
      type: string
    starting_message:
      example: example string
      type: string
  type: object
apiCrawlingOption:
  default: UNKNOWN
  description: |-
    Options for specifying how URLs found on pages should be handled.

     - UNKNOWN: Default unknown value
     - SCOPED: Only include the base URL.
     - PATH: Crawl the base URL and linked pages within the URL path.
     - DOMAIN: Crawl the base URL and linked pages within the same domain.
     - SUBDOMAINS: Crawl the base URL and linked pages for any subdomain.
     - SITEMAP: Crawl URLs discovered in the sitemap.
  enum:
  - UNKNOWN
  - SCOPED
  - PATH
  - DOMAIN
  - SUBDOMAINS
  - SITEMAP
  example: UNKNOWN
  type: string
apiCreateAgentAPIKeyInputPublic:
  properties:
    agent_uuid:
      description: Agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: A human friendly name to identify the key
      example: Production Key
      type: string
  type: object
apiCreateAgentAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiAgentAPIKeyInfo'
  type: object
apiCreateAgentDeploymentFileUploadPresignedURLInputPublic:
  description: Request for pre-signed URL's to upload file for Agent Workspace
  properties:
    file:
      $ref: '#/apiPresignedUrlFile'
  type: object
apiCreateAgentDeploymentFileUploadPresignedURLOutput:
  description: Response with pre-signed url to upload file
  properties:
    request_id:
      description: The ID generated for the request for Presigned URLs.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    upload:
      $ref: '#/apiFilePresignedUrlResponse'
  type: object
apiCreateAgentDeploymentReleaseInputPublic:
  properties:
    agent_deployment_code_artifact:
      $ref: '#/apiAgentDeploymentCodeArtifact'
    agent_deployment_name:
      description: The deployment name
      example: example name
      type: string
    agent_workspace_name:
      description: The name of agent workspace
      example: example name
      type: string
  type: object
apiCreateAgentDeploymentReleaseOutput:
  description: One Agent Deployment Release
  properties:
    agent_deployment_release:
      $ref: '#/apiAgentDeploymentRelease'
  type: object
apiCreateAgentFromTemplateInput:
  properties:
    conversation_logs_enabled:
      example: "false"
apiCreateAgentFromTemplateInputPublic:
  properties:
    project_id:
      example: '"12345678-1234-1234-1234-123456789012"'
    region:
      example: '"tor1"'
    template_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    workspace_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiCreateAgentFromTemplateOutput:
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiCreateAgentInput:
  properties:
    conversation_logs_enabled:
      example: "false"
    vpc_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiCreateAgentInputPublic:
  description: Parameters for Agent Creation
  properties:
    anthropic_key_uuid:
      description: Optional Anthropic API key ID to use with Anthropic models
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    description:
      description: A text description of the agent, not used in inference
      example: '"My Agent Description"'
      type: string
    instruction:
      description: Agent instruction. Instructions help your agent to perform its
        job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
        for best practices.
      example: '"You are an agent who thinks deeply about the world"'
      type: string
    knowledge_base_uuid:
      description: Ids of the knowledge base(s) to attach to the agent
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    model_provider_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    model_uuid:
      description: Identifier for the foundation model.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Agent name
      example: '"My Agent"'
      type: string
    open_ai_key_uuid:
      description: Optional OpenAI API key ID to use with OpenAI models
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    project_id:
      description: The id of the DigitalOcean project this agent will belong to
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    region:
      description: The DigitalOcean region to deploy your agent in
      example: '"tor1"'
      type: string
    tags:
      description: Agent tag to organize related resources
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    workspace_uuid:
      description: Identifier for the workspace
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiCreateAgentOutput:
  description: Information about a newly created Agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiCreateAgentWorkspaceDeploymentInputPublic:
  properties:
    agent_deployment_code_artifact:
      $ref: '#/apiAgentDeploymentCodeArtifact'
    agent_deployment_name:
      description: The deployment name
      example: example name
      type: string
    agent_workspace_name:
      description: The name of agent workspace
      example: example name
      type: string
  type: object
apiCreateAgentWorkspaceDeploymentOutput:
  description: One Agent Workspace Deployment
  properties:
    agent_workspace_deployment:
      $ref: '#/apiAgentWorkspaceDeployment'
  type: object
apiCreateAgentWorkspaceInputPublic:
  properties:
    agent_deployment_code_artifact:
      $ref: '#/apiAgentDeploymentCodeArtifact'
    agent_deployment_name:
      description: The deployment name
      example: example name
      type: string
    agent_workspace_name:
      description: The name of agent workspace
      example: example name
      type: string
    project_id:
      description: The project id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiCreateAgentWorkspaceOutput:
  properties:
    agent_workspace:
      $ref: '#/apiAgentWorkspace'
  type: object
apiCreateAnthropicAPIKeyInputPublic:
  description: CreateAnthropicAPIKeyInputPublic is used to create a new Anthropic
    API key for a specific agent.
  properties:
    api_key:
      description: Anthropic API key
      example: '"sk-ant-12345678901234567890123456789012"'
      type: string
    name:
      description: Name of the key
      example: '"Production Key"'
      type: string
  type: object
apiCreateAnthropicAPIKeyOutput:
  description: CreateAnthropicAPIKeyOutput is used to return the newly created Anthropic
    API key.
  properties:
    api_key_info:
      $ref: '#/apiAnthropicAPIKeyInfo'
  type: object
apiCreateChatbotInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiCreateChatbotOutput:
  description: Info about a newly created chatbot
  properties:
    chatbot:
      $ref: '#/apiChatbot'
  type: object
apiCreateDataSourceFileUploadPresignedUrlsInputPublic:
  description: Request for pre-signed URL's to upload files for KB Data Sources
  properties:
    files:
      description: A list of files to generate presigned URLs for.
      items:
        $ref: '#/apiPresignedUrlFile'
      type: array
  type: object
apiCreateDataSourceFileUploadPresignedUrlsOutput:
  description: Response with pre-signed urls to upload files.
  properties:
    request_id:
      description: The ID generated for the request for Presigned URLs.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    uploads:
      description: A list of generated presigned URLs and object keys, one per file.
      items:
        $ref: '#/apiFilePresignedUrlResponse'
      type: array
  type: object
apiCreateEvaluationDatasetInputPublic:
  description: Creates an evaluation dataset for an agent
  properties:
    file_upload_dataset:
      $ref: '#/apiFileUploadDataSource'
    name:
      description: The name of the agent evaluation dataset.
      example: example name
      type: string
  type: object
apiCreateEvaluationDatasetOutput:
  description: Output for creating an agent evaluation dataset
  properties:
    evaluation_dataset_uuid:
      description: Evaluation dataset uuid.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiCreateEvaluationTestCaseInputPublic:
  properties:
    dataset_uuid:
      description: Dataset against which the test‑case is executed.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    description:
      description: Description of the test case.
      example: example string
      type: string
    metrics:
      description: Full metric list to use for evaluation test case.
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    name:
      description: Name of the test case.
      example: example name
      type: string
    star_metric:
      $ref: '#/apiStarMetric'
    workspace_uuid:
      description: The workspace uuid.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiCreateEvaluationTestCaseOutput:
  properties:
    test_case_uuid:
      description: Test‑case UUID.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiCreateGuardrailOutput:
  description: CreateGuardrailOutput description
  properties:
    guardrail:
      $ref: '#/apiGuardrail'
  type: object
apiCreateKnowledgeBaseDataSourceInputPublic:
  description: Data to create a knowledge base data source
  properties:
    aws_data_source:
      $ref: '#/apiAWSDataSource'
    knowledge_base_uuid:
      description: Knowledge base id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    spaces_data_source:
      $ref: '#/apiSpacesDataSource'
    web_crawler_data_source:
      $ref: '#/apiWebCrawlerDataSource'
  type: object
apiCreateKnowledgeBaseDataSourceOutput:
  description: Information about a newly created knowldege base data source
  properties:
    knowledge_base_data_source:
      $ref: '#/apiKnowledgeBaseDataSource'
  type: object
apiCreateKnowledgeBaseInputPublic:
  description: Data to create a new knowledge base.
  properties:
    database_id:
      description: |-
        Identifier of the DigitalOcean OpenSearch database this knowledge base will use, optional.
        If not provided, we create a new database for the knowledge base in
        the same region as the knowledge base.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    datasources:
      description: The data sources to use for this knowledge base. See [Organize
        Data Sources](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#spaces-buckets)
        for more information on data sources best practices.
      items:
        $ref: '#/apiKBDataSource'
      type: array
    embedding_model_uuid:
      description: Identifier for the [embedding model](https://docs.digitalocean.com/products/genai-platform/details/models/#embedding-models).
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Name of the knowledge base.
      example: '"My Knowledge Base"'
      type: string
    project_id:
      description: Identifier of the DigitalOcean project this knowledge base will
        belong to.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    region:
      description: The datacenter region to deploy the knowledge base in.
      example: '"tor1"'
      type: string
    tags:
      description: Tags to organize your knowledge base.
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    vpc_uuid:
      description: The VPC to deploy the knowledge base database in
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiCreateKnowledgeBaseOutput:
  description: Information about a newly created knowledge base
  properties:
    knowledge_base:
      $ref: '#/apiKnowledgeBase'
  type: object
apiCreateModelAPIKeyInputPublic:
  properties:
    name:
      description: A human friendly name to identify the key
      example: Production Key
      type: string
  type: object
apiCreateModelAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelAPIKeyInfo'
  type: object
apiCreateModelOutput:
  description: Information about a newly created model
  properties:
    model:
      $ref: '#/apiModel'
  type: object
apiCreateModelProviderKeyInputPublic:
  properties:
    api_key:
      example: sk-ant-12345678901234567890123456789012
    name:
      example: Production Key
    provider:
      example: OPENAI
apiCreateModelProviderKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelProviderKeyInfo'
  type: object
apiCreateOpenAIAPIKeyInputPublic:
  description: CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key
    for a specific agent.
  properties:
    api_key:
      description: OpenAI API key
      example: '"sk-proj--123456789098765432123456789"'
      type: string
    name:
      description: Name of the key
      example: '"Production Key"'
      type: string
  type: object
apiCreateOpenAIAPIKeyOutput:
  description: CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI
    API key.
  properties:
    api_key_info:
      $ref: '#/apiOpenAIAPIKeyInfo'
  type: object
apiCreateScheduledIndexingInputPublic:
  properties:
    days:
      description: Days for execution (day is represented same as in a cron expression,
        e.g. Monday begins with 1 )
      items:
        example: 123
        format: int32
        type: integer
      type: array
    knowledge_base_uuid:
      description: Knowledge base uuid for which the schedule is created
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    time:
      description: Time of execution (HH:MM) UTC
      example: example string
      type: string
  type: object
apiCreateScheduledIndexingOutput:
  properties:
    indexing_info:
      $ref: '#/apiScheduledIndexingInfo'
  type: object
apiCreateTracesInputPublic:
  properties:
    agent_deployment_name:
      description: Deployment name
      example: example name
      type: string
    agent_workspace_name:
      description: Agent workspace name to create traces for.
      example: example name
      type: string
    agent_workspace_uuid:
      description: Agent Workspace UUID to create traces for - DEPRECATED, use workspace
        name
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    session_id:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    traces:
      description: List of traces to create
      items:
        $ref: '#/apiTrace'
      type: array
  type: object
apiCreateTracesOutput:
  description: Output for creating traces
  properties:
    session_id:
      description: Session ID
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    trace_uuids:
      description: Trace UUIDs created
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
  type: object
apiCreateWorkspaceInputPublic:
  description: Parameters for Workspace Creation
  properties:
    agent_uuids:
      description: Ids of the agents(s) to attach to the workspace
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    description:
      description: Description of the workspace
      example: example string
      type: string
    name:
      description: Name of the workspace
      example: example name
      type: string
  type: object
apiCreateWorkspaceOutput:
  properties:
    workspace:
      $ref: '#/apiWorkspace'
  type: object
apiDataPoint:
  description: DataPoint message to represent a single data point
  properties:
    timestamp:
      description: The timestamp of the data point
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    value:
      description: The value of the data point
      example: 123
      format: double
      type: number
  type: object
apiDeleteAgentAPIKeyInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteAgentAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiAgentAPIKeyInfo'
  type: object
apiDeleteAgentConversationLogConfigOutput:
  description: Output for deleting agent conversation log config
  properties:
    agent_uuid:
      description: Agent UUID
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeleteAgentInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteAgentOutput:
  description: Info about a deleted agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiDeleteAgentWorkspaceDeploymentOutput:
  properties:
    agent_workspace_deployment_uuid:
      description: The agent workspace deployment id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeleteAgentWorkspaceOutput:
  properties:
    agent_workspace_name:
      description: The agent workspace name
      example: example name
      type: string
  type: object
apiDeleteAnthropicAPIKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteAnthropicAPIKeyOutput:
  description: DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic
    API key.
  properties:
    api_key_info:
      $ref: '#/apiAnthropicAPIKeyInfo'
  type: object
apiDeleteChatbotInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteChatbotOutput:
  description: Information about a delete chatbot
  properties:
    agent_uuid:
      description: Agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeleteGuardrailOutput:
  description: DeleteGuardrailOutput description
  properties:
    uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeleteKnowledgeBaseDataSourceInputPublic:
  properties:
    data_source_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    knowledge_base_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteKnowledgeBaseDataSourceOutput:
  description: Information about a newly deleted knowledge base data source
  properties:
    data_source_uuid:
      description: Data source id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    knowledge_base_uuid:
      description: Knowledge base id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeleteKnowledgeBaseInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteKnowledgeBaseOutput:
  description: Information about a deleted knowledge base
  properties:
    uuid:
      description: The id of the deleted knowledge base
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeleteModelAPIKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteModelAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelAPIKeyInfo'
  type: object
apiDeleteModelProviderKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteModelProviderKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelProviderKeyInfo'
  type: object
apiDeleteOpenAIAPIKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiDeleteOpenAIAPIKeyOutput:
  description: DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key.
  properties:
    api_key_info:
      $ref: '#/apiOpenAIAPIKeyInfo'
  type: object
apiDeleteScheduledIndexingOutput:
  properties:
    indexing_info:
      $ref: '#/apiScheduledIndexingInfo'
  type: object
apiDeleteWorkspaceOutput:
  properties:
    workspace_uuid:
      description: Workspace
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiDeployment:
  description: Description of deployment
  properties:
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    name:
      description: Name
      example: example name
      type: string
    status:
      $ref: '#/apiDeploymentStatus'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    url:
      description: Access your deployed agent here
      example: example string
      type: string
    uuid:
      description: Unique id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    visibility:
      $ref: '#/apiDeploymentVisibility'
  type: object
apiDeploymentStatus:
  default: STATUS_UNKNOWN
  enum:
  - STATUS_UNKNOWN
  - STATUS_WAITING_FOR_DEPLOYMENT
  - STATUS_DEPLOYING
  - STATUS_RUNNING
  - STATUS_FAILED
  - STATUS_WAITING_FOR_UNDEPLOYMENT
  - STATUS_UNDEPLOYING
  - STATUS_UNDEPLOYMENT_FAILED
  - STATUS_DELETED
  - STATUS_BUILDING
  example: STATUS_UNKNOWN
  type: string
apiDeploymentVisibility:
  default: VISIBILITY_UNKNOWN
  description: |-
    - 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
  enum:
  - VISIBILITY_UNKNOWN
  - VISIBILITY_DISABLED
  - VISIBILITY_PLAYGROUND
  - VISIBILITY_PUBLIC
  - VISIBILITY_PRIVATE
  example: VISIBILITY_UNKNOWN
  type: string
apiDropboxDataSource:
  description: Dropbox Data Source
  properties:
    folder:
      example: example string
      type: string
    refresh_token:
      description: Refresh token. you can obrain a refresh token by following the
        oauth2 flow. see /v2/gen-ai/oauth2/dropbox/tokens for reference.
      example: example string
      type: string
  type: object
apiDropboxDataSourceDisplay:
  description: Dropbox Data Source for Display
  properties:
    folder:
      example: example string
      type: string
  type: object
apiDropboxOauth2GetTokensInput:
  description: The oauth2 code from google
  properties:
    code:
      description: The oauth2 code from google
      example: example string
      type: string
    redirect_url:
      description: Redirect url
      example: example string
      type: string
  type: object
apiDropboxOauth2GetTokensOutput:
  description: The dropbox oauth2 token and refresh token
  properties:
    refresh_token:
      description: The refresh token
      example: example string
      type: string
    token:
      description: The access token
      example: example string
      type: string
  type: object
apiEvaluationDataset:
  properties:
    created_at:
      description: Time created at.
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    dataset_name:
      description: Name of the dataset.
      example: example name
      type: string
    dataset_uuid:
      description: UUID of the dataset.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    file_size:
      description: The size of the dataset uploaded file in bytes.
      example: "12345"
      format: uint64
      type: string
    has_ground_truth:
      description: Does the dataset have a ground truth column?
      example: true
      type: boolean
    row_count:
      description: Number of rows in the dataset.
      example: 123
      format: int64
      type: integer
  type: object
apiEvaluationMetric:
  properties:
    category:
      $ref: '#/apiEvaluationMetricCategory'
    description:
      example: example string
      type: string
    inverted:
      description: If true, the metric is inverted, meaning that a lower value is
        better.
      example: true
      type: boolean
    is_metric_goal:
      example: true
      type: boolean
    metric_name:
      example: example name
      type: string
    metric_rank:
      example: 123
      format: int64
      type: integer
    metric_type:
      $ref: '#/apiEvaluationMetricType'
    metric_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    metric_value_type:
      $ref: '#/apiEvaluationMetricValueType'
    range_max:
      description: The maximum value for the metric.
      example: 123
      format: float
      type: number
    range_min:
      description: The minimum value for the metric.
      example: 123
      format: float
      type: number
  type: object
apiEvaluationMetricCategory:
  default: METRIC_CATEGORY_UNSPECIFIED
  enum:
  - METRIC_CATEGORY_UNSPECIFIED
  - METRIC_CATEGORY_CORRECTNESS
  - METRIC_CATEGORY_USER_OUTCOMES
  - METRIC_CATEGORY_SAFETY_AND_SECURITY
  - METRIC_CATEGORY_CONTEXT_QUALITY
  - METRIC_CATEGORY_MODEL_FIT
  example: METRIC_CATEGORY_UNSPECIFIED
  type: string
apiEvaluationMetricResult:
  properties:
    error_description:
      description: Error description if the metric could not be calculated.
      example: example string
      type: string
    metric_name:
      description: Metric name
      example: example name
      type: string
    metric_value_type:
      $ref: '#/apiEvaluationMetricValueType'
    number_value:
      description: The value of the metric as a number.
      example: 123
      format: double
      type: number
    reasoning:
      description: Reasoning of the metric result.
      example: example string
      type: string
    string_value:
      description: The value of the metric as a string.
      example: example string
      type: string
  type: object
apiEvaluationMetricType:
  default: METRIC_TYPE_UNSPECIFIED
  enum:
  - METRIC_TYPE_UNSPECIFIED
  - METRIC_TYPE_GENERAL_QUALITY
  - METRIC_TYPE_RAG_AND_TOOL
  example: METRIC_TYPE_UNSPECIFIED
  type: string
apiEvaluationMetricValueType:
  default: METRIC_VALUE_TYPE_UNSPECIFIED
  enum:
  - METRIC_VALUE_TYPE_UNSPECIFIED
  - METRIC_VALUE_TYPE_NUMBER
  - METRIC_VALUE_TYPE_STRING
  - METRIC_VALUE_TYPE_PERCENTAGE
  example: METRIC_VALUE_TYPE_UNSPECIFIED
  type: string
apiEvaluationRun:
  properties:
    agent_deleted:
      description: Whether agent is deleted
      example: true
      type: boolean
    agent_name:
      description: Agent name
      example: example name
      type: string
    agent_uuid:
      description: Agent UUID.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    agent_version_hash:
      description: Version hash
      example: example string
      type: string
    agent_workspace_uuid:
      description: Agent workspace uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    created_by_user_email:
      example: example@example.com
      type: string
    created_by_user_id:
      example: "12345"
      format: uint64
      type: string
    error_description:
      description: The error description
      example: example string
      type: string
    evaluation_run_uuid:
      description: Evaluation run UUID.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    evaluation_test_case_workspace_uuid:
      description: Evaluation test case workspace uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    finished_at:
      description: Run end time.
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    pass_status:
      description: The pass status of the evaluation run based on the star metric.
      example: true
      type: boolean
    queued_at:
      description: Run queued time.
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    run_level_metric_results:
      items:
        $ref: '#/apiEvaluationMetricResult'
      type: array
    run_name:
      description: Run name.
      example: example name
      type: string
    star_metric_result:
      $ref: '#/apiEvaluationMetricResult'
    started_at:
      description: Run start time.
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    status:
      $ref: '#/apiEvaluationRunStatus'
    test_case_description:
      description: Test case description.
      example: example string
      type: string
    test_case_name:
      description: Test case name.
      example: example name
      type: string
    test_case_uuid:
      description: Test-case UUID.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    test_case_version:
      description: Test-case-version.
      example: 123
      format: int64
      type: integer
  type: object
apiEvaluationRunStatus:
  default: EVALUATION_RUN_STATUS_UNSPECIFIED
  description: Evaluation Run Statuses
  enum:
  - 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
  example: EVALUATION_RUN_STATUS_UNSPECIFIED
  type: string
apiEvaluationTestCase:
  properties:
    archived_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by_user_email:
      example: example@example.com
      type: string
    created_by_user_id:
      example: "12345"
      format: uint64
      type: string
    dataset:
      $ref: '#/apiEvaluationDataset'
    dataset_name:
      example: example name
      type: string
    dataset_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    description:
      example: example string
      type: string
    latest_version_number_of_runs:
      example: 123
      format: int32
      type: integer
    metrics:
      items:
        $ref: '#/apiEvaluationMetric'
      type: array
    name:
      example: example name
      type: string
    star_metric:
      $ref: '#/apiStarMetric'
    test_case_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    total_runs:
      example: 123
      format: int32
      type: integer
    updated_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    updated_by_user_email:
      example: example@example.com
      type: string
    updated_by_user_id:
      example: "12345"
      format: uint64
      type: string
    version:
      example: 123
      format: int64
      type: integer
  type: object
apiEvaluationTestCaseMetricList:
  properties:
    metric_uuids:
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
  type: object
apiEvaluationUsage:
  properties:
    agent_measurements:
      items:
        $ref: '#/apiEvaluationUsageMeasurement'
      type: array
    guardrail_measurements:
      items:
        $ref: '#/apiEvaluationUsageMeasurement'
      type: array
    start:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    stop:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
  type: object
apiEvaluationUsageMeasurement:
  properties:
    measurements:
      items:
        $ref: '#/apiUsageMeasurement'
      type: array
    resource_name:
      example: example name
      type: string
    resource_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiFilePresignedUrlResponse:
  description: Detailed info about each presigned URL returned to the client.
  properties:
    expires_at:
      description: The time the url expires at.
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    object_key:
      description: The unique object key to store the file as.
      example: example string
      type: string
    original_file_name:
      description: The original file name.
      example: example name
      type: string
    presigned_url:
      description: The actual presigned URL the client can use to upload the file
        directly.
      example: example string
      type: string
  type: object
apiFileUploadDataSource:
  description: File to upload as data source for knowledge base.
  properties:
    original_file_name:
      description: The original file name
      example: example name
      type: string
    size_in_bytes:
      description: The size of the file in bytes
      example: "12345"
      format: uint64
      type: string
    stored_object_key:
      description: The object key the file was stored as
      example: example string
      type: string
  type: object
apiGalileoJWTOutput:
  properties:
    access_token:
      description: Access token for the clickout to Galileo
      example: example string
      type: string
    base_url:
      description: Base URL for the Galileo instance
      example: example string
      type: string
    expires_at:
      description: Expiry time of the access token
      example: example string
      type: string
  type: object
apiGenerateOauth2URLOutput:
  description: The url for the oauth2 flow
  properties:
    url:
      description: The oauth2 url
      example: example string
      type: string
  type: object
apiGetAgentDeploymentReleaseOutput:
  description: One Agent Deployment Release
  properties:
    agent_deployment_release:
      $ref: '#/apiAgentDeploymentRelease'
  type: object
apiGetAgentInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetAgentInsightsMetricsResponse:
  properties:
    metrics:
      $ref: '#/apiMetricResponse'
  type: object
apiGetAgentOutput:
  description: One Agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiGetAgentRuntimeLogsRequestPublic:
  properties:
    follow:
      example: "true"
    tail_lines:
      example: "10"
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetAgentRuntimeLogsResponse:
  description: Agent runtime logs response
  properties:
    live_url:
      description: URL for live logs
      example: example string
      type: string
  type: object
apiGetAgentTemplateInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetAgentTemplateOutput:
  properties:
    template:
      $ref: '#/apiAgentTemplate'
  type: object
apiGetAgentUsageInputPublic:
  properties:
    start:
      example: '"2021-01-01T00:00:00Z"'
    stop:
      example: '"2021-01-02T00:00:00Z"'
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetAgentUsageOutput:
  description: Agent usage
  properties:
    log_insights_usage:
      $ref: '#/apiResourceUsage'
    usage:
      $ref: '#/apiResourceUsage'
  type: object
apiGetAgentWorkspaceDeploymentOutput:
  description: One Agent Workspace Deployment
  properties:
    agent_workspace_deployment:
      $ref: '#/apiAgentWorkspaceDeployment'
  type: object
apiGetAgentWorkspaceDeploymentRuntimeLogsOutput:
  properties:
    live_url:
      description: URL for live logs
      example: example string
      type: string
  type: object
apiGetAgentWorkspaceOutput:
  description: One Agent Workspace
  properties:
    agent_workspace:
      $ref: '#/apiAgentWorkspace'
  type: object
apiGetAnthropicAPIKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetAnthropicAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiAnthropicAPIKeyInfo'
  type: object
apiGetChildrenInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetChildrenOutput:
  description: Child list for an agent
  properties:
    children:
      description: Child agents
      items:
        $ref: '#/apiAgent'
      type: array
  type: object
apiGetEvaluationRunOutput:
  properties:
    evaluation_run:
      $ref: '#/apiEvaluationRun'
  type: object
apiGetEvaluationRunPromptResultsOutput:
  properties:
    prompt:
      $ref: '#/apiPrompt'
  type: object
apiGetEvaluationRunResultsOutput:
  description: Gets the full results of an evaluation run with all prompts.
  properties:
    evaluation_run:
      $ref: '#/apiEvaluationRun'
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
    prompts:
      description: The prompt level results.
      items:
        $ref: '#/apiPrompt'
      type: array
  type: object
apiGetEvaluationRunUsageOutput:
  properties:
    usage:
      $ref: '#/apiEvaluationUsage'
  type: object
apiGetEvaluationTestCaseOutput:
  properties:
    evaluation_test_case:
      $ref: '#/apiEvaluationTestCase'
  type: object
apiGetEvaluationTestCaseUsageOutput:
  properties:
    usage:
      $ref: '#/apiEvaluationUsage'
  type: object
apiGetGuardrailOutput:
  properties:
    guardrail:
      $ref: '#/apiGuardrail'
  type: object
apiGetGuardrailUsageOutput:
  description: Guardrail usage output
  properties:
    usage:
      $ref: '#/apiResourceUsage'
  type: object
apiGetIndexingJobDetailsSignedURLInputPublic:
  properties:
    indexing_job_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetIndexingJobDetailsSignedURLOutput:
  properties:
    signed_url:
      description: The signed url for downloading the indexing job details
      example: example string
      type: string
  type: object
apiGetKnowledgeBaseIndexingJobInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetKnowledgeBaseIndexingJobOutput:
  description: GetKnowledgeBaseIndexingJobOutput description
  properties:
    job:
      $ref: '#/apiIndexingJob'
  type: object
apiGetKnowledgeBaseIndexingJobUsageInputPublic:
  properties:
    start:
      example: '"2021-01-01T00:00:00Z"'
    stop:
      example: '"2021-01-02T00:00:00Z"'
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetKnowledgeBaseIndexingJobUsageOutput:
  description: Knowledge base indexing job usage
  properties:
    usage:
      $ref: '#/apiResourceUsage'
  type: object
apiGetKnowledgeBaseInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetKnowledgeBaseOutput:
  description: The knowledge base
  properties:
    database_status:
      $ref: '#/dbaasClusterStatus'
    knowledge_base:
      $ref: '#/apiKnowledgeBase'
  type: object
apiGetModelInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetModelOutput:
  description: A specific model
  properties:
    model:
      $ref: '#/apiModel'
  type: object
apiGetModelPlaygroundTokensInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetModelPlaygroundTokensOutput:
  description: GetModelPlaygroundTokensOutput description
  properties:
    token_limit_per_day:
      description: Daily token limit
      example: "12345"
      format: uint64
      type: string
    tokens_remaining:
      description: Tokens remaining
      example: 123
      format: int64
      type: integer
  type: object
apiGetModelProviderKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetModelProviderKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelProviderKeyInfo'
  type: object
apiGetModelUsageInputPublic:
  properties:
    start:
      example: '"2021-01-01T00:00:00Z"'
    stop:
      example: '"2021-01-02T00:00:00Z"'
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetModelUsageOutput:
  description: Information about model usage
  properties:
    usage:
      $ref: '#/apiResourceUsage'
  type: object
apiGetModelVersionsInputPublic:
  properties:
    name:
      example: '"My Model"'
apiGetOpenAIAPIKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetOpenAIAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiOpenAIAPIKeyInfo'
  type: object
apiGetPreferredRegionOutput:
  description: Region code of preferred Regions
  properties:
    region:
      $ref: '#/genaiapiRegion'
  type: object
apiGetResourceLimitsOutput:
  properties:
    agent_count:
      description: Total agents used
      example: 123
      format: int64
      type: integer
    agent_limit:
      description: Total permitted agents
      example: 123
      format: int64
      type: integer
    guardrail_count:
      description: Total guardrails used
      example: 123
      format: int64
      type: integer
    guardrail_limit:
      description: Total permitted guardrails
      example: 123
      format: int64
      type: integer
    knowledge_base_count:
      description: Total knowledge bases used
      example: 123
      format: int64
      type: integer
    knowledge_base_limit:
      description: Total permitted knowledge bases
      example: 123
      format: int64
      type: integer
  type: object
apiGetResourceUsageOutput:
  description: Resource usage output
  properties:
    agent_count:
      description: Total agents used
      example: 123
      format: int64
      type: integer
    agent_usage:
      description: Agent usage
      items:
        $ref: '#/apiResourceUsage'
      type: array
    guardrail_count:
      description: Total guardrails used
      example: 123
      format: int64
      type: integer
    guardrail_usage:
      description: Guardrail usage
      items:
        $ref: '#/apiResourceUsage'
      type: array
    indexing_job_usage:
      description: Indexing job usage
      items:
        $ref: '#/apiResourceUsage'
      type: array
    knowledge_base_count:
      description: Total knowledge bases used
      example: 123
      format: int64
      type: integer
  type: object
apiGetScheduledIndexingOutput:
  properties:
    indexing_info:
      $ref: '#/apiScheduledIndexingInfo'
  type: object
apiGetServerlessInferenceUsageInputPublic:
  properties:
    start:
      example: '"2021-01-01T00:00:00Z"'
    stop:
      example: '"2021-01-02T00:00:00Z"'
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiGetServerlessInferenceUsageOutput:
  description: Serverless inference usage output
  properties:
    usage:
      $ref: '#/apiResourceUsage'
  type: object
apiGetTeamAgreementOutput:
  description: GetTeamAgreementOutput Output
  properties:
    team_agreement:
      $ref: '#/apiTeamAgreement'
  type: object
apiGetWorkspaceOutput:
  properties:
    workspace:
      $ref: '#/apiWorkspace'
  type: object
apiGoogleDriveDataSource:
  description: Google Drive Data Source
  properties:
    folder_id:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    refresh_token:
      description: Refresh token. you can obrain a refresh token by following the
        oauth2 flow. see /v2/gen-ai/oauth2/google/tokens for reference.
      example: example string
      type: string
  type: object
apiGoogleDriveDataSourceDisplay:
  description: Google Drive Data Source for Display
  properties:
    folder_id:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    folder_name:
      description: Name of the selected folder if available
      example: example name
      type: string
  type: object
apiGoogleDriveFolder:
  description: A folder in google drive
  properties:
    id:
      description: Id of the folder
      example: example string
      type: string
    name:
      description: Name of the folder
      example: example name
      type: string
    parent_id:
      description: Id of the parent folder - if empty it is a root folder
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiGoogleOauth2GetTokensInput:
  description: The oauth2 code from google
  properties:
    code:
      description: The oauth2 code from google
      example: example string
      type: string
    list_folders:
      description: Request folders in return
      example: true
      type: boolean
    redirect_url:
      description: 'Optional: redirect url'
      example: example string
      type: string
  type: object
apiGoogleOauth2GetTokensOutput:
  description: The google oauth2 token and refresh token
  properties:
    folders:
      description: The folders
      items:
        $ref: '#/apiGoogleDriveFolder'
      type: array
    refresh_token:
      description: The refresh token
      example: example string
      type: string
    token:
      description: The access token
      example: example string
      type: string
  type: object
apiGuardrail:
  description: Guardrail description
  properties:
    agent_uuids:
      description: List of attached agents uuids
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by user id from DO
      example: "12345"
      format: uint64
      type: string
    default_response:
      example: example string
      type: string
    description:
      example: example string
      type: string
    is_default:
      example: true
      type: boolean
    metadata:
      type: object
    name:
      example: example name
      type: string
    template_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    type:
      $ref: '#/apiGuardrailType'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiGuardrailPrice:
  properties:
    attributes:
      items:
        $ref: '#/apiBillingAttribute'
      type: array
    display_name:
      example: example name
      type: string
    guardrail_template_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    prices:
      items:
        $ref: '#/apiBillingPrice'
      type: array
  type: object
apiGuardrailTemplate:
  description: GuardrailTemplate description
  properties:
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    default_response:
      example: example string
      type: string
    description:
      example: example string
      type: string
    metadata:
      type: object
    name:
      example: example name
      type: string
    type:
      $ref: '#/apiGuardrailType'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiGuardrailType:
  default: GUARDRAIL_TYPE_UNKNOWN
  enum:
  - GUARDRAIL_TYPE_UNKNOWN
  - GUARDRAIL_TYPE_JAILBREAK
  - GUARDRAIL_TYPE_SENSITIVE_DATA
  - GUARDRAIL_TYPE_CONTENT_MODERATION
  example: GUARDRAIL_TYPE_UNKNOWN
  type: string
apiIndexJobStatus:
  default: INDEX_JOB_STATUS_UNKNOWN
  enum:
  - INDEX_JOB_STATUS_UNKNOWN
  - INDEX_JOB_STATUS_PARTIAL
  - INDEX_JOB_STATUS_IN_PROGRESS
  - INDEX_JOB_STATUS_COMPLETED
  - INDEX_JOB_STATUS_FAILED
  - INDEX_JOB_STATUS_NO_CHANGES
  - INDEX_JOB_STATUS_PENDING
  - INDEX_JOB_STATUS_CANCELLED
  example: INDEX_JOB_STATUS_UNKNOWN
  type: string
apiIndexedDataSource:
  properties:
    completed_at:
      description: Timestamp when data source completed indexing
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    data_source_uuid:
      description: Uuid of the indexed data source
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    error_details:
      description: A detailed error description
      example: example string
      type: string
    error_msg:
      description: A string code provinding a hint which part of the system experienced
        an error
      example: example string
      type: string
    failed_item_count:
      description: Total count of files that have failed
      example: "12345"
      format: uint64
      type: string
    indexed_file_count:
      description: Total count of files that have been indexed
      example: "12345"
      format: uint64
      type: string
    indexed_item_count:
      description: Total count of files that have been indexed
      example: "12345"
      format: uint64
      type: string
    removed_item_count:
      description: Total count of files that have been removed
      example: "12345"
      format: uint64
      type: string
    skipped_item_count:
      description: Total count of files that have been skipped
      example: "12345"
      format: uint64
      type: string
    started_at:
      description: Timestamp when data source started indexing
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    status:
      $ref: '#/apiIndexedDataSourceStatus'
    total_bytes:
      description: Total size of files in data source in bytes
      example: "12345"
      format: uint64
      type: string
    total_bytes_indexed:
      description: Total size of files in data source in bytes that have been indexed
      example: "12345"
      format: uint64
      type: string
    total_file_count:
      description: Total file count in the data source
      example: "12345"
      format: uint64
      type: string
  type: object
apiIndexedDataSourceStatus:
  default: DATA_SOURCE_STATUS_UNKNOWN
  enum:
  - DATA_SOURCE_STATUS_UNKNOWN
  - DATA_SOURCE_STATUS_IN_PROGRESS
  - DATA_SOURCE_STATUS_UPDATED
  - DATA_SOURCE_STATUS_PARTIALLY_UPDATED
  - DATA_SOURCE_STATUS_NOT_UPDATED
  - DATA_SOURCE_STATUS_FAILED
  - DATA_SOURCE_STATUS_CANCELLED
  example: DATA_SOURCE_STATUS_UNKNOWN
  type: string
apiIndexingJob:
  description: IndexingJob description
  properties:
    completed_datasources:
      description: Number of datasources indexed completed
      example: 123
      format: int64
      type: integer
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    data_source_jobs:
      description: Details on Data Sources included in the Indexing Job
      items:
        $ref: '#/apiIndexedDataSource'
      type: array
    data_source_uuids:
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    finished_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    is_report_available:
      description: Boolean value to determine if the indexing job details are available
      example: true
      type: boolean
    knowledge_base_uuid:
      description: Knowledge base id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    phase:
      $ref: '#/apiBatchJobPhase'
    started_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    status:
      $ref: '#/apiIndexJobStatus'
    tokens:
      description: Number of tokens [This field is deprecated]
      example: 123
      format: int64
      type: integer
    total_datasources:
      description: Number of datasources being indexed
      example: 123
      format: int64
      type: integer
    total_tokens:
      description: Total Tokens Consumed By the Indexing Job
      example: "12345"
      format: uint64
      type: string
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiIssueAgentTokenOutput:
  description: Information about a newly issued token
  properties:
    access_token:
      description: The token
      example: example string
      type: string
    refresh_token:
      description: The token used to refresh
      example: example string
      type: string
  type: object
apiIssueModelPlaygroundTokenOutput:
  description: IssueModelPlaygroundTokenOutput description
  properties:
    access_token:
      example: example string
      type: string
    refresh_token:
      example: example string
      type: string
  type: object
apiKBDataSource:
  properties:
    aws_data_source:
      $ref: '#/apiAWSDataSource'
    bucket_name:
      description: Deprecated, moved to data_source_details
      example: example name
      type: string
    bucket_region:
      description: Deprecated, moved to data_source_details
      example: example string
      type: string
    dropbox_data_source:
      $ref: '#/apiDropboxDataSource'
    file_upload_data_source:
      $ref: '#/apiFileUploadDataSource'
    google_drive_data_source:
      $ref: '#/apiGoogleDriveDataSource'
    item_path:
      example: example string
      type: string
    spaces_data_source:
      $ref: '#/apiSpacesDataSource'
    web_crawler_data_source:
      $ref: '#/apiWebCrawlerDataSource'
  type: object
apiKnowledgeBase:
  description: Knowledgebase Description
  properties:
    added_to_agent_at:
      description: Time when the knowledge base was added to the agent
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    database_id:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    embedding_model_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    is_public:
      description: Whether the knowledge base is public or not
      example: true
      type: boolean
    last_indexing_job:
      $ref: '#/apiIndexingJob'
    name:
      description: Name of knowledge base
      example: example name
      type: string
    project_id:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    region:
      description: Region code
      example: example string
      type: string
    tags:
      description: Tags to organize related resources
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    user_id:
      description: Id of user that created the knowledge base
      example: "12345"
      format: int64
      type: string
    uuid:
      description: Unique id for knowledge base
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiKnowledgeBaseDataSource:
  description: Data Source configuration for Knowledge Bases
  properties:
    aws_data_source:
      $ref: '#/apiAWSDataSourceDisplay'
    bucket_name:
      description: Name of storage bucket - Deprecated, moved to data_source_details
      example: example name
      type: string
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    dropbox_data_source:
      $ref: '#/apiDropboxDataSourceDisplay'
    file_upload_data_source:
      $ref: '#/apiFileUploadDataSource'
    google_drive_data_source:
      $ref: '#/apiGoogleDriveDataSourceDisplay'
    item_path:
      description: Path of folder or object in bucket - Deprecated, moved to data_source_details
      example: example string
      type: string
    last_datasource_indexing_job:
      $ref: '#/apiIndexedDataSource'
    region:
      description: Region code - Deprecated, moved to data_source_details
      example: example string
      type: string
    spaces_data_source:
      $ref: '#/apiSpacesDataSource'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique id of knowledge base
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    web_crawler_data_source:
      $ref: '#/apiWebCrawlerDataSource'
  type: object
apiKnowledgeBasePrice:
  properties:
    attributes:
      items:
        $ref: '#/apiBillingAttribute'
      type: array
    display_name:
      example: example name
      type: string
    model_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    prices:
      items:
        $ref: '#/apiBillingPrice'
      type: array
  type: object
apiLinkAgentFunctionInputPublic:
  description: Information for a agent function link
  properties:
    agent_uuid:
      description: Agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    description:
      description: Function description
      example: '"My Function Description"'
      type: string
    faas_name:
      description: The name of the function in the DigitalOcean functions platform.
        Must include the package name as a prefix in the format package_name/function_name.
        If the function is not created under a specific package, use "default" as
        the package name (e.g. default/my-function).
      example: '"package_name/function_name"'
      type: string
    faas_namespace:
      description: The UUID of the namespace in the DigitalOcean functions platform.
        This is the unique identifier displayed below the namespace name in the control
        panel, not the namespace name itself.
      example: '"fn-abc01234-1234-1234-1234-123456789012"'
      type: string
    function_name:
      description: Function name
      example: '"My Function"'
      type: string
    input_schema:
      description: Describe the input schema for the function so the agent may call
        it
      type: object
    output_schema:
      description: Describe the output schema for the function so the agent handle
        its response
      type: object
  type: object
apiLinkAgentFunctionOutput:
  description: Information about a newly function linked agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiLinkAgentGuardrailOutput:
  description: Information about an updated agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiLinkAgentInputPublic:
  description: Information for linking an agent
  properties:
    child_agent_uuid:
      description: Routed agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    if_case:
      example: '"use this to get weather information"'
      type: string
    parent_agent_uuid:
      description: A unique identifier for the parent agent.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    route_name:
      description: Name of route
      example: '"weather_route"'
      type: string
  type: object
apiLinkAgentOutput:
  description: Information about a newly linked agent
  properties:
    child_agent_uuid:
      description: Routed agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    parent_agent_uuid:
      description: A unique identifier for the parent agent.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiLinkKnowledgeBaseInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    knowledge_base_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiLinkKnowledgeBaseOutput:
  description: Information about a linked knowledge base
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiLinkKnowledgeBasesInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    knowledge_base_uuids:
      example: '["12345678-1234-1234-1234-123456789012", "12345678-1234-1234-1234-123456789012"]'
apiLinks:
  description: Links to other pages
  properties:
    pages:
      $ref: '#/apiPages'
  type: object
apiListAgentAPIKeysInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    page:
      example: "1"
    per_page:
      example: "20"
apiListAgentAPIKeysOutput:
  properties:
    api_key_infos:
      description: Api key infos
      items:
        $ref: '#/apiAgentAPIKeyInfo'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentDeploymentReleasesOutput:
  description: Query all agent deployment releases for a given agent deployment
  properties:
    agent_deployment_releases:
      description: The agent deployment releases
      items:
        $ref: '#/apiAgentDeploymentRelease'
      type: array
  type: object
apiListAgentPricesOutput:
  properties:
    agent_prices:
      items:
        $ref: '#/apiAgentPrice'
      type: array
    log_insights_prices:
      items:
        $ref: '#/apiAgentLogInsightsPrice'
      type: array
  type: object
apiListAgentTemplatesInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
    template_type:
      example: one-click
apiListAgentTemplatesOutput:
  properties:
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
    templates:
      items:
        $ref: '#/apiAgentTemplate'
      type: array
  type: object
apiListAgentVersionsInputPublic:
  properties:
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiListAgentVersionsOutput:
  description: List of agent versions
  properties:
    agent_versions:
      description: Agents
      items:
        $ref: '#/apiAgentVersion'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentWorkspaceDeploymentsOutput:
  properties:
    agent_workspace_deployments:
      description: The agent workspace deployments
      items:
        $ref: '#/apiAgentWorkspaceDeployment'
      type: array
  type: object
apiListAgentWorkspacesOutput:
  description: List of Agent Workspaces
  properties:
    agent_workspaces:
      description: Agent Workspaces
      items:
        $ref: '#/apiAgentWorkspace'
      type: array
  type: object
apiListAgentsByAnthropicKeyInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiListAgentsByAnthropicKeyOutput:
  description: List of Agents that linked to a specific Anthropic Key
  properties:
    agents:
      items:
        $ref: '#/apiAgent'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentsByModelProviderKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    page:
      example: "1"
    per_page:
      example: "20"
apiListAgentsByModelProviderKeyOutput:
  properties:
    agents:
      description: Api key infos
      items:
        $ref: '#/apiAgent'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentsByOpenAIKeyInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
    uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiListAgentsByOpenAIKeyOutput:
  description: List of Agents that are linked to a specific OpenAI Key
  properties:
    agents:
      items:
        $ref: '#/apiAgent'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentsByWorkspaceOutput:
  properties:
    agents:
      items:
        $ref: '#/apiAgent'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentsInputPublic:
  properties:
    only_deployed:
      example: "true"
    page:
      example: "1"
    per_page:
      example: "20"
apiListAgentsOutput:
  description: List of Agents
  properties:
    agents:
      description: Agents
      items:
        $ref: '#/apiAgent'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAgentsOutputPublic:
  description: List of Agents
  properties:
    agents:
      description: Agents
      items:
        $ref: '#/apiAgentPublic'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListAnthropicAPIKeysInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
apiListAnthropicAPIKeysOutput:
  description: ListAnthropicAPIKeysOutput is used to return the list of Anthropic
    API keys for a specific agent.
  properties:
    api_key_infos:
      description: Api key infos
      items:
        $ref: '#/apiAnthropicAPIKeyInfo'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListEvaluationMetricsOutput:
  properties:
    metrics:
      items:
        $ref: '#/apiEvaluationMetric'
      type: array
  type: object
apiListEvaluationPricesOutput:
  properties:
    evaluation_agent_prices:
      items:
        $ref: '#/apiAgentPrice'
      type: array
    evaluation_guardrail_prices:
      items:
        $ref: '#/apiGuardrailPrice'
      type: array
  type: object
apiListEvaluationRunsByAgentOutput:
  properties:
    evaluation_runs:
      items:
        $ref: '#/apiEvaluationRun'
      type: array
  type: object
apiListEvaluationRunsByTestCaseOutput:
  properties:
    evaluation_runs:
      description: List of evaluation runs.
      items:
        $ref: '#/apiEvaluationRun'
      type: array
  type: object
apiListEvaluationTestCasesByWorkspaceOutput:
  properties:
    evaluation_test_cases:
      items:
        $ref: '#/apiEvaluationTestCase'
      type: array
  type: object
apiListEvaluationTestCasesOutput:
  properties:
    evaluation_test_cases:
      description: Alternative way of authentication for internal usage only - should
        not be exposed to public api
      items:
        $ref: '#/apiEvaluationTestCase'
      type: array
  type: object
apiListGuardrailAgentsOutput:
  properties:
    agents:
      items:
        $ref: '#/apiAgent'
      type: array
  type: object
apiListGuardrailPricesOutput:
  properties:
    guardrail_prices:
      items:
        $ref: '#/apiGuardrailPrice'
      type: array
  type: object
apiListGuardrailTemplatesOutput:
  description: ListGuardrailTemplatesOutput description
  properties:
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
    templates:
      items:
        $ref: '#/apiGuardrailTemplate'
      type: array
  type: object
apiListGuardrailsOutput:
  description: ListGuardrailsOutput description
  properties:
    guardrails:
      items:
        $ref: '#/apiGuardrail'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListIndexingJobDataSourcesInputPublic:
  properties:
    indexing_job_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiListIndexingJobDataSourcesOutput:
  properties:
    indexed_data_sources:
      items:
        $ref: '#/apiIndexedDataSource'
      type: array
  type: object
apiListIndexingJobsByKnowledgeBaseUUIDInputPublic:
  properties:
    knowledge_base_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiListKnowledgeBaseAgentsInputPublic:
  properties:
    knowledge_base_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiListKnowledgeBaseAgentsOutput:
  description: List of agents
  properties:
    agents:
      description: The agents
      items:
        $ref: '#/apiAgent'
      type: array
  type: object
apiListKnowledgeBaseDataSourcesInputPublic:
  properties:
    knowledge_base_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    page:
      example: "1"
    per_page:
      example: "20"
apiListKnowledgeBaseDataSourcesOutput:
  description: A list of knowledge base data sources
  properties:
    knowledge_base_data_sources:
      description: The data sources
      items:
        $ref: '#/apiKnowledgeBaseDataSource'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListKnowledgeBaseIndexingJobsInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
apiListKnowledgeBaseIndexingJobsOutput:
  description: Indexing jobs
  properties:
    jobs:
      description: The indexing jobs
      items:
        $ref: '#/apiIndexingJob'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListKnowledgeBasePricesOutput:
  properties:
    knowledge_base_prices:
      items:
        $ref: '#/apiKnowledgeBasePrice'
      type: array
  type: object
apiListKnowledgeBasesByDatabaseOutput:
  description: List of knowledge bases
  properties:
    knowledge_bases:
      description: The knowledge bases
      items:
        $ref: '#/apiKnowledgeBase'
      type: array
  type: object
apiListKnowledgeBasesInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
apiListKnowledgeBasesOutput:
  description: List of knowledge bases
  properties:
    knowledge_bases:
      description: The knowledge bases
      items:
        $ref: '#/apiKnowledgeBase'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListModelAPIKeysInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
apiListModelAPIKeysOutput:
  properties:
    api_key_infos:
      description: Api key infos
      items:
        $ref: '#/apiModelAPIKeyInfo'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListModelPricesOutput:
  properties:
    model_prices:
      items:
        $ref: '#/apiModelPrice'
      type: array
  type: object
apiListModelProviderKeysInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
apiListModelProviderKeysOutput:
  properties:
    api_key_infos:
      description: Api key infos
      items:
        $ref: '#/apiModelProviderKeyInfo'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListModelUsagesByAgentOutput:
  description: ListModelUsagesByAgentOutput description
  properties:
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
    request_limit_per_minute:
      description: Total request limit per minute
      example: "12345"
      format: uint64
      type: string
    token_limit_per_day:
      description: Total token limit per day
      example: "12345"
      format: uint64
      type: string
    token_limit_per_minute:
      description: Total token limit per minute
      example: "12345"
      format: uint64
      type: string
    usages:
      description: The model's usage by agent
      items:
        $ref: '#/apiAgentModelUsage'
      type: array
  type: object
apiListModelsInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
    public_only:
      example: "true"
    usecases:
      example: AGENT
apiListModelsOutput:
  description: A list of models
  properties:
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
    models:
      description: The models
      items:
        $ref: '#/apiModel'
      type: array
  type: object
apiListModelsOutputPublic:
  description: A list of models
  properties:
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
    models:
      description: The models
      items:
        $ref: '#/apiModelPublic'
      type: array
  type: object
apiListOpenAIAPIKeysInputPublic:
  properties:
    page:
      example: "1"
    per_page:
      example: "20"
apiListOpenAIAPIKeysOutput:
  description: ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys
    for a specific agent.
  properties:
    api_key_infos:
      description: Api key infos
      items:
        $ref: '#/apiOpenAIAPIKeyInfo'
      type: array
    links:
      $ref: '#/apiLinks'
    meta:
      $ref: '#/apiMeta'
  type: object
apiListRegionsOutput:
  description: Region Codes
  properties:
    regions:
      description: Region code
      items:
        $ref: '#/genaiapiRegion'
      type: array
  type: object
apiListServerlessInferencePricesOutput:
  properties:
    serverless_inference_prices:
      items:
        $ref: '#/apiServerlessInferencePrice'
      type: array
  type: object
apiListWorkspacesOutput:
  properties:
    workspaces:
      description: Workspaces
      items:
        $ref: '#/apiWorkspace'
      type: array
  type: object
apiMeta:
  description: Meta information about the data set
  properties:
    page:
      description: The current page
      example: 123
      format: int64
      type: integer
    pages:
      description: Total number of pages
      example: 123
      format: int64
      type: integer
    total:
      description: Total amount of items over all pages
      example: 123
      format: int64
      type: integer
  type: object
apiMetricResponse:
  properties:
    results:
      description: A list of metric results
      items:
        $ref: '#/apiMetricResult'
      type: array
  type: object
apiMetricResult:
  description: MetricResult message to represent individual metric data
  properties:
    labels:
      additionalProperties:
        example: example string
        type: string
      description: Labels for the metric (e.g., metadata like agent_uuid, usage_type)
      type: object
    values:
      description: Data points for the metric
      items:
        $ref: '#/apiDataPoint'
      type: array
  type: object
apiModel:
  description: Description of a Model
  properties:
    agreement:
      $ref: '#/apiAgreement'
    created_at:
      description: Creation date / time
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    inference_name:
      description: Internally used name
      example: example name
      type: string
    inference_version:
      description: Internally used version
      example: example string
      type: string
    is_foundational:
      description: True if it is a foundational model provided by do
      example: true
      type: boolean
    metadata:
      description: Additional meta data
      type: object
    name:
      description: Name of the model
      example: example name
      type: string
    parent_uuid:
      description: Unique id of the model, this model is based on
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    provider:
      $ref: '#/apiModelProvider'
    updated_at:
      description: Last modified
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    upload_complete:
      description: Model has been fully uploaded
      example: true
      type: boolean
    url:
      description: Download url
      example: example string
      type: string
    usecases:
      description: Usecases of the model
      example:
      - MODEL_USECASE_AGENT
      - MODEL_USECASE_GUARDRAIL
      items:
        $ref: '#/apiModelUsecase'
      type: array
    uuid:
      description: Unique id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    version:
      $ref: '#/apiModelVersion'
  type: object
apiModelAPIKeyInfo:
  description: Model API Key Info
  properties:
    created_at:
      description: Creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by
      example: "12345"
      format: uint64
      type: string
    deleted_at:
      description: Deleted date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    name:
      description: Name
      example: example name
      type: string
    secret_key:
      example: example string
      type: string
    uuid:
      description: Uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiModelPrice:
  properties:
    attributes:
      items:
        $ref: '#/apiBillingAttribute'
      type: array
    display_name:
      example: example name
      type: string
    model_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    prices:
      items:
        $ref: '#/apiBillingPrice'
      type: array
  type: object
apiModelProvider:
  default: MODEL_PROVIDER_DIGITALOCEAN
  enum:
  - MODEL_PROVIDER_DIGITALOCEAN
  - MODEL_PROVIDER_ANTHROPIC
  - MODEL_PROVIDER_OPENAI
  example: MODEL_PROVIDER_DIGITALOCEAN
  type: string
apiModelProviderKeyInfo:
  properties:
    api_key_uuid:
      description: API key ID
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    created_at:
      description: Key creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by user id from DO
      example: "12345"
      format: uint64
      type: string
    deleted_at:
      description: Key deleted date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    models:
      description: Models supported by the openAI api key
      items:
        $ref: '#/apiModel'
      type: array
    name:
      description: Name of the key
      example: example name
      type: string
    provider:
      $ref: '#/apiModelProvider'
    updated_at:
      description: Key last updated date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
  type: object
apiModelPublic:
  description: A machine learning model stored on the GenAI platform
  properties:
    agreement:
      $ref: '#/apiAgreement'
    created_at:
      description: Creation date / time
      example: "2021-01-01T00:00:00Z"
      format: date-time
      type: string
    id:
      description: Human-readable model identifier
      example: llama3.3-70b-instruct
      type: string
    is_foundational:
      description: True if it is a foundational model provided by do
      example: true
      type: boolean
    name:
      description: Display name of the model
      example: Llama 3.3 Instruct (70B)
      type: string
    parent_uuid:
      description: Unique id of the model, this model is based on
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    updated_at:
      description: Last modified
      example: "2021-01-01T00:00:00Z"
      format: date-time
      type: string
    upload_complete:
      description: Model has been fully uploaded
      example: true
      type: boolean
    url:
      description: Download url
      example: https://example.com/model.zip
      type: string
    uuid:
      description: Unique id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    version:
      $ref: '#/apiModelVersion'
  type: object
apiModelUploadCompleteOutput:
  description: Information about an updated model
  properties:
    model:
      $ref: '#/apiModel'
  type: object
apiModelUsecase:
  default: MODEL_USECASE_UNKNOWN
  description: |-
    - MODEL_USECASE_UNKNOWN: The use case of the model is unknown
     - MODEL_USECASE_AGENT: The model maybe used in an agent
     - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning
     - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models)
     - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails
     - MODEL_USECASE_REASONING: The model usecase for reasoning
     - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference
  enum:
  - MODEL_USECASE_UNKNOWN
  - MODEL_USECASE_AGENT
  - MODEL_USECASE_FINETUNED
  - MODEL_USECASE_KNOWLEDGEBASE
  - MODEL_USECASE_GUARDRAIL
  - MODEL_USECASE_REASONING
  - MODEL_USECASE_SERVERLESS
  example: MODEL_USECASE_UNKNOWN
  type: string
apiModelVersion:
  description: Version Information about a Model
  properties:
    major:
      description: Major version number
      example: 123
      format: int64
      type: integer
    minor:
      description: Minor version number
      example: 123
      format: int64
      type: integer
    patch:
      description: Patch version number
      example: 123
      format: int64
      type: integer
  type: object
apiMoveAgentsToWorkspaceInputPublic:
  description: Parameters for Moving agents to a Workspace
  properties:
    agent_uuids:
      description: Agent uuids
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    workspace_uuid:
      description: Workspace uuid to move agents to
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiMoveAgentsToWorkspaceOutput:
  properties:
    workspace:
      $ref: '#/apiWorkspace'
  type: object
apiOpenAIAPIKeyInfo:
  description: OpenAI API Key Info
  properties:
    created_at:
      description: Key creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: Created by user id from DO
      example: "12345"
      format: uint64
      type: string
    deleted_at:
      description: Key deleted date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    models:
      description: Models supported by the openAI api key
      items:
        $ref: '#/apiModel'
      type: array
    name:
      description: Name
      example: example name
      type: string
    updated_at:
      description: Key last updated date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Uuid
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiPages:
  description: Information about how to reach other pages
  properties:
    first:
      description: First page
      example: example string
      type: string
    last:
      description: Last page
      example: example string
      type: string
    next:
      description: Next page
      example: example string
      type: string
    previous:
      description: Previous page
      example: example string
      type: string
  type: object
apiPresignedUrlFile:
  description: A single file’s metadata in the request.
  properties:
    file_name:
      description: Local filename
      example: example name
      type: string
    file_size:
      description: The size of the file in bytes.
      example: "12345"
      format: int64
      type: string
  type: object
apiPrompt:
  properties:
    ground_truth:
      description: The ground truth for the prompt.
      example: example string
      type: string
    input:
      example: example string
      type: string
    input_tokens:
      description: The number of input tokens used in the prompt.
      example: "12345"
      format: uint64
      type: string
    output:
      example: example string
      type: string
    output_tokens:
      description: The number of output tokens used in the prompt.
      example: "12345"
      format: uint64
      type: string
    prompt_chunks:
      description: The list of prompt chunks.
      items:
        $ref: '#/apiPromptChunk'
      type: array
    prompt_id:
      description: Prompt ID
      example: 123
      format: int64
      type: integer
    prompt_level_metric_results:
      description: The metric results for the prompt.
      items:
        $ref: '#/apiEvaluationMetricResult'
      type: array
  type: object
apiPromptChunk:
  properties:
    chunk_usage_pct:
      description: The usage percentage of the chunk.
      example: 123
      format: double
      type: number
    chunk_used:
      description: Indicates if the chunk was used in the prompt.
      example: true
      type: boolean
    index_uuid:
      description: The index uuid (Knowledge Base) of the chunk.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    source_name:
      description: The source name for the chunk, e.g., the file name or document
        title.
      example: example name
      type: string
    text:
      description: Text content of the chunk.
      example: example string
      type: string
  type: object
apiRefreshAgentTokenOutput:
  description: Information about a refreshed token
  properties:
    access_token:
      description: The token
      example: example string
      type: string
    refresh_token:
      description: Rhe refreshed token
      example: example string
      type: string
  type: object
apiRefreshModelPlaygroundTokenOutput:
  description: RefreshModelPlaygroundTokenOutput description
  properties:
    access_token:
      example: example string
      type: string
    refresh_token:
      example: example string
      type: string
  type: object
apiRegenerateAgentAPIKeyInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiRegenerateAgentAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiAgentAPIKeyInfo'
  type: object
apiRegenerateModelAPIKeyInputPublic:
  properties:
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiRegenerateModelAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelAPIKeyInfo'
  type: object
apiReleaseStatus:
  default: RELEASE_STATUS_UNKNOWN
  description: |-
    - RELEASE_STATUS_UNKNOWN: the status of the release is unknown or not set
     - RELEASE_STATUS_WAITING_FOR_DEPLOYMENT: the release is queued and waiting to be deployed
     - RELEASE_STATUS_DEPLOYING: the release is currently being deployed
     - RELEASE_STATUS_RUNNING: the release is successfully deployed and running
     - RELEASE_STATUS_FAILED: the release deployment failed
     - RELEASE_STATUS_WAITING_FOR_UNDEPLOYMENT: the release is waiting to be undeployed/removed
     - RELEASE_STATUS_UNDEPLOYING: the release is currently being undeployed
     - RELEASE_STATUS_UNDEPLOYMENT_FAILED: the release undeployment failed
     - RELEASE_STATUS_DELETED: the release has been deleted
     - RELEASE_STATUS_BUILDING: the release is building
  enum:
  - RELEASE_STATUS_UNKNOWN
  - RELEASE_STATUS_WAITING_FOR_DEPLOYMENT
  - RELEASE_STATUS_DEPLOYING
  - RELEASE_STATUS_RUNNING
  - RELEASE_STATUS_FAILED
  - RELEASE_STATUS_WAITING_FOR_UNDEPLOYMENT
  - RELEASE_STATUS_UNDEPLOYING
  - RELEASE_STATUS_UNDEPLOYMENT_FAILED
  - RELEASE_STATUS_DELETED
  - RELEASE_STATUS_BUILDING
  example: RELEASE_STATUS_UNKNOWN
  type: string
apiResourceUsage:
  description: Resource Usage Description
  properties:
    measurements:
      items:
        $ref: '#/apiUsageMeasurement'
      type: array
    resource_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    start:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    stop:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
  type: object
apiRetrievalMethod:
  default: RETRIEVAL_METHOD_UNKNOWN
  description: |-
    - 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
  enum:
  - RETRIEVAL_METHOD_UNKNOWN
  - RETRIEVAL_METHOD_REWRITE
  - RETRIEVAL_METHOD_STEP_BACK
  - RETRIEVAL_METHOD_SUB_QUERIES
  - RETRIEVAL_METHOD_NONE
  example: RETRIEVAL_METHOD_UNKNOWN
  type: string
apiRollbackToAgentVersionInputPublic:
  properties:
    uuid:
      description: Agent unique identifier
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    version_hash:
      description: Unique identifier
      example: c3658d8b5c05494cd03ce042926ef08157889ed54b1b74b5ee0b3d66dcee4b73
      type: string
  type: object
apiRollbackToAgentVersionOutput:
  properties:
    audit_header:
      $ref: '#/apiAuditHeader'
    version_hash:
      description: Unique identifier
      example: example string
      type: string
  type: object
apiRunEvaluationTestCaseInputPublic:
  description: Run an evaluation test case.
  properties:
    agent_uuids:
      description: Agent UUIDs to run the test case against.
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    run_name:
      description: The name of the run.
      example: Evaluation Run Name
      type: string
    test_case_uuid:
      description: Test-case UUID to run
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiRunEvaluationTestCaseOutput:
  properties:
    evaluation_run_uuids:
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
  type: object
apiScheduledIndexingInfo:
  description: Metadata for scheduled indexing entries
  properties:
    created_at:
      description: Created at timestamp
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    days:
      description: Days for execution (day is represented same as in a cron expression,
        e.g. Monday begins with 1 )
      items:
        example: 123
        format: int32
        type: integer
      type: array
    deleted_at:
      description: Deleted at timestamp (if soft deleted)
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    is_active:
      description: Whether the schedule is currently active
      example: true
      type: boolean
    knowledge_base_uuid:
      description: Knowledge base uuid associated with this schedule
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    last_ran_at:
      description: Last time the schedule was executed
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    next_run_at:
      description: Next scheduled run
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    time:
      description: Scheduled time of execution (HH:MM:SS format)
      example: example string
      type: string
    updated_at:
      description: Updated at timestamp
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique identifier for the scheduled indexing entry
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiServerlessInferencePrice:
  properties:
    attributes:
      items:
        $ref: '#/apiBillingAttribute'
      type: array
    display_name:
      example: example name
      type: string
    model_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    prices:
      items:
        $ref: '#/apiBillingPrice'
      type: array
  type: object
apiSpacesDataSource:
  description: Spaces Bucket Data Source
  properties:
    bucket_name:
      description: Spaces bucket name
      example: example name
      type: string
    item_path:
      example: example string
      type: string
    region:
      description: Region of bucket
      example: example string
      type: string
  type: object
apiStarMetric:
  properties:
    metric_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    name:
      example: example name
      type: string
    success_threshold:
      description: |-
        The success threshold for the star metric.
        This is a value that the metric must reach to be considered successful.
      example: 123
      format: float
      type: number
    success_threshold_pct:
      description: |-
        The success threshold for the star metric.
        This is a percentage value between 0 and 100.
      example: 123
      format: int32
      type: integer
  type: object
apiStartKnowledgeBaseIndexingJobInputPublic:
  description: StartKnowledgeBaseIndexingJobInputPublic description
  properties:
    data_source_uuids:
      description: List of data source ids to index, if none are provided, all data
        sources will be indexed
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    knowledge_base_uuid:
      description: Knowledge base id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiStartKnowledgeBaseIndexingJobOutput:
  description: StartKnowledgeBaseIndexingJobOutput description
  properties:
    job:
      $ref: '#/apiIndexingJob'
  type: object
apiTeamAgreement:
  description: Team Agreement Description
  properties:
    accepted_at:
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    agreement_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiTeamModelURLOutput:
  description: Model url output
  properties:
    url:
      description: The signed url that can be used to upload one file
      example: example string
      type: string
  type: object
apiTrace:
  description: Represents a complete trace
  properties:
    created_at:
      description: When the trace was created
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    input:
      description: Input data for the trace
      type: object
    name:
      description: Name/identifier for the trace
      example: example name
      type: string
    output:
      description: Output data from the trace
      type: object
    spans:
      description: List of spans that make up this trace
      items:
        $ref: '#/apiTraceSpan'
      type: array
  type: object
apiTraceSpan:
  description: Represents a span within a trace (e.g., LLM call, function call, etc.)
  properties:
    created_at:
      description: When the span was created
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    input:
      description: Input data for the span (flexible structure - can be messages array,
        string, etc.)
      type: object
    name:
      description: Name/identifier for the span
      example: example name
      type: string
    output:
      description: Output data from the span (flexible structure - can be message,
        string, etc.)
      type: object
    type:
      $ref: '#/apiTraceSpanType'
  type: object
apiTraceSpanType:
  default: TRACE_SPAN_TYPE_UNKNOWN
  description: Types of spans in a trace
  enum:
  - TRACE_SPAN_TYPE_UNKNOWN
  - TRACE_SPAN_TYPE_LLM
  - TRACE_SPAN_TYPE_RETRIEVER
  - TRACE_SPAN_TYPE_TOOL
  example: TRACE_SPAN_TYPE_UNKNOWN
  type: string
apiTracingServiceJWTOutput:
  properties:
    access_token:
      description: Access token for the clickout to the tracing service
      example: example string
      type: string
    base_url:
      description: Base URL for the tracing service instance
      example: example string
      type: string
    expires_at:
      description: Expiry time of the access token
      example: example string
      type: string
  type: object
apiUnlinkAgentFunctionInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    function_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiUnlinkAgentFunctionOutput:
  description: Information about a newly unlinked agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiUnlinkAgentGuardrailOutput:
  description: UnlinkAgentGuardrailOutput description
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiUnlinkAgentInputPublic:
  properties:
    child_agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    parent_agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiUnlinkAgentOutput:
  description: Information about a removed linkage
  properties:
    child_agent_uuid:
      description: Routed agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    parent_agent_uuid:
      description: Pagent agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiUnlinkKnowledgeBaseInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    knowledge_base_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiUnlinkKnowledgeBaseOutput:
  description: Informatinon about a unlinked knowledge base
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiUpdateAgentAPIKeyInputPublic:
  properties:
    agent_uuid:
      description: Agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    api_key_uuid:
      description: API key ID
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Name
      example: '"Production Key"'
      type: string
  type: object
apiUpdateAgentAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiAgentAPIKeyInfo'
  type: object
apiUpdateAgentDeploymentVisbilityOutput:
  description: UpdateAgentDeploymentVisbilityOutput description
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiUpdateAgentDeploymentVisibilityInputPublic:
  description: UpdateAgentDeploymentVisibilityInputPublic description
  properties:
    uuid:
      description: Unique id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    visibility:
      $ref: '#/apiDeploymentVisibility'
  type: object
apiUpdateAgentFunctionInputPublic:
  description: Information about updating an agent function
  properties:
    agent_uuid:
      description: Agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    description:
      description: Funciton description
      example: '"My Function Description"'
      type: string
    faas_name:
      description: The name of the function in the DigitalOcean functions platform
      example: '"my-function"'
      type: string
    faas_namespace:
      description: The namespace of the function in the DigitalOcean functions platform
      example: '"default"'
      type: string
    function_name:
      description: Function name
      example: '"My Function"'
      type: string
    function_uuid:
      description: Function id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    input_schema:
      description: Describe the input schema for the function so the agent may call
        it
      type: object
    output_schema:
      description: Describe the output schema for the function so the agent handle
        its response
      type: object
  type: object
apiUpdateAgentFunctionOutput:
  description: The updated agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiUpdateAgentInput:
  properties:
    agent_log_insights_enabled:
      example: "false"
    conversation_logs_enabled:
      example: "false"
    vpc_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
apiUpdateAgentInputPublic:
  description: Data to modify an existing Agent
  properties:
    agent_log_insights_enabled:
      example: true
      type: boolean
    allowed_domains:
      description: Optional list of allowed domains for the chatbot - Must use fully
        qualified domain name (FQDN) such as https://example.com
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    anthropic_key_uuid:
      description: Optional anthropic key uuid for use with anthropic models
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    conversation_logs_enabled:
      description: Optional update of conversation logs enabled
      example: true
      type: boolean
    description:
      description: Agent description
      example: '"My Agent Description"'
      type: string
    instruction:
      description: Agent instruction. Instructions help your agent to perform its
        job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions)
        for best practices.
      example: '"You are an agent who thinks deeply about the world"'
      type: string
    k:
      description: How many results should be considered from an attached knowledge
        base
      example: 5
      format: int64
      type: integer
    max_tokens:
      description: Specifies the maximum number of tokens the model can process in
        a single input or output, set as a number between 1 and 512. This determines
        the length of each response.
      example: 100
      format: int64
      type: integer
    model_provider_key_uuid:
      description: Optional Model Provider uuid for use with provider models
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    model_uuid:
      description: Identifier for the foundation model.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Agent name
      example: '"My New Agent Name"'
      type: string
    open_ai_key_uuid:
      description: Optional OpenAI key uuid for use with OpenAI models
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    project_id:
      description: The id of the DigitalOcean project this agent will belong to
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    provide_citations:
      example: true
      type: boolean
    retrieval_method:
      $ref: '#/apiRetrievalMethod'
    tags:
      description: A set of abitrary tags to organize your agent
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    temperature:
      description: Controls the model’s creativity, specified as a number between
        0 and 1. Lower values produce more predictable and conservative responses,
        while higher values encourage creativity and variation.
      example: 0.7
      format: float
      type: number
    top_p:
      description: Defines the cumulative probability threshold for word selection,
        specified as a number between 0 and 1. Higher values allow for more diverse
        outputs, while lower values ensure focused and coherent responses.
      example: 0.9
      format: float
      type: number
    uuid:
      description: Unique agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiUpdateAgentOutput:
  description: Information about an updated agent
  properties:
    agent:
      $ref: '#/apiAgent'
  type: object
apiUpdateAgentWorkspaceDeploymentInputPublic:
  properties:
    agent_deployment_name:
      description: The name of the deployment
      example: example name
      type: string
    agent_workspace_name:
      description: Unique agent workspace name
      example: example name
      type: string
    log_insights_enabled:
      example: true
      type: boolean
  type: object
apiUpdateAgentWorkspaceDeploymentOutput:
  description: One Agent Workspace Deployment
  properties:
    agent_workspace_deployment:
      $ref: '#/apiAgentWorkspaceDeployment'
  type: object
apiUpdateAnthropicAPIKeyInputPublic:
  description: UpdateAnthropicAPIKeyInputPublic is used to update an existing Anthropic
    API key for a specific agent.
  properties:
    api_key:
      description: Anthropic API key
      example: '"sk-ant-12345678901234567890123456789012"'
      type: string
    api_key_uuid:
      description: API key ID
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Name of the key
      example: '"Production Key"'
      type: string
  type: object
apiUpdateAnthropicAPIKeyOutput:
  description: UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic
    API key.
  properties:
    api_key_info:
      $ref: '#/apiAnthropicAPIKeyInfo'
  type: object
apiUpdateChatbotInputPublic:
  properties:
    agent_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    allowed_domains:
      example: '["https://example.com"]'
    button_background_color:
      example: '"#0000FF"'
    logo:
      example: '"https://example.com/logo.png"'
    name:
      example: '"My Chatbot"'
    primary_color:
      example: '"#FF0000"'
    secondary_color:
      example: '"#00FF00"'
    starting_message:
      example: '"Hello, how can I help you today?"'
apiUpdateChatbotOutput:
  description: Info about an updated chatbot
  properties:
    chatbot:
      $ref: '#/apiChatbot'
  type: object
apiUpdateEvaluationTestCaseInputPublic:
  properties:
    dataset_uuid:
      description: Dataset against which the test‑case is executed.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    description:
      description: Description of the test case.
      example: example string
      type: string
    metrics:
      $ref: '#/apiEvaluationTestCaseMetricList'
    name:
      description: Name of the test case.
      example: example name
      type: string
    star_metric:
      $ref: '#/apiStarMetric'
    test_case_uuid:
      description: Test-case UUID to update
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiUpdateEvaluationTestCaseOutput:
  properties:
    test_case_uuid:
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    version:
      description: The new verson of the test case.
      example: 123
      format: int32
      type: integer
  type: object
apiUpdateGuardrailOutput:
  description: UpdateGuardrailOutput description
  properties:
    guardrail:
      $ref: '#/apiGuardrail'
  type: object
apiUpdateKnowledgeBaseInputPublic:
  description: Information about updating a knowledge base
  properties:
    database_id:
      description: The id of the DigitalOcean database this knowledge base will use,
        optiona.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    embedding_model_uuid:
      description: Identifier for the foundation model.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Knowledge base name
      example: '"My Knowledge Base"'
      type: string
    project_id:
      description: The id of the DigitalOcean project this knowledge base will belong
        to
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    tags:
      description: Tags to organize your knowledge base.
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
    uuid:
      description: Knowledge base id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiUpdateKnowledgeBaseOutput:
  description: Information about an updated knowledge base
  properties:
    knowledge_base:
      $ref: '#/apiKnowledgeBase'
  type: object
apiUpdateLinkedAgentInputPublic:
  description: Information about updating the linkage of an agent
  properties:
    child_agent_uuid:
      description: Routed agent id
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    if_case:
      description: Describes the case in which the child agent should be used
      example: '"use this to get weather information"'
      type: string
    parent_agent_uuid:
      description: A unique identifier for the parent agent.
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    route_name:
      description: Route name
      example: '"weather_route"'
      type: string
    uuid:
      description: Unique id of linkage
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
  type: object
apiUpdateLinkedAgentOutput:
  description: Information about an updated linkage
  properties:
    child_agent_uuid:
      description: Routed agent id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    parent_agent_uuid:
      description: A unique identifier for the parent agent.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
    rollback:
      example: true
      type: boolean
    uuid:
      description: Unique id of linkage
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiUpdateModelAPIKeyInputPublic:
  properties:
    api_key_uuid:
      description: API key ID
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Name
      example: '"Production Key"'
      type: string
  type: object
apiUpdateModelAPIKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelAPIKeyInfo'
  type: object
apiUpdateModelMetadataOutput:
  description: Information about updated meta data for a model
  properties:
    model:
      $ref: '#/apiModel'
  type: object
apiUpdateModelProviderKeyInputPublic:
  properties:
    api_key:
      example: sk-ant-12345678901234567890123456789012
    api_key_uuid:
      example: '"12345678-1234-1234-1234-123456789012"'
    name:
      example: Production Key
apiUpdateModelProviderKeyOutput:
  properties:
    api_key_info:
      $ref: '#/apiModelProviderKeyInfo'
  type: object
apiUpdateOpenAIAPIKeyInputPublic:
  description: UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI
    API key for a specific agent.
  properties:
    api_key:
      description: OpenAI API key
      example: '"sk-ant-12345678901234567890123456789012"'
      type: string
    api_key_uuid:
      description: API key ID
      example: '"12345678-1234-1234-1234-123456789012"'
      type: string
    name:
      description: Name of the key
      example: '"Production Key"'
      type: string
  type: object
apiUpdateOpenAIAPIKeyOutput:
  description: UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key.
  properties:
    api_key_info:
      $ref: '#/apiOpenAIAPIKeyInfo'
  type: object
apiUpdateScheduledIndexingOutput:
  properties:
    indexing_info:
      $ref: '#/apiScheduledIndexingInfo'
  type: object
apiUpdateWorkspaceInputPublic:
  description: Parameters for Update Workspace
  properties:
    description:
      description: The new description of the workspace
      example: example string
      type: string
    name:
      description: The new name of the workspace
      example: example name
      type: string
    workspace_uuid:
      description: Workspace UUID.
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
apiUpdateWorkspaceOutput:
  properties:
    workspace:
      $ref: '#/apiWorkspace'
  type: object
apiUsageMeasurement:
  description: Usage Measurement Description
  properties:
    tokens:
      example: 123
      format: int64
      type: integer
    usage_type:
      example: example string
      type: string
  type: object
apiUsageType:
  default: USAGE_TYPE_UNSPECIFIED
  enum:
  - USAGE_TYPE_UNSPECIFIED
  - INPUT
  - OUTPUT
  example: USAGE_TYPE_UNSPECIFIED
  type: string
apiWebCrawlerDataSource:
  description: WebCrawlerDataSource
  properties:
    base_url:
      description: The base url to crawl.
      example: example string
      type: string
    crawling_option:
      $ref: '#/apiCrawlingOption'
    embed_media:
      description: Whether to ingest and index media (images, etc.) on web pages.
      example: true
      type: boolean
    exclude_tags:
      description: Declaring which tags to exclude in web pages while webcrawling
      example:
      - example string
      items:
        example: example string
        type: string
      type: array
  type: object
apiWorkspace:
  properties:
    agents:
      description: Agents
      items:
        $ref: '#/apiAgent'
      type: array
    created_at:
      description: Creation date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    created_by:
      description: The id of user who created this workspace
      example: "12345"
      format: uint64
      type: string
    created_by_email:
      description: The email of the user who created this workspace
      example: example@example.com
      type: string
    deleted_at:
      description: Deleted date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    description:
      description: Description of the workspace
      example: example string
      type: string
    evaluation_test_cases:
      description: Evaluations
      items:
        $ref: '#/apiEvaluationTestCase'
      type: array
    name:
      description: Name of the workspace
      example: example name
      type: string
    updated_at:
      description: Update date
      example: "2023-01-01T00:00:00Z"
      format: date-time
      type: string
    uuid:
      description: Unique id
      example: 123e4567-e89b-12d3-a456-426614174000
      type: string
  type: object
dbaasClusterStatus:
  default: CREATING
  enum:
  - CREATING
  - ONLINE
  - POWEROFF
  - REBUILDING
  - REBALANCING
  - DECOMMISSIONED
  - FORKING
  - MIGRATING
  - RESIZING
  - RESTORING
  - POWERING_ON
  - UNHEALTHY
  example: CREATING
  type: string
genaiapiRegion:
  description: Description for a specific Region
  properties:
    inference_url:
      description: Url for inference server
      example: example string
      type: string
    region:
      description: Region code
      example: example string
      type: string
    serves_batch:
      description: This datacenter is capable of running batch jobs
      example: true
      type: boolean
    serves_inference:
      description: This datacenter is capable of serving inference
      example: true
      type: boolean
    stream_inference_url:
      description: The url for the inference streaming server
      example: example string
      type: string
  type: object
protobufNullValue:
  default: NULL_VALUE
  description: |-
    `NullValue` is a singleton enumeration to represent the null value for the
    `Value` type union.

     The JSON representation for `NullValue` is JSON `null`.

     - NULL_VALUE: Null value.
  enum:
  - NULL_VALUE
  example: NULL_VALUE
  type: string