Try Bifrost Enterprise free for 14 days. Explore now
API Reference
- POSTConverse with model (Bedrock format)
- POSTStream converse with model (Bedrock format)
- POSTInvoke model (Bedrock format)
- POSTInvoke model with streaming (Bedrock format)
- POSTCount tokens (Bedrock format)
- POSTCreate batch inference job (Bedrock format)
- GETList batch inference jobs (Bedrock format)
- GETRetrieve batch inference job (Bedrock format)
- POSTCancel batch inference job (Bedrock format)
- GETS3-compatible ListObjectsV2
- GETS3-compatible GetObject
- PUTS3-compatible PutObject
- DELS3-compatible DeleteObject
- HEADS3-compatible HeadObject
A valid request URL is required to generate request examples{
"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="
}Stream converse with model (Bedrock format)
Streams messages from a model using AWS Bedrock Converse API format.
A valid request URL is required to generate request examples{
"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="
}Documentation Index
Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
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
Model ID (e.g., anthropic.claude-3-sonnet-20240229-v1:0)
Body
Array of messages for the conversation
Show child attributes
Show child attributes
System messages/prompts
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Model-specific parameters
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful streaming response
Flat structure for streaming events matching actual Bedrock API response
For messageStart events
For content block events
Show child attributes
Show child attributes
For messageStop events
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Raw bytes for legacy invoke stream
Was this page helpful?