Skip to main content
POST
/
pydanticai
/
bedrock
/
model
/
{modelId}
/
converse
Error
A valid request URL is required to generate request examples
{
  "output": {
    "message": {
      "role": "user",
      "content": [
        {
          "text": "<string>",
          "image": {
            "format": "jpeg",
            "source": {
              "bytes": "aSDinaTvuI8gbWludGxpZnk="
            }
          },
          "document": {
            "format": "pdf",
            "name": "<string>",
            "source": {
              "bytes": "aSDinaTvuI8gbWludGxpZnk=",
              "text": "<string>"
            }
          },
          "toolUse": {
            "toolUseId": "<string>",
            "name": "<string>",
            "input": {}
          },
          "toolResult": {
            "toolUseId": "<string>",
            "content": "<array>",
            "status": "success"
          },
          "guardContent": {
            "text": {
              "text": "<string>",
              "qualifiers": [
                "<string>"
              ]
            }
          },
          "reasoningContent": {
            "reasoningText": {
              "text": "<string>",
              "signature": "<string>"
            }
          },
          "json": {},
          "cachePoint": {
            "type": "default"
          }
        }
      ]
    }
  },
  "stopReason": "end_turn",
  "usage": {
    "inputTokens": 123,
    "outputTokens": 123,
    "totalTokens": 123,
    "cacheReadInputTokens": 123,
    "cacheWriteInputTokens": 123
  },
  "metrics": {
    "latencyMs": 123
  },
  "additionalModelResponseFields": {},
  "trace": {},
  "performanceConfig": {
    "latency": "standard"
  },
  "serviceTier": {
    "type": "reserved"
  }
}

Authorizations

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

system
object[]

System messages/prompts

inferenceConfig
object
toolConfig
object
guardrailConfig
object
additionalModelRequestFields
object

Model-specific parameters

additionalModelResponseFieldPaths
string[]
performanceConfig
object
promptVariables
object
requestMetadata
object
serviceTier
object
fallbacks
string[]

Response

Successful response

output
object
stopReason
enum<string>
Available options:
end_turn,
tool_use,
max_tokens,
stop_sequence,
guardrail_intervened,
content_filtered
usage
object
metrics
object
additionalModelResponseFields
object
trace
object
performanceConfig
object
serviceTier
object