Stream converse with model (LangChain - Bedrock format)

Streams messages using AWS Bedrock Converse-compatible format via LangChain.

POST /langchain/bedrock/model/{modelId}/converse-stream

Error

A valid request URL is required to generate request examples

200

{
  "role": "<string>",
  "contentBlockIndex": 123,
  "delta": {
    "text": "<string>",
    "reasoningContent": {
      "text": "<string>",
      "signature": "<string>"
    },
    "toolUse": {
      "input": "<string>"
    }
  },
  "stopReason": "<string>",
  "start": {
    "toolUse": {
      "toolUseId": "<string>",
      "name": "<string>"
    }
  },
  "usage": {
    "inputTokens": 123,
    "outputTokens": 123,
    "totalTokens": 123,
    "cacheReadInputTokens": 123,
    "cacheWriteInputTokens": 123
  },
  "metrics": {
    "latencyMs": 123
  },
  "trace": {},
  "additionalModelResponseFields": {},
  "invokeModelRawChunk": "aSDinaTvuI8gbWludGxpZnk="
}

Authorizations

BearerAuthBasicAuthVirtualKeyAuthApiKeyAuth

Authorization · string · header · required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Path Parameters

modelId · string · required

Model ID

Body

application/json

messages · object[]

Array of messages for the conversation

Show child attributes

system · object[]

System messages/prompts

Show child attributes

inferenceConfig · object

Show child attributes

toolConfig · object

Show child attributes

guardrailConfig · object

Show child attributes

additionalModelRequestFields · object

Model-specific parameters

additionalModelResponseFieldPaths · string[]

performanceConfig · object

Show child attributes

promptVariables · object

Show child attributes

requestMetadata · object

Show child attributes

serviceTier · object

Show child attributes

fallbacks · string[]

Response

200

application/x-amz-eventstream

Successful streaming response

Flat structure for streaming events matching actual Bedrock API response

role · string

For messageStart events

contentBlockIndex · integer

For content block events

delta · object

Show child attributes

stopReason · string

For messageStop events

start · object

Show child attributes

usage · object

Show child attributes

metrics · object

Show child attributes

trace · object

additionalModelResponseFields · object

invokeModelRawChunk · string<byte>

Raw bytes for legacy invoke stream