Stream converse with model (Bedrock format)

Streams messages from a model using AWS Bedrock Converse API format.

POST
/bedrock/model/{modelId}/converse-stream
AuthorizationBearer <token>

Bearer token authentication. Use your MPilot virtual-key JWT or admin JWT. Virtual keys (prefixed with sk-bf-) can also be passed here.

In: header

Path Parameters

modelIdstring

Model ID (e.g., anthropic.claude-3-sonnet-20240229-v1:0)

messages?array<BedrockMessage>

Array of messages for the conversation

system?array<object>

System messages/prompts

inferenceConfig?object
toolConfig?object
guardrailConfig?object
additionalModelRequestFields?object

Model-specific parameters

Empty Object

additionalModelResponseFieldPaths?array<string>
performanceConfig?object
promptVariables?object

Empty Object

requestMetadata?object

Empty Object

serviceTier?object
fallbacks?array<string>

Response Body

curl -X POST "https://loading/{AI_GATEWAY_URL}/bedrock/model/string/converse-stream" \  -H "Content-Type: application/json" \  -d '{}'
{
  "role": "string",
  "contentBlockIndex": 0,
  "delta": {
    "text": "string",
    "reasoningContent": {
      "text": "string",
      "signature": "string"
    },
    "toolUse": {
      "input": "string"
    }
  },
  "stopReason": "string",
  "start": {
    "toolUse": {
      "toolUseId": "string",
      "name": "string"
    }
  },
  "usage": {
    "inputTokens": 0,
    "outputTokens": 0,
    "totalTokens": 0,
    "cacheReadInputTokens": 0,
    "cacheWriteInputTokens": 0
  },
  "metrics": {
    "latencyMs": 0
  },
  "trace": {},
  "additionalModelResponseFields": {},
  "invokeModelRawChunk": "string"
}
{
  "message": "string",
  "type": "string"
}
{
  "message": "string",
  "type": "string"
}
On this page

On this page

No Headings