A valid request URL is required to generate request examples{
"candidates": [
{
"content": {
"parts": [
{
"text": "<string>",
"thought": true,
"thoughtSignature": "aSDinaTvuI8gbWludGxpZnk=",
"inlineData": {
"mimeType": "<string>",
"data": "aSDinaTvuI8gbWludGxpZnk=",
"displayName": "<string>"
},
"fileData": {
"mimeType": "<string>",
"fileUri": "<string>",
"displayName": "<string>"
},
"functionCall": {
"id": "<string>",
"name": "<string>",
"args": {}
},
"functionResponse": {
"id": "<string>",
"name": "<string>",
"response": {},
"willContinue": true,
"scheduling": "<string>"
},
"executableCode": {
"language": "<string>",
"code": "<string>"
},
"codeExecutionResult": {
"output": "<string>"
},
"videoMetadata": {
"fps": 123,
"startOffset": "<string>",
"endOffset": "<string>"
}
}
]
},
"finishMessage": "<string>",
"tokenCount": 123,
"safetyRatings": [
{
"category": "<string>",
"probability": "<string>",
"probabilityScore": 123,
"severity": "<string>",
"severityScore": 123,
"blocked": true,
"overwrittenThreshold": "<string>"
}
],
"citationMetadata": {},
"index": 123,
"groundingMetadata": {},
"urlContextMetadata": {
"urlMetadata": [
{
"retrievedUrl": "<string>",
"urlRetrievalStatus": "<string>"
}
]
},
"avgLogprobs": 123,
"logprobsResult": {
"chosenCandidates": [
{
"token": "<string>",
"tokenId": 123,
"logProbability": 123
}
],
"topCandidates": [
{
"candidates": [
{
"token": "<string>",
"tokenId": 123,
"logProbability": 123
}
]
}
]
}
}
],
"promptFeedback": {
"blockReason": "<string>",
"blockReasonMessage": "<string>",
"safetyRatings": [
{
"category": "<string>",
"probability": "<string>",
"probabilityScore": 123,
"severity": "<string>",
"severityScore": 123,
"blocked": true,
"overwrittenThreshold": "<string>"
}
]
},
"usageMetadata": {
"promptTokenCount": 123,
"candidatesTokenCount": 123,
"totalTokenCount": 123,
"cachedContentTokenCount": 123,
"thoughtsTokenCount": 123,
"toolUsePromptTokenCount": 123,
"trafficType": "<string>",
"cacheTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
],
"candidatesTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
],
"promptTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
],
"toolUsePromptTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
]
},
"modelVersion": "<string>",
"responseId": "<string>",
"createTime": "2023-11-07T05:31:56Z"
}Generate image (Gemini format)
For Imagen models, use the :predict suffix (e.g., imagen-3.0-generate-001:predict).
For Gemini models, use :generateContent with generationConfig.responseModalities: ["IMAGE"] in the request body.
A valid request URL is required to generate request examples{
"candidates": [
{
"content": {
"parts": [
{
"text": "<string>",
"thought": true,
"thoughtSignature": "aSDinaTvuI8gbWludGxpZnk=",
"inlineData": {
"mimeType": "<string>",
"data": "aSDinaTvuI8gbWludGxpZnk=",
"displayName": "<string>"
},
"fileData": {
"mimeType": "<string>",
"fileUri": "<string>",
"displayName": "<string>"
},
"functionCall": {
"id": "<string>",
"name": "<string>",
"args": {}
},
"functionResponse": {
"id": "<string>",
"name": "<string>",
"response": {},
"willContinue": true,
"scheduling": "<string>"
},
"executableCode": {
"language": "<string>",
"code": "<string>"
},
"codeExecutionResult": {
"output": "<string>"
},
"videoMetadata": {
"fps": 123,
"startOffset": "<string>",
"endOffset": "<string>"
}
}
]
},
"finishMessage": "<string>",
"tokenCount": 123,
"safetyRatings": [
{
"category": "<string>",
"probability": "<string>",
"probabilityScore": 123,
"severity": "<string>",
"severityScore": 123,
"blocked": true,
"overwrittenThreshold": "<string>"
}
],
"citationMetadata": {},
"index": 123,
"groundingMetadata": {},
"urlContextMetadata": {
"urlMetadata": [
{
"retrievedUrl": "<string>",
"urlRetrievalStatus": "<string>"
}
]
},
"avgLogprobs": 123,
"logprobsResult": {
"chosenCandidates": [
{
"token": "<string>",
"tokenId": 123,
"logProbability": 123
}
],
"topCandidates": [
{
"candidates": [
{
"token": "<string>",
"tokenId": 123,
"logProbability": 123
}
]
}
]
}
}
],
"promptFeedback": {
"blockReason": "<string>",
"blockReasonMessage": "<string>",
"safetyRatings": [
{
"category": "<string>",
"probability": "<string>",
"probabilityScore": 123,
"severity": "<string>",
"severityScore": 123,
"blocked": true,
"overwrittenThreshold": "<string>"
}
]
},
"usageMetadata": {
"promptTokenCount": 123,
"candidatesTokenCount": 123,
"totalTokenCount": 123,
"cachedContentTokenCount": 123,
"thoughtsTokenCount": 123,
"toolUsePromptTokenCount": 123,
"trafficType": "<string>",
"cacheTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
],
"candidatesTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
],
"promptTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
],
"toolUsePromptTokensDetails": [
{
"modality": "<string>",
"tokenCount": 123
}
]
},
"modelVersion": "<string>",
"responseId": "<string>",
"createTime": "2023-11-07T05:31:56Z"
}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 name with action suffix. For Imagen models, use :predict (e.g., imagen-3.0-generate-001:predict).
For Gemini models with image generation, use :generateContent (e.g., gemini-1.5-pro:generateContent).
Body
Model field for explicit model specification
Content for the model to process
Show child attributes
Show child attributes
System instruction for the model
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Cached content resource name
Labels for the request
Show child attributes
Show child attributes
Batch embedding requests
Show child attributes
Show child attributes
Response
Successful response. Returns JSON with generated image data in candidates[0].content.parts[0].inlineData.
When streaming, events are sent via Server-Sent Events (SSE).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The model version used to generate the response
Response ID for identifying each response (encoding of event_id)
Timestamp when the request was made to the server
Was this page helpful?

