Constructor Detail

Method Detail

• maxTokens

   final MessageCreateParams.Body.Builder maxTokens(Long maxTokens)

  The maximum number of tokens to generate before stopping.

  Note that our models may stop before reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate.

  Different models have different maximum values for this parameter. See models for details.

• maxTokens

   final MessageCreateParams.Body.Builder maxTokens(JsonField<Long> maxTokens)

  Sets Builder.maxTokens to an arbitrary JSON value.

  You should usually call Builder.maxTokens with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• messages

   final MessageCreateParams.Body.Builder messages(List<BetaMessageParam> messages)

  Input messages.

  Our models are trained to operate on alternating user and assistant conversational turns. When creating a new Message, you specify the prior conversational turns with the messages parameter, and the model then generates the next Message in the conversation. Consecutive user or assistant turns in your request will be combined into a single turn.

  Each input message must be an object with a role and content. You can specify a single user-role message, or you can include multiple user and assistant messages.

  If the final message uses the assistant role, the response content will continue immediately from the content in that message. This can be used to constrain part of the model's response.

  Example with a single user message:

  [{ "role": "user", "content": "Hello, Claude" }]

  Example with multiple conversational turns:

  [
    { "role": "user", "content": "Hello there." },
    { "role": "assistant", "content": "Hi, I'm Claude. How can I help you?" },
    { "role": "user", "content": "Can you explain LLMs in plain English?" }
  ]

  Example with a partially-filled response from Claude:

  [
    {
      "role": "user",
      "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
    },
    { "role": "assistant", "content": "The best answer is (" }
  ]

  Each input message content may be either a single string or an array of content blocks, where each block has a specific type. Using a string for content is shorthand for an array of one content block of type "text". The following input messages are equivalent:

  { "role": "user", "content": "Hello, Claude" }

  { "role": "user", "content": [{ "type": "text", "text": "Hello, Claude" }] }

  Starting with Claude 3 models, you can also send image content blocks:

  {
    "role": "user",
    "content": [
      {
        "type": "image",
        "source": {
          "type": "base64",
          "media_type": "image/jpeg",
          "data": "/9j/4AAQSkZJRg..."
        }
      },
      { "type": "text", "text": "What is in this image?" }
    ]
  }

  We currently support the base64 source type for images, and the image/jpeg, image/png, image/gif, and image/webp media types.

  See examples for more input examples.

  Note that if you want to include a system prompt, you can use the top-level system parameter — there is no "system" role for input messages in the Messages API.

  There is a limit of 100000 messages in a single request.

• messages

   final MessageCreateParams.Body.Builder messages(JsonField<List<BetaMessageParam>> messages)

  Sets Builder.messages to an arbitrary JSON value.

  You should usually call Builder.messages with a well-typed List<BetaMessageParam> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addMessage

   final MessageCreateParams.Body.Builder addMessage(BetaMessageParam message)

  Adds a single BetaMessageParam to messages.

• addMessage

   final MessageCreateParams.Body.Builder addMessage(BetaMessage message)

  Alias for calling addMessage with message.toParam().

• addUserMessage

   final MessageCreateParams.Body.Builder addUserMessage(BetaMessageParam.Content content)

  Alias for calling addMessage with the following:

  BetaMessageParam.builder()
      .role(BetaMessageParam.Role.USER)
      .content(content)
      .build()

• addUserMessage

   final MessageCreateParams.Body.Builder addUserMessage(String string)

  Alias for calling addUserMessage with BetaMessageParam.Content.ofString(string).

• addUserMessageOfBetaContentBlockParams

   final MessageCreateParams.Body.Builder addUserMessageOfBetaContentBlockParams(List<BetaContentBlockParam> betaContentBlockParams)

  Alias for calling addUserMessage with BetaMessageParam.Content.ofBetaContentBlockParams(betaContentBlockParams).

• addAssistantMessage

   final MessageCreateParams.Body.Builder addAssistantMessage(BetaMessageParam.Content content)

  Alias for calling addMessage with the following:

  BetaMessageParam.builder()
      .role(BetaMessageParam.Role.ASSISTANT)
      .content(content)
      .build()

• addAssistantMessage

   final MessageCreateParams.Body.Builder addAssistantMessage(String string)

  Alias for calling addAssistantMessage with BetaMessageParam.Content.ofString(string).

• addAssistantMessageOfBetaContentBlockParams

   final MessageCreateParams.Body.Builder addAssistantMessageOfBetaContentBlockParams(List<BetaContentBlockParam> betaContentBlockParams)

  Alias for calling addAssistantMessage with BetaMessageParam.Content.ofBetaContentBlockParams(betaContentBlockParams).

• model

   final MessageCreateParams.Body.Builder model(Model model)

  The model that will complete your prompt.\n\nSee models for additional details and options.

• model

   final MessageCreateParams.Body.Builder model(JsonField<Model> model)

  Sets Builder.model to an arbitrary JSON value.

  You should usually call Builder.model with a well-typed Model value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• model

   final MessageCreateParams.Body.Builder model(String value)

  Sets model to an arbitrary String.

  You should usually call model with a well-typed Model constant instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• container

   final MessageCreateParams.Body.Builder container(String container)

  Container identifier for reuse across requests.

• container

   final MessageCreateParams.Body.Builder container(Optional<String> container)

  Alias for calling Builder.container with container.orElse(null).

• container

   final MessageCreateParams.Body.Builder container(JsonField<String> container)

  Sets Builder.container to an arbitrary JSON value.

  You should usually call Builder.container with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• mcpServers

   final MessageCreateParams.Body.Builder mcpServers(List<BetaRequestMcpServerUrlDefinition> mcpServers)

  MCP servers to be utilized in this request

• mcpServers

   final MessageCreateParams.Body.Builder mcpServers(JsonField<List<BetaRequestMcpServerUrlDefinition>> mcpServers)

  Sets Builder.mcpServers to an arbitrary JSON value.

  You should usually call Builder.mcpServers with a well-typed List<BetaRequestMcpServerUrlDefinition> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addMcpServer

   final MessageCreateParams.Body.Builder addMcpServer(BetaRequestMcpServerUrlDefinition mcpServer)

  Adds a single BetaRequestMcpServerUrlDefinition to mcpServers.

• metadata

   final MessageCreateParams.Body.Builder metadata(BetaMetadata metadata)

  An object describing metadata about the request.

• metadata

   final MessageCreateParams.Body.Builder metadata(JsonField<BetaMetadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed BetaMetadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• serviceTier

   final MessageCreateParams.Body.Builder serviceTier(MessageCreateParams.ServiceTier serviceTier)

  Determines whether to use priority capacity (if available) or standard capacity for this request.

  Anthropic offers different levels of service for your API requests. See service-tiers for details.

• serviceTier

   final MessageCreateParams.Body.Builder serviceTier(JsonField<MessageCreateParams.ServiceTier> serviceTier)

  Sets Builder.serviceTier to an arbitrary JSON value.

  You should usually call Builder.serviceTier with a well-typed ServiceTier value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• stopSequences

   final MessageCreateParams.Body.Builder stopSequences(List<String> stopSequences)

  Custom text sequences that will cause the model to stop generating.

  Our models will normally stop when they have naturally completed their turn, which will result in a response stop_reason of "end_turn".

  If you want the model to stop generating when it encounters custom strings of text, you can use the stop_sequences parameter. If the model encounters one of the custom sequences, the response stop_reason value will be "stop_sequence" and the response stop_sequence value will contain the matched stop sequence.

• stopSequences

   final MessageCreateParams.Body.Builder stopSequences(JsonField<List<String>> stopSequences)

  Sets Builder.stopSequences to an arbitrary JSON value.

  You should usually call Builder.stopSequences with a well-typed List<String> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addStopSequence

   final MessageCreateParams.Body.Builder addStopSequence(String stopSequence)

  Adds a single String to stopSequences.

• system

   final MessageCreateParams.Body.Builder system(MessageCreateParams.System system)

  System prompt.

  A system prompt is a way of providing context and instructions to Claude, such as specifying a particular goal or role. See our guide to system prompts.

• system

   final MessageCreateParams.Body.Builder system(JsonField<MessageCreateParams.System> system)

  Sets Builder.system to an arbitrary JSON value.

  You should usually call Builder.system with a well-typed System value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• system

   final MessageCreateParams.Body.Builder system(String string)

  Alias for calling system with System.ofString(string).

• systemOfBetaTextBlockParams

   final MessageCreateParams.Body.Builder systemOfBetaTextBlockParams(List<BetaTextBlockParam> betaTextBlockParams)

  Alias for calling system with System.ofBetaTextBlockParams(betaTextBlockParams).

• temperature

   final MessageCreateParams.Body.Builder temperature(Double temperature)

  Amount of randomness injected into the response.

  Defaults to 1.0. Ranges from 0.0 to 1.0. Use temperature closer to 0.0 for analytical / multiple choice, and closer to 1.0 for creative and generative tasks.

  Note that even with temperature of 0.0, the results will not be fully deterministic.

• temperature

   final MessageCreateParams.Body.Builder temperature(JsonField<Double> temperature)

  Sets Builder.temperature to an arbitrary JSON value.

  You should usually call Builder.temperature with a well-typed Double value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• thinking

   final MessageCreateParams.Body.Builder thinking(BetaThinkingConfigParam thinking)

  Configuration for enabling Claude's extended thinking.

  When enabled, responses include thinking content blocks showing Claude's thinking process before the final answer. Requires a minimum budget of 1,024 tokens and counts towards your max_tokens limit.

  See extended thinking for details.

• thinking

   final MessageCreateParams.Body.Builder thinking(JsonField<BetaThinkingConfigParam> thinking)

  Sets Builder.thinking to an arbitrary JSON value.

  You should usually call Builder.thinking with a well-typed BetaThinkingConfigParam value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• thinking

   final MessageCreateParams.Body.Builder thinking(BetaThinkingConfigEnabled enabled)

  Alias for calling thinking with BetaThinkingConfigParam.ofEnabled(enabled).

• thinking

   final MessageCreateParams.Body.Builder thinking(BetaThinkingConfigDisabled disabled)

  Alias for calling thinking with BetaThinkingConfigParam.ofDisabled(disabled).

• enabledThinking

   final MessageCreateParams.Body.Builder enabledThinking(Long budgetTokens)

  Alias for calling thinking with the following:

  BetaThinkingConfigEnabled.builder()
      .budgetTokens(budgetTokens)
      .build()

• toolChoice

   final MessageCreateParams.Body.Builder toolChoice(BetaToolChoice toolChoice)

  How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.

• toolChoice

   final MessageCreateParams.Body.Builder toolChoice(JsonField<BetaToolChoice> toolChoice)

  Sets Builder.toolChoice to an arbitrary JSON value.

  You should usually call Builder.toolChoice with a well-typed BetaToolChoice value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• toolChoice

   final MessageCreateParams.Body.Builder toolChoice(BetaToolChoiceAuto auto)

  Alias for calling toolChoice with BetaToolChoice.ofAuto(auto).

• toolChoice

   final MessageCreateParams.Body.Builder toolChoice(BetaToolChoiceAny any)

  Alias for calling toolChoice with BetaToolChoice.ofAny(any).

• toolChoice

   final MessageCreateParams.Body.Builder toolChoice(BetaToolChoiceTool tool)

  Alias for calling toolChoice with BetaToolChoice.ofTool(tool).

• toolChoice

   final MessageCreateParams.Body.Builder toolChoice(BetaToolChoiceNone none)

  Alias for calling toolChoice with BetaToolChoice.ofNone(none).

• toolToolChoice

   final MessageCreateParams.Body.Builder toolToolChoice(String name)

  Alias for calling toolChoice with the following:

  BetaToolChoiceTool.builder()
      .name(name)
      .build()

• tools

   final MessageCreateParams.Body.Builder tools(List<BetaToolUnion> tools)

  Definitions of tools that the model may use.

  If you include tools in your API request, the model may return tool_use content blocks that represent the model's use of those tools. You can then run those tools using the tool input generated by the model and then optionally return results back to the model using tool_result content blocks.

  Each tool definition includes:

  • name: Name of the tool.

  • description: Optional, but strongly-recommended description of the tool.

  • input_schema: JSON schema for the tool input shape that the model will produce in tool_use output content blocks.

  For example, if you defined tools as:

  [
    {
      "name": "get_stock_price",
      "description": "Get the current stock price for a given ticker symbol.",
      "input_schema": {
        "type": "object",
        "properties": {
          "ticker": {
            "type": "string",
            "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
          }
        },
        "required": ["ticker"]
      }
    }
  ]

  And then asked the model "What's the S&P 500 at today?", the model might produce tool_use content blocks in the response like this:

  [
    {
      "type": "tool_use",
      "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
      "name": "get_stock_price",
      "input": { "ticker": "^GSPC" }
    }
  ]

  You might then run your get_stock_price tool with {"ticker": "^GSPC"} as an input, and return the following back to the model in a subsequent user message:

  [
    {
      "type": "tool_result",
      "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
      "content": "259.75 USD"
    }
  ]

  Tools can be used for workflows that include running client-side tools and functions, or more generally whenever you want the model to produce a particular JSON structure of output.

  See our guide for more details.

• tools

   final MessageCreateParams.Body.Builder tools(JsonField<List<BetaToolUnion>> tools)

  Sets Builder.tools to an arbitrary JSON value.

  You should usually call Builder.tools with a well-typed List<BetaToolUnion> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolUnion tool)

  Adds a single BetaToolUnion to tools.

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaTool betaTool)

  Alias for calling addTool with BetaToolUnion.ofBetaTool(betaTool).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolComputerUse20241022 computerUse20241022)

  Alias for calling addTool with BetaToolUnion.ofComputerUse20241022(computerUse20241022).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolBash20241022 bash20241022)

  Alias for calling addTool with BetaToolUnion.ofBash20241022(bash20241022).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolTextEditor20241022 textEditor20241022)

  Alias for calling addTool with BetaToolUnion.ofTextEditor20241022(textEditor20241022).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolComputerUse20250124 computerUse20250124)

  Alias for calling addTool with BetaToolUnion.ofComputerUse20250124(computerUse20250124).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolBash20250124 bash20250124)

  Alias for calling addTool with BetaToolUnion.ofBash20250124(bash20250124).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolTextEditor20250124 textEditor20250124)

  Alias for calling addTool with BetaToolUnion.ofTextEditor20250124(textEditor20250124).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaToolTextEditor20250429 textEditor20250429)

  Alias for calling addTool with BetaToolUnion.ofTextEditor20250429(textEditor20250429).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaWebSearchTool20250305 webSearchTool20250305)

  Alias for calling addTool with BetaToolUnion.ofWebSearchTool20250305(webSearchTool20250305).

• addTool

   final MessageCreateParams.Body.Builder addTool(BetaCodeExecutionTool20250522 codeExecutionTool20250522)

  Alias for calling addTool with BetaToolUnion.ofCodeExecutionTool20250522(codeExecutionTool20250522).

• topK

   final MessageCreateParams.Body.Builder topK(Long topK)

  Only sample from the top K options for each subsequent token.

  Used to remove "long tail" low probability responses. Learn more technical details here.

  Recommended for advanced use cases only. You usually only need to use temperature.

• topK

   final MessageCreateParams.Body.Builder topK(JsonField<Long> topK)

  Sets Builder.topK to an arbitrary JSON value.

  You should usually call Builder.topK with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• topP

   final MessageCreateParams.Body.Builder topP(Double topP)

  Use nucleus sampling.

  In nucleus sampling, we compute the cumulative distribution over all the options for each subsequent token in decreasing probability order and cut it off once it reaches a particular probability specified by top_p. You should either alter temperature or top_p, but not both.

  Recommended for advanced use cases only. You usually only need to use temperature.

• topP

   final MessageCreateParams.Body.Builder topP(JsonField<Double> topP)

  Sets Builder.topP to an arbitrary JSON value.

  You should usually call Builder.topP with a well-typed Double value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final MessageCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final MessageCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final MessageCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final MessageCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final MessageCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final MessageCreateParams.Body build()

  Returns an immutable instance of Body.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .maxTokens()
  .messages()
  .model()