Converse with model (Bedrock format)

Sends messages to a model using AWS Bedrock Converse API format.

POST /bedrock/model/{modelId}/converse

Error

A valid request URL is required to generate request examples

200

{
  "output": {
    "message": {
      "content": [
        {
          "text": "<string>",
          "image": {
            "source": {
              "bytes": "aSDinaTvuI8gbWludGxpZnk="
            }
          },
          "document": {
            "name": "<string>",
            "source": {
              "bytes": "aSDinaTvuI8gbWludGxpZnk=",
              "text": "<string>"
            }
          },
          "toolUse": {
            "toolUseId": "<string>",
            "name": "<string>",
            "input": {}
          },
          "toolResult": {
            "toolUseId": "<string>",
            "content": "<array>"
          },
          "guardContent": {
            "text": {
              "text": "<string>",
              "qualifiers": [
                "<string>"
              ]
            }
          },
          "reasoningContent": {
            "reasoningText": {
              "text": "<string>",
              "signature": "<string>"
            }
          },
          "json": {},
          "cachePoint": {}
        }
      ]
    }
  },
  "usage": {
    "inputTokens": 123,
    "outputTokens": 123,
    "totalTokens": 123,
    "cacheReadInputTokens": 123,
    "cacheWriteInputTokens": 123
  },
  "metrics": {
    "latencyMs": 123
  },
  "additionalModelResponseFields": {},
  "trace": {},
  "performanceConfig": {},
  "serviceTier": {}
}

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 (e.g., anthropic.claude-3-sonnet-20240229-v1:0)

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/json

Successful response

output · object

Show child attributes

stopReason · enum<string>

Available options: end_turn, tool_use, max_tokens, stop_sequence, guardrail_intervened, content_filtered

usage · object

Show child attributes

metrics · object

Show child attributes

additionalModelResponseFields · object

trace · object

performanceConfig · object

Show child attributes

serviceTier · object

Show child attributes