> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enkryptai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Defaults



## OpenAPI

````yaml GET /models/get-defaults
openapi: 3.0.0
info:
  title: Enkrypt AI APIs
  version: 2.0.0
servers:
  - url: https://api.enkryptai.com
security:
  - apiKeyAuth: []
tags:
  - name: Guardrails
  - name: Code of Conduct
  - name: Endpoints
  - name: Datasets
  - name: Redteam
  - name: Deployments
  - name: AI Proxy
  - name: Leaderboard
  - name: Archived
  - name: MCP Hub
    description: >-
      MCP Hub vulnerability scanning APIs. Submitting scans (the POST endpoints)
      is open to all authenticated callers. The scan **retrieval** APIs — Get
      Scan Job Status, Get Complete Scan Results, List Scans, and Get MCP Hub
      Scan Statistics (the GET endpoints) — are an **enterprise data-license
      feature**: they require your organization to have MCP Hub API access
      enabled by Enkrypt, otherwise they return `403`. Contact us at
      support@enkryptai.com to enable access.
  - name: MCP Registry Servers
  - name: MCP Gateways
  - name: MCP Playground
paths:
  /models/get-defaults:
    get:
      tags:
        - Endpoints
      summary: Get Defaults
      operationId: get_defaults
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetModelDefaultsResponseObject'
components:
  schemas:
    GetModelDefaultsResponseObject:
      title: GetModelDefaultsResponseObject
      type: object
      required:
        - available_providers
      properties:
        available_providers:
          title: Available Providers
          type: array
          items:
            title: Provider
            type: string
            enum:
              - openai
              - together
              - huggingface
              - groq
              - azure_openai
              - anthropic
              - cohere
              - bedrock
              - gemini
              - ai21
              - fireworks
              - alibaba
              - portkey
              - deepseek
              - mistral
              - llama
              - openai_compatible
              - cohere_compatible
              - anthropic_compatible
              - custom
              - url
              - enkryptai
              - sierra
              - boxai
              - nutanix
              - xactly
        openai:
          $ref: '#/components/schemas/ModelRequestObject'
        together:
          $ref: '#/components/schemas/ModelRequestObject'
        huggingface:
          $ref: '#/components/schemas/ModelRequestObject'
        groq:
          $ref: '#/components/schemas/ModelRequestObject'
        azure_openai:
          $ref: '#/components/schemas/ModelRequestObject'
        anthropic:
          $ref: '#/components/schemas/ModelRequestObject'
        cohere:
          $ref: '#/components/schemas/ModelRequestObject'
        bedrock:
          $ref: '#/components/schemas/ModelRequestObject'
        gemini:
          $ref: '#/components/schemas/ModelRequestObject'
        ai21:
          $ref: '#/components/schemas/ModelRequestObject'
        fireworks:
          $ref: '#/components/schemas/ModelRequestObject'
        alibaba:
          $ref: '#/components/schemas/ModelRequestObject'
        portkey:
          $ref: '#/components/schemas/ModelRequestObject'
        deepseek:
          $ref: '#/components/schemas/ModelRequestObject'
        mistral:
          $ref: '#/components/schemas/ModelRequestObject'
        llama:
          $ref: '#/components/schemas/ModelRequestObject'
        openai_compatible:
          $ref: '#/components/schemas/ModelRequestObject'
        cohere_compatible:
          $ref: '#/components/schemas/ModelRequestObject'
        anthropic_compatible:
          $ref: '#/components/schemas/ModelRequestObject'
        custom:
          $ref: '#/components/schemas/ModelRequestObject'
        url:
          $ref: '#/components/schemas/ModelRequestObject'
        enkryptai:
          $ref: '#/components/schemas/ModelRequestObject'
        sierra:
          $ref: '#/components/schemas/ModelRequestObject'
        boxai:
          $ref: '#/components/schemas/ModelRequestObject'
        nutanix:
          $ref: '#/components/schemas/ModelRequestObject'
        xactly:
          $ref: '#/components/schemas/ModelRequestObject'
      example:
        available_providers:
          - openai
          - together
          - huggingface
          - groq
          - azure_openai
          - anthropic
          - cohere
          - bedrock
          - gemini
          - ai21
          - fireworks
          - alibaba
          - portkey
          - deepseek
          - mistral
          - llama
          - openai_compatible
          - cohere_compatible
          - anthropic_compatible
          - custom
          - url
          - enkryptai
          - sierra
          - nutanix
          - xactly
        openai:
          testing_for: foundationModels
          model_name: gpt-4o
          model_version: v1
          certifications:
            - GDPR
            - CCPA
            - SOC 2 Type 2
            - SOC 3
            - CSA STAR Level 1
          model_config:
            model_provider: openai
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://openai.com
            endpoint:
              scheme: https
              host: api.openai.com
              port: 443
              base_path: /v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        together:
          testing_for: foundationModels
          model_name: meta-llama/Llama-3.3-70B-Instruct-Turbo
          model_version: v1
          certifications:
            - GDPR
            - SOC 2
          model_config:
            model_provider: together
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://www.together.ai
            endpoint:
              scheme: https
              host: api.together.xyz
              port: 443
              base_path: /v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 0.88
              output_cost_1M_tokens: 0.88
            default_request_options:
              temperature: 0.7
              top_p: 0.7
              top_k: 50
        huggingface:
          testing_for: foundationModels
          model_name: meta-llama/Llama-3.2-11B-Vision-Instruct
          model_version: v1
          certifications:
            - GDPR
            - SOC 2
          model_config:
            model_provider: huggingface
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://huggingface.co
            endpoint:
              scheme: https
              host: api-inference.huggingface.co
              port: 443
              base_path: /models/{model_name}/v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: null
              output_cost_1M_tokens: null
              huggingface:
                use_cache: false
                wait_for_model: false
            default_request_options:
              temperature: 0.7
              top_p: null
              top_k: null
        groq:
          testing_for: foundationModels
          model_name: llama3-8b-8192
          model_version: v1
          certifications:
            - GDPR
            - SOC 2
          model_config:
            model_provider: groq
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://groq.com
            endpoint:
              scheme: https
              host: api.groq.com
              port: 443
              base_path: /openai/v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 0.05
              output_cost_1M_tokens: 0.08
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        azure_openai:
          testing_for: foundationModels
          model_name: gpt-4o
          model_version: v1
          certifications:
            - GDPR
          model_config:
            model_provider: azure_openai
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://microsoft.com
            endpoint:
              scheme: https
              host: '{azure_instance}.openai.azure.com'
              port: 443
              base_path: /openai/deployments/{azure_deployment_id}
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
              azure_instance: instance_name
              azure_api_version: '2024-10-21'
              azure_deployment_id: gpt-4o
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        anthropic:
          testing_for: foundationModels
          model_name: claude-3-5-sonnet-latest
          model_version: v1
          certifications:
            - GDPR
            - SOC 2 Type 1
            - SOC 2 Type 2
            - HIPAA
          model_config:
            model_provider: anthropic
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://anthropic.com
            endpoint:
              scheme: https
              host: api.anthropic.com
              port: 443
              base_path: /v1
            paths:
              completions: /complete
              chat: /chat/messages
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 3.75
              output_cost_1M_tokens: 15
              anthropic_version: '2023-06-01'
            default_request_options:
              temperature: 1
              top_p: null
              top_k: null
        cohere:
          testing_for: foundationModels
          model_name: command
          model_version: v1
          certifications:
            - GDPR
            - CCPA
            - SOC 2 Type 2
          model_config:
            model_provider: cohere
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://cohere.com
            endpoint:
              scheme: https
              host: api.cohere.com
              port: 443
              base_path: /v1
            paths:
              completions: /generate
              chat: /chat
            auth_data:
              header_name: Authorization
              header_prefix: bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: 0.3
              top_p: 0.75
              top_k: 0
        bedrock:
          testing_for: foundationModels
          model_name: amazon.titan-text-express-v1
          model_version: v1
          certifications:
            - GDPR
            - CCPA
            - PCI DSS
            - ISO
            - CSA
            - FedRAMP
            - HIPAA
            - SOC 1 Type 2
            - SOC 3 Type 2
            - SOC 3 Type 2
          model_config:
            model_provider: bedrock
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://aws.amazon.com/bedrock
            endpoint:
              scheme: https
              host: bedrock-runtime.{aws_region}.amazonaws.com
              port: 443
              base_path: ''
            paths:
              completions: /model/{model_name}/invoke
              chat: /model/{model_name}/converse
            auth_data:
              aws_access_key_id: aws_access_key_id_xxxxxx
              aws_secret_access_key: aws_secret_access_key_xxxxxx
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 0.2
              output_cost_1M_tokens: 0.6
              bedrock:
                aws_region: us-east-1
            default_request_options:
              temperature: 0.7
              top_p: 0.9
              top_k: null
        gemini:
          testing_for: foundationModels
          model_name: gemini-1.5-flash-latest
          model_version: v1
          certifications:
            - GDPR
            - CCPA
            - PCI DSS
            - HIPAA
            - SOC 1 Type 2
            - SOC 3 Type 2
            - SOC 3 Type 2
            - ISO/IEC 27001
            - ISO/IEC 27017
            - ISO/IEC 27018
            - ISO/IEC 27701
          model_config:
            model_provider: gemini
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://ai.google.dev
            endpoint:
              scheme: https
              host: generativelanguage.googleapis.com
              port: 443
              base_path: /v1beta/models/{model_name}/llm/v1
            paths:
              completions: /completions
              chat: /chat
            auth_data:
              param_name: key
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: null
              top_p: 0.95
              top_k: null
        ai21:
          testing_for: foundationModels
          model_name: jamba-mini
          model_version: v1
          certifications:
            - GDPR
            - CCPA
            - PCI DSS
            - HIPAA
            - SOC 2 Type 2
            - ISO/IEC 27001
            - ISO/IEC 27017
            - ISO/IEC 27018
            - ISO 42001
          model_config:
            model_provider: ai21
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://www.ai21.com/jamba/
            endpoint:
              scheme: https
              host: api.ai21.com
              port: 443
              base_path: /studio/v1
            paths:
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: 0.4
              top_p: 1
              top_k: null
        fireworks:
          testing_for: foundationModels
          model_name: accounts/fireworks/models/llama-v3p1-8b-instruct
          model_version: v1
          certifications:
            - HIPAA
            - SOC 2 Type 2
          model_config:
            model_provider: fireworks
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://fireworks.ai/
            endpoint:
              scheme: https
              host: api.fireworks.ai
              port: 443
              base_path: /inference/v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        alibaba:
          testing_for: foundationModels
          model_name: qwen-plus
          model_version: v1
          certifications: []
          model_config:
            model_provider: alibaba
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://www.alibabacloud.com/help/en/model-studio
            endpoint:
              scheme: https
              host: dashscope-intl.aliyuncs.com
              port: 443
              base_path: /compatible-mode/v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: null
              top_p: null
              top_k: null
        portkey:
          testing_for: foundationModels
          model_name: gpt-4o
          model_version: v1
          certifications:
            - GDPR
            - HIPAA
            - SOC 2 Type 2
            - ISO 27001:2022
          model_config:
            model_provider: portkey
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://portkey.ai/
            endpoint:
              scheme: https
              host: api.portkey.ai
              port: 443
              base_path: /v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        deepseek:
          testing_for: foundationModels
          model_name: deepseek-chat
          model_version: v1
          certifications: []
          model_config:
            model_provider: deepseek
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://www.deepseek.com/
            endpoint:
              scheme: https
              host: api.deepseek.com
              port: 443
              base_path: ''
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2.5
              output_cost_1M_tokens: 10
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        mistral:
          testing_for: foundationModels
          model_name: mistral-large-latest
          model_version: v1
          certifications: []
          model_config:
            model_provider: mistral
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://mistral.ai
            endpoint:
              scheme: https
              host: api.mistral.ai
              port: 443
              base_path: /v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: 2
              output_cost_1M_tokens: 6
              mistral_format: openai
            default_request_options:
              temperature: null
              top_p: 1
              top_k: null
        llama:
          testing_for: foundationModels
          model_name: meta-llama/Llama-2-7b-chat-hf
          model_version: v1
          certifications: []
          model_config:
            model_provider: llama
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://llama.com
            endpoint:
              scheme: https
              host: api-inference.huggingface.co
              port: 443
              base_path: /models/{model_name}/v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: null
              output_cost_1M_tokens: null
              llama2_format: openai
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        enkryptai:
          model_config:
            model_provider: enkryptai
            apikeys:
              - YOUR_ENKRYPTAI_API_KEY
            metadata:
              enkryptai:
                deployment_name: test-deployment-1
        sierra:
          testing_for: chatbotsAndCopilots
          model_config:
            model_provider: sierra
            apikeys:
              - YOUR_SIERRA_TOKEN
            endpoint:
              scheme: https
              host: api.sierra.chat
              port: 443
              base_path: /chat
            metadata:
              sierra:
                release: abcdefghijklmnopqrstuvwxyz
        custom:
          testing_for: agents
          certifications: []
          model_config:
            model_provider: custom
            hosting_type: External
            model_source: https://huggingface.co
            endpoint:
              scheme: https
              host: api-inference.huggingface.co
              port: 443
              base_path: /agents/v1
            paths:
              completions: /completions
              chat: /chat/completions
            auth_data:
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            input_modalities:
              - text
              - image
              - audio
            output_modalities:
              - text
            tools:
              - name: web_search
                description: >-
                  The tool web search is used to search the web for information
                  related to finance.
            custom_headers:
              - key: test
                value: test
            custom_payload:
              messages:
                - role: developer
                  content: You are a helpful assistant.
                - role: user
                  content: '{prompt}'
            custom_response_content_type: json
            custom_response_format: .choices[0].message.content
            metadata:
              max_tokens: 500
              input_cost_1M_tokens: null
              output_cost_1M_tokens: null
              llama2_format: openai
            default_request_options:
              temperature: 1
              top_p: 1
              top_k: null
        nutanix:
          testing_for: foundationModels
          model_name: nutanix-model
          model_version: v1
          certifications: []
          model_config:
            model_provider: nutanix
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://nutanix.com
            model_auth_type: apikey
            apikeys:
              - YOUR_NUTANIX_TOKEN
            endpoint:
              scheme: https
              host: api.nutanix.com
              port: 443
              base_path: ''
            paths:
              completions: /v1/chat/completions
              chat: /v1/chat/completions
            auth_data:
              nutanix_user_session_id: '1234567890'
              nutanix_email_id: testuser@example.com
              header_name: Authorization
              header_prefix: Bearer
              space_after_prefix: true
            metadata: {}
        xactly:
          testing_for: foundationModels
          model_name: xactly-model
          model_version: v1
          certifications: []
          model_config:
            model_provider: xactly
            hosting_type: External
            input_modalities:
              - text
            output_modalities:
              - text
            model_source: https://xactly.com
            endpoint:
              scheme: https
              host: api.xactly.com
              port: 443
              base_path: ''
            paths:
              completions: /v1/chat/completions
              chat: /v1/chat/completions
            auth_data:
              xactly_username: testuser
              xactly_password: testpassword
            metadata:
              xactly:
                assistant_id: '1234567890'
    ModelRequestObject:
      title: ModelRequestObject
      type: object
      required:
        - model_saved_name
        - model_version
      allOf:
        - $ref: '#/components/schemas/ModelCustomRequestObject'
      properties:
        model_saved_name:
          title: Model Saved Name
          type: string
          description: Name of the saved model
          example: Test Model
        model_version:
          title: Model Version
          type: string
          description: Custom identifier for the model
          example: v1
      example:
        model_saved_name: Test Model
        model_version: v1
        testing_for: foundationModels
        model_name: mistralai/Mixtral-8x7B-Instruct-v0.1
        certifications: []
        model_config:
          model_provider: together
          hosting_type: External
          input_modalities:
            - text
          output_modalities:
            - text
          model_source: https://together.ai
          rate_per_min: 20
          system_prompt: ''
          endpoint:
            scheme: https
            host: api.together.xyz
            port: 443
            base_path: /v1
          paths:
            completions: /completions
            chat: /chat/completions
          auth_data:
            header_name: Authorization
            header_prefix: Bearer
            space_after_prefix: true
          apikeys:
            - xxxxx
          metadata: {}
          default_request_options: {}
    ModelCustomRequestObject:
      title: ModelCustomRequestObject
      type: object
      required:
        - model_config
      properties:
        testing_for:
          title: Testing For
          type: string
          description: Purpose of testing
          enum:
            - foundationModels
            - chatbotsAndCopilots
            - agents
            - URL
          example: foundationModels
        model_name:
          title: Model Name
          type: string
          description: Name of the model. Required for foundationModels
          example: mistralai/Mixtral-8x7B-Instruct-v0.1
        certifications:
          title: Certifications
          type: array
          items:
            title: Certification
            type: string
          description: List of certifications
          example:
            - GDPR
            - CCPA
            - HIPAA
            - SOC 2 Type II
            - SOC 3
        model_config:
          title: Model Config
          type: object
          required:
            - model_provider
          properties:
            model_provider:
              title: Model Provider
              type: string
              description: >-
                Provider of the model which determines the request response
                format
              enum:
                - openai
                - together
                - huggingface
                - groq
                - azure_openai
                - anthropic
                - cohere
                - bedrock
                - gemini
                - ai21
                - fireworks
                - alibaba
                - portkey
                - deepseek
                - mistral
                - llama
                - openai_compatible
                - cohere_compatible
                - anthropic_compatible
                - custom
                - url
                - enkryptai
                - sierra
                - boxai
                - nutanix
                - xactly
              example: together
            hosting_type:
              title: Hosting Type
              type: string
              description: Hosting type of the model
              enum:
                - External
                - Internal
              example: External
            model_source:
              title: Model Source
              type: string
              description: Source of the model
              example: https://together.ai
            tools:
              title: Tools
              type: array
              items:
                title: Tool
                type: object
                required:
                  - name
                  - description
                properties:
                  name:
                    title: Tool Name
                    type: string
                    description: Name of the tool
                    example: web_search
                  description:
                    title: Tool Description
                    type: string
                    description: Description of what the tool does
                    example: >-
                      The tool web search is used to search the web for
                      information related to finance.
              description: Array of tools available to the model
              example:
                - name: web_search
                  description: >-
                    The tool web search is used to search the web for
                    information related to finance.
            input_modalities:
              title: Input Modalities
              type: array
              description: Types of input that the model can process
              items:
                type: string
                enum:
                  - text
                  - image
                  - audio
              example:
                - text
            output_modalities:
              title: Output Modalities
              type: array
              description: Types of output that the model can generate
              items:
                type: string
                enum:
                  - text
              example:
                - text
            rate_per_min:
              type: number
              title: Rate Per Min that the model supports.
              description: >-
                < 100 won't enable async. > 100 will enable async mode. > 200 we
                can run boosted async (all tests in parallel). Default 20.
              example: 20
            system_prompt:
              title: System Prompt
              type: string
              description: System prompt
              example: ''
            endpoint:
              title: Endpoint
              type: object
              required:
                - scheme
                - host
                - port
                - base_path
              properties:
                scheme:
                  title: Scheme
                  type: string
                  description: Scheme of the endpoint
                  example: https
                host:
                  title: Host
                  type: string
                  description: Host of the endpoint
                  example: api.together.xyz
                port:
                  title: Port
                  type: integer
                  description: Port of the endpoint
                  example: 443
                base_path:
                  title: Base Path
                  type: string
                  description: Base path of the endpoint
                  example: /v1
            paths:
              title: Paths
              type: object
              properties:
                completions:
                  title: Completions
                  type: string
                  example: /completions
                chat:
                  title: Chat
                  type: string
                  example: /chat/completions
            auth_data:
              title: Auth Data
              type: object
              properties:
                header_name:
                  title: Header Name
                  type: string
                  example: Authorization
                header_prefix:
                  title: Header Prefix
                  type: string
                  example: Bearer
                space_after_prefix:
                  title: Space After Prefix
                  type: boolean
                  example: true
                param_name:
                  title: Param Name
                  type: string
                  example: token
                azure_client_id:
                  title: Azure Client ID
                  type: string
                  example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                azure_client_secret:
                  title: Azure Client Secret
                  type: string
                  example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                azure_tenant_id:
                  title: Azure Tenant ID
                  type: string
                  example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
                gcp_service_account_json:
                  title: GCP Service Account JSON
                  type: string
                  example: >-
                    {"type":"service_account","project_id":"xxxxxxxx","private_key_id":"xxxxxxxx","private_key":"xxxxxxxx","client_email":"xxxxxxxx","client_id":"xxxxxxxx","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/xxxxxxxx@xxxxxxxx.iam.gserviceaccount.com"}
                aws_access_key_id:
                  title: AWS Access Key ID
                  type: string
                  example: xxxxxxxx
                aws_secret_access_key:
                  title: AWS Secret Access Key
                  type: string
                  example: xxxxxxxx
                allow_override:
                  title: Allow Override
                  type: boolean
                  description: >-
                    If enabled, the authorization header or parameter can be
                    overridden in the request by the value configured here
                  example: false
                boxai_client_id:
                  title: BoxAI Client ID
                  type: string
                  example: BOX_CLIENT_ID
                  description: BoxAI client ID for authentication
                boxai_client_secret:
                  title: BoxAI Client Secret
                  type: string
                  example: BOX_CLIENT_SECRET
                  description: BoxAI client secret for authentication
                boxai_user_id:
                  title: BoxAI User ID
                  type: string
                  example: BOX_USER_ID
                  description: BoxAI user ID for authentication
                boxai_default_file_id:
                  title: BoxAI Default File ID
                  type: string
                  example: BOX_FILE_ID
                  description: BoxAI default file ID for operations
                nutanix_user_session_id:
                  title: Nutanix User Session ID
                  type: string
                  example: NUTANIX_USER_SESSION_ID
                  description: Nutanix user session ID for authentication
                nutanix_email_id:
                  title: Nutanix Email ID
                  type: string
                  example: NUTANIX_EMAIL_ID
                  description: Nutanix email ID for authentication
                xactly_username:
                  title: Xactly Username
                  type: string
                  example: XACTLY_USERNAME
                  description: Xactly username for authentication
                xactly_password:
                  title: Xactly Password
                  type: string
                  example: XACTLY_PASSWORD
                  description: Xactly password for authentication
            apikeys:
              title: API Keys
              type: array
              items:
                title: API Key
                type: string
              example:
                - TOGETHER_AI_API_KEY
            model_auth_type:
              title: Model Auth Type (apikey or jwt)
              type: string
              enum:
                - apikey
                - jwt
              example: apikey
            model_jwt_config:
              title: Model Custom Auth Token Config
              type: object
              properties:
                jwt_method:
                  title: Token Method
                  type: string
                  enum:
                    - POST
                    - GET
                  example: POST
                jwt_url:
                  title: Token URL
                  type: string
                  example: https://example.com/api/auth
                jwt_headers:
                  type: array
                  title: Custom Token Headers
                  description: Array of custom headers to be sent with token requests
                  items:
                    type: object
                    required:
                      - key
                      - value
                    properties:
                      key:
                        type: string
                        title: Header Key
                        description: The name/key of the custom header
                        example: x-custom-header
                      value:
                        type: string
                        title: Header Value
                        description: The value of the custom header
                        example: custom-value
                  example:
                    - key: content-type
                      value: application/x-www-form-urlencoded
                    - key: x-custom-header
                      value: custom-value
                jwt_body:
                  type: string
                  title: Token Body
                  description: The body of the token request
                  example: >-
                    grant_type=client_credentials&client_id=xxxxxxxxxx&client_secret=xxxxxxxxxx
                jwt_response_key:
                  type: string
                  title: JWT Response Key
                  description: The key of the token in the response in jq format
                  example: .access_token
            custom_curl_command:
              title: Custom Curl Command
              type: string
              example: |-
                curl --location 'https://example.com/api/chat' \
                --header 'Accept: application/json, text/plain, */*' \
                --header 'Accept-Language: en-US,en;q=0.9' \
                --header 'Authorization: {token}' \
                --header 'Connection: keep-alive' \
                --header 'Content-Type: application/json' \
                --data '{"prompt":"{prompt}"}'
            custom_headers:
              type: array
              title: Custom Headers
              description: Array of custom headers to be sent with requests
              items:
                type: object
                required:
                  - key
                  - value
                properties:
                  key:
                    type: string
                    title: Header Key
                    description: The name/key of the custom header
                    example: X-Custom-Header
                  value:
                    type: string
                    title: Header Value
                    description: The value of the custom header
                    example: custom-value
              example:
                - key: X-Custom-Header
                  value: custom-value
            custom_payload:
              type: object
              title: Custom Payload
              description: >-
                A flexible object that can contain any custom key-value pairs
                for the request payload. Only condition is to include {prompt}
                in the payload.
              additionalProperties: true
              example:
                messages:
                  - role: developer
                    content: You are a helpful assistant.
                  - role: user
                    content: '{prompt}'
            custom_response_content_type:
              type: string
              title: Custom Response Content Type
              description: >-
                Content type of the custom response. Currently only supports
                JSON.
              enum:
                - json
              example: json
            custom_response_format:
              type: string
              title: Custom Response Format
              description: >-
                Optional response format path. Jq format for json type (e.g.
                '.choices[0].message.content')
              example: .choices[0].message.content
            metadata:
              title: Metadata
              type: object
              properties:
                max_tokens:
                  title: Max Tokens
                  type: integer
                  example: 2048
                input_cost_1M_tokens:
                  title: Input Cost 1M Tokens
                  type: number
                  example: 2.5
                output_cost_1M_tokens:
                  title: Output Cost 1M Tokens
                  type: number
                  example: 10
                azure_instance:
                  title: Azure Instance
                  type: string
                  description: If Azure, it's instance type
                  example: enkrypt2024
                azure_api_version:
                  title: Azure API Version
                  type: string
                  description: If Azure, it's API version
                  example: '2024-02-01'
                azure_deployment_id:
                  title: Azure Deployment ID
                  type: string
                  description: If Azure, it's deployment ID
                  example: gpt3
                anthropic_version:
                  title: Anthropic Version
                  type: string
                  description: If Anthropic, it's version
                  example: ''
                llama2_format:
                  title: Llama2 Format
                  type: string
                  description: If Llama2, it's format
                  enum:
                    - openai
                  example: openai
                mistral_format:
                  title: Mistral Format
                  type: string
                  description: If Mistral, it's format
                  enum:
                    - openai
                    - ollama
                  example: openai
                gemini:
                  title: Gemini
                  type: object
                  properties:
                    api_endpoint:
                      title: API Endpoint
                      type: string
                      description: >-
                        If running Gemini on Vertex, specify the regional API
                        endpoint (hostname only)
                      example: ''
                    project_id:
                      title: Project ID
                      type: string
                      description: If running Gemini on Vertex, specify the project ID
                      example: ''
                    location_id:
                      title: Location ID
                      type: string
                      description: If running Gemini on Vertex, specify the location ID
                      example: ''
                bedrock:
                  title: Bedrock
                  type: object
                  properties:
                    aws_region:
                      title: AWS Region
                      type: string
                      description: >-
                        If using AWS providers (Bedrock) you can override the
                        default AWS_REGION 'us-east-1' by setting this option
                      example: ''
                enkryptai:
                  title: EnkryptAI
                  type: object
                  properties:
                    deployment_name:
                      title: Deployment Name
                      type: string
                      description: If using EnkryptAI, specify the deployment name
                      example: test-deployment-1
                xactly:
                  title: Xactly
                  type: object
                  properties:
                    assistant_id:
                      title: Assistant ID
                      type: string
                      example: XACTLY_ASSISTANT_ID
                      description: Xactly assistant ID for authentication
            default_request_options:
              title: Default Request Options
              type: object
              properties:
                temperature:
                  title: Temperature
                  type: number
                  example: 1
                top_p:
                  title: Top P
                  type: number
                  example: 1
                top_k:
                  title: Top K
                  type: integer
                  example: 0
      example:
        testing_for: foundationModels
        model_name: mistralai/Mixtral-8x7B-Instruct-v0.1
        certifications: []
        model_config:
          model_provider: together
          hosting_type: External
          input_modalities:
            - text
          output_modalities:
            - text
          model_source: https://together.ai
          rate_per_min: 20
          system_prompt: ''
          endpoint:
            scheme: https
            host: api.together.xyz
            port: 443
            base_path: /v1
          paths:
            completions: /completions
            chat: /chat/completions
          auth_data:
            header_name: Authorization
            header_prefix: Bearer
            space_after_prefix: true
          apikeys:
            - xxxxx
          metadata: {}
          default_request_options: {}
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: apikey

````