Claude Llm Responses Live

{
  "$defs": {
    "AiOptimizationClaudeLlmResponsesLiveRequestInfo": {
      "properties": {
        "force_web_search": {
          "anyOf": [
            {
              "description": "force AI agent to use web searchoptional fieldto enable this parameter, web_search must also be enabled;when enabled, the AI model is forced to access and cite current web information;default value: false;Note: even if the parameter is set to true, there is no guarantee web sources will be cited in the response",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "max_output_tokens": {
          "anyOf": [
            {
              "description": "maximum number of tokens in the AI responseoptional fieldminimum value: 1;maximum value: 4096;default value: 2048;Note: if web_search is set to true or the reasoning model is specified in the request, the output token count may exceed the specified max_output_tokens limitNote #2: if use_reasoning is set to true, the minimum value for max_output_tokens is 1025",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "message_chain": {
          "anyOf": [
            {
              "description": "conversation history optional field array of message objects representing previous conversation turns; each object must contain: role string with either user or ai role; message string with message content (max 500 characters); you can specify maximum of 10 message objects in the array; Note: for Perplexity models, messages must strictly alternate between user and AI roles (user → ai); example: \"message_chain\": [{\"role\":\"user\",\"message\":\"Hello, what’s up?\"},{\"role\":\"ai\",\"message\":\"Hello! I’m doi",
              "items": {
                "anyOf": [
                  {
                    "oneOf": [
                      {
                        "$ref": "#/$defs/LlmMessageChainItem"
                      }
                    ],
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "model_name": {
          "description": "name of the AI modelrequired fieldmodel_nameconsists of the actual model name and version name;if the basic model name is specified, its latest version will be set by default;for example, if claude-opus-4-0 is specified, the claude-opus-4-20250514 will be set as model_name automatically;you can receive the list of available LLM models by making a separate request to the",
          "type": "string"
        },
        "system_message": {
          "anyOf": [
            {
              "description": "instructions for the AI behaviouroptional fielddefines the AI's role, tone, or specific behavior;you can specify up to 500 characters in the system_message field",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "tag": {
          "anyOf": [
            {
              "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "temperature": {
          "anyOf": [
            {
              "description": "randomness of the AI responseoptional fieldhigher values make output more diverse; lower values make output more focused;minimum value: 0maximum value: 1default value: 0.7Note: temperature cannot be used together with top_p in the same request",
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "top_p": {
          "anyOf": [
            {
              "description": "diversity of the AI responseoptional field controls diversity of the response by limiting token selection;minimum value: 0maximum value: 1 default value: nullNote: top_p cannot be used together with temperature in the same request",
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "use_reasoning": {
          "anyOf": [
            {
              "description": "enable reasoning for the AI modeloptional fieldwhen enabled, the model will perform reasoning before generating a responserefer to the Models endpoint for a list of models that support reasoningdefault value: falseNote: if set to true, the minimum value for max_output_tokens is 1025Note #2: if set to true, force_web_search must be set to falseNote #3: if set to true, the temperature and top_p cannot be used",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "user_prompt": {
          "description": "prompt for the AI modelrequired fieldthe question or task you want to send to the AI model;you can specify up to 500 characters in the user_prompt field",
          "type": "string"
        },
        "web_search": {
          "anyOf": [
            {
              "description": "enable web search for current informationoptional fieldwhen enabled, the AI model can access and cite current web information;Note: refer to the Models endpoint for a list of models that support web_search; default value: false;The cost of the parameter can be calculated on the Pricing page",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "web_search_city": {
          "anyOf": [
            {
              "description": "city name of the location used for searching the weboptional field",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "web_search_country_iso_code": {
          "anyOf": [
            {
              "description": "ISO country code of the location used for searching the weboptional fieldpossible values: 'AR','AT','AU','BE','BR','CA','CH','CL','CN','DE','DK','ES','FI','FR','GB','HK','ID','IN','IT','JP','KR','MX','MY','NL','NO','NZ','PH','PL','PT','RU','SA','SE','TR','TW','US','ZA'",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "LlmMessageChainItem": {
      "properties": {
        "message": {
          "anyOf": [
            {
              "description": "message text",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "role": {
          "anyOf": [
            {
              "description": "role of the user from whom the message originates",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/AiOptimizationClaudeLlmResponsesLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}