Post modelmodelidinvoke with response stream — bedrock-runtime

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1411386222.7 KB

Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.

To see if a model supports streaming, call GetFoundationModel and check the responseStreamingSupported field in the response.

The CLI doesn't support streaming operations in Amazon Bedrock, including InvokeModelWithResponseStream.

For example code, see Invoke model with streaming code example in the Amazon Bedrock User Guide.

This operation requires permissions to perform the bedrock:InvokeModelWithResponseStream action.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.

For troubleshooting some of the common errors you might encounter when using the InvokeModelWithResponseStream API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

post/model/{modelId}/invoke-with-response-stream

Path parameters

modelIdstring required

The unique identifier of the model to invoke to run inference. The <code>modelId</code> to provide depends on the type of model or throughput that you use: <ul> <li> If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide. </li> <li> If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide. </li> <li> If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide. </li> <li> If you use a custom model, specify the ARN of the custom model deployment (for on-demand inference) or the ARN of your provisioned model (for Provisioned Throughput). For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide. </li> <li> If you use an <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported model</a>, specify the ARN of the imported model. You can get the model ARN from a successful call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html">CreateModelImportJob</a> or from the Imported models page in the Amazon Bedrock console. </li> </ul>

Headers

Content-Typestring

The MIME type of the input data in the request. You must specify <code>application/json</code>.

X-Amzn-Bedrock-Acceptstring

The desired MIME type of the inference body in the response. The default value is <code>application/json</code>.

X-Amzn-Bedrock-Trace'ENABLED' | 'DISABLED' | 'ENABLED_FULL'

Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.

X-Amzn-Bedrock-GuardrailIdentifierstring

The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation. An error is thrown in the following situations. <ul> <li> You don't provide a guardrail identifier but you specify the <code>amazon-bedrock-guardrailConfig</code> field in the request body. </li> <li> You enable the guardrail but the <code>contentType</code> isn't <code>application/json</code>. </li> <li> You provide a guardrail identifier, but <code>guardrailVersion</code> isn't specified. </li> </ul>

X-Amzn-Bedrock-GuardrailVersionstring

The version number for the guardrail. The value can also be <code>DRAFT</code>.

X-Amzn-Bedrock-PerformanceConfig-Latency'standard' | 'optimized'

Model performance settings for the request.

X-Amzn-Bedrock-Service-Tier'priority' | 'default' | 'flex' | 'reserved'

Specifies the processing tier type used for serving the request.

X-Amzn-Bedrock-Request-Metadatastring password

Key-value pairs that you can use to filter invocation logs.

Request body

bodystring password

The prompt and inference parameters in the format specified in the <code>contentType</code> in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters</a>. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html">Run inference</a> in the Bedrock User Guide.

Response

Success