Helicone · Schema

LLMRequestBody

AI GatewaysAI MonitoringGatewaysLLM ObservabilityLLM RoutingPrompt Management

Properties

Name Type Description
llm_type object
provider string
model string
messages array
prompt string
instructions string
max_tokens number
temperature number
top_p number
seed number
stream boolean
presence_penalty number
frequency_penalty number
stop object
reasoning_effort string
verbosity string
tools array
parallel_tool_calls boolean
tool_choice object
response_format object
toolDetails object
vectorDBDetails object
dataDetails object
input object
n number
size string
quality string
View JSON Schema on GitHub

JSON Schema

helicone-llmrequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LLMRequestBody",
  "title": "LLMRequestBody",
  "properties": {
    "llm_type": {
      "$ref": "#/components/schemas/LlmType"
    },
    "provider": {
      "type": "string"
    },
    "model": {
      "type": "string"
    },
    "messages": {
      "items": {
        "$ref": "#/components/schemas/Message"
      },
      "type": "array",
      "nullable": true
    },
    "prompt": {
      "type": "string",
      "nullable": true
    },
    "instructions": {
      "type": "string",
      "nullable": true
    },
    "max_tokens": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "temperature": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "top_p": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "seed": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "stream": {
      "type": "boolean",
      "nullable": true
    },
    "presence_penalty": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "frequency_penalty": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "stop": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ],
      "nullable": true
    },
    "reasoning_effort": {
      "type": "string",
      "enum": [
        "minimal",
        "low",
        "medium",
        "high",
        null
      ],
      "nullable": true
    },
    "verbosity": {
      "type": "string",
      "enum": [
        "low",
        "medium",
        "high",
        null
      ],
      "nullable": true
    },
    "tools": {
      "items": {
        "$ref": "#/components/schemas/Tool"
      },
      "type": "array"
    },
    "parallel_tool_calls": {
      "type": "boolean",
      "nullable": true
    },
    "tool_choice": {
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string",
          "enum": [
            "none",
            "auto",
            "any",
            "tool"
          ]
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "response_format": {
      "properties": {
        "json_schema": {},
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    },
    "toolDetails": {
      "$ref": "#/components/schemas/HeliconeEventTool"
    },
    "vectorDBDetails": {
      "$ref": "#/components/schemas/HeliconeEventVectorDB"
    },
    "dataDetails": {
      "$ref": "#/components/schemas/HeliconeEventData"
    },
    "input": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      ]
    },
    "n": {
      "type": "number",
      "format": "double",
      "nullable": true
    },
    "size": {
      "type": "string"
    },
    "quality": {
      "type": "string"
    }
  },
  "type": "object",
  "additionalProperties": false
}