Package com.anthropic.models.beta.messages

Class MessageCreateParams.Body

    • Constructor Detail

    • Method Detail

      • maxTokens

         final 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.

        Set to 0 to populate the prompt cache without generating a response.

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

      • messages

         final 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"}]}

        See 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 100,000 messages in a single request.

      • model

         final Model model()

        The model that will complete your prompt.

        See models for additional details and options.

      • fallbackCreditToken

         final Optional<String> fallbackCreditToken()

        The fallback_credit_token from a prior refusal's stop_details.

        When a preceding request was refused and returned a fallback_credit_token, pass that code here on the retry to have the retry's cache-creation tokens for the prefix that was warm on the refused model billed at the cache-read rate. Must be redeemed by the same organization and workspace, with the same request body (optionally extended by one appended assistant message whose content is the partial text — with any trailing whitespace stripped from the final text block — and paired server-tool blocks streamed before the refusal; the appended-assistant form is not available for requests with output_format set or forced tool_choice), on an eligible fallback model, on the same platform, and within 5 minutes of the refusal; a mismatch is a 400. A token minted mid-server-tool-loop whose partial content was continuable may only be redeemed with the appended-assistant form — if an exact-body retry is rejected with a 400 saying the token must be redeemed by continuing the partial response, retry with the appended-assistant form instead.

        When the appended-assistant form is used on a model that otherwise disallows assistant-turn prefill, this token also authorizes that one prefill.

      • fallbacks

         final Optional<List<BetaFallbackParam>> fallbacks()

        Opt-in server-side retry on one or more substitute models when the requested model declines for policy reasons. Tried in order: if the first entry also declines, the second is tried, and so on.

      • inferenceGeo

         final Optional<String> inferenceGeo()

        Specifies the geographic region for inference processing. If not specified, the workspace's default_inference_geo is used.

      • stopSequences

         final Optional<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.

      • temperature

        @Deprecated(message = "Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error.") final Optional<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.

      • thinking

         final Optional<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.

      • toolChoice

         final Optional<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.

      • tools

         final Optional<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.

        There are two types of tools: client tools and server tools. The behavior described below applies to client tools. For server tools, see their individual documentation as each has its own behavior (e.g., the web search tool).

        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.

      • topK

        @Deprecated(message = "Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.") final Optional<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.

      • topP

        @Deprecated(message = "Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error.") final Optional<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.

        Recommended for advanced use cases only.

      • userProfileId

         final Optional<String> userProfileId()

        The user profile ID to attribute this request to. Use when acting on behalf of a party other than your organization.

      • _model

         final JsonField<Model> _model()

        Returns the raw JSON value of model.

        Unlike model, this method doesn't throw if the JSON field has an unexpected type.

      • _temperature

        @Deprecated(message = "Deprecated. Models released after Claude Opus 4.6 do not support setting temperature. A value of 1.0 of will be accepted for backwards compatibility, all other values will be rejected with a 400 error.") final JsonField<Double> _temperature()

        Returns the raw JSON value of temperature.

        Unlike temperature, this method doesn't throw if the JSON field has an unexpected type.

      • _topK

        @Deprecated(message = "Deprecated. Models released after Claude Opus 4.6 do not accept top_k; any value will be rejected with a 400 error.") final JsonField<Long> _topK()

        Returns the raw JSON value of topK.

        Unlike topK, this method doesn't throw if the JSON field has an unexpected type.

      • _topP

        @Deprecated(message = "Deprecated. Models released after Claude Opus 4.6 do not support setting top_p. A value >= 0.99 will be accepted for backwards compatibility, all other values will be rejected with a 400 error.") final JsonField<Double> _topP()

        Returns the raw JSON value of topP.

        Unlike topP, this method doesn't throw if the JSON field has an unexpected type.

      • validate

         final MessageCreateParams.Body validate()

        Validates that the types of all values in this object match their expected types recursively.

        This method is not forwards compatible with new types from the API for existing fields.