Documentation Index
Fetch the complete documentation index at: https://docs.ominiapi.com/llms.txt
Use this file to discover all available pages before exploring further.
代理 Gemini API 请求。路径格式:/v1beta/models/{model_name}:{action}
示例:
/v1beta/models/gemini-2.5-pro:generateContent
/v1beta/models/gemini-2.5-pro:streamGenerateContent?alt=sse
接口信息
POST https://www.ominiapi.com/v1beta/models/{model}:generateContent
认证方式
使用 Bearer Token 进行认证。
| 参数 | 说明 |
|---|
| 格式 | Authorization: Bearer sk-xxxxxx |
| 位置 | Header |
路径参数
| 参数名 | 类型 | 必填 | 说明 |
|---|
| model | string | 是 | 模型名称 |
请求体 (Request Body)
Content-Type: application/json
| 参数名 | 类型 | 必填 | 说明 |
|---|
| contents | array<object> | 否 | 对话内容列表 |
| generationConfig | object | 否 | 生成配置参数 |
| safetySettings | array<object> | 否 | 安全设置 |
| tools | array<object> | 否 | 工具配置 |
| systemInstruction | object | 否 | 系统指令 |
Content 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| parts | array | 是 | 有序的内容部分,构成单个消息 |
| role | string | 否 | 对话中内容的生产者。user、model、function 或 tool |
parts 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| text | string | 否 | 纯文本内容 |
| inlineData | object | 否 | 内联媒体字节数据 |
| fileData | object | 否 | 上传文件的URI引用 |
| functionCall | object | 否 | 函数调用请求 |
| functionResponse | object | 否 | 函数调用响应 |
| executableCode | object | 否 | 可执行代码 |
| codeExecutionResult | object | 否 | 代码执行结果 |
InlineData 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| mimeType | string | 是 | 媒体的MIME类型 |
| data | string | 是 | base64编码的媒体数据 |
FileData 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| mimeType | string | 是 | 文件的MIME类型 |
| fileUri | string | 是 | 文件的URI |
FunctionCall 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| name | string | 是 | 要调用的函数名称 |
| args | object | 否 | 函数参数的键值对 |
FunctionResponse 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| name | string | 是 | 调用的函数名称 |
| response | object | 是 | 函数调用的响应数据 |
ExecutableCode 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| language | enum | 是 | 代码的编程语言
LANGUAGE_UNSPECIFIED: 未指定语言 PYTHON: Python编程语言 |
| code | string | 是 | 要执行的代码 |
ExecutableCode 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| outcome | enum | 是 | 代码执行的结果状态
OUTCOME_UNSPECIFIED: 未指定结果 OUTCOME_OK: 代码执行成功 OUTCOME_FAILED: 代码执行失败 OUTCOME_DEADLINE_EXCEEDED: 代码执行超时 |
| output | string | 否 | 代码执行的输出内容 |
GenerationConfig 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| stopSequences | array | 否 | 用于停止生成输出的字符序列集(最多5个) |
| responseMimeType | string | 否 | 生成的候选文本的MIME类型
text/plain: (默认)文本输出 application/json: JSON响应 text/x.enum: ENUM作为字符串响应 |
| responseSchema | object | 否 | 生成的候选文本的输出架构 |
| responseModalities | array | 否 | 请求的响应模式
TEXT: 指示模型应返回文本 IMAGE: 表示模型应返回图片 AUDIO: 指示模型应返回音频 |
| candidateCount | integer | 否 | 要返回的生成的回答数量 |
| maxOutputTokens | integer | 否 | 候选回答中包含的令牌数量上限 |
| temperature | number | 否 | 控制输出的随机性,范围[0.0, 2.0] |
| topP | number | 否 | 在抽样时要考虑的令牌的累计概率上限 |
| topK | integer | 否 | 抽样时要考虑的令牌数量上限 |
| seed | integer | 否 | 解码中使用的种子 |
| presencePenalty | number | 否 | 存在性惩罚 |
| frequencyPenalty | number | 否 | 频率惩罚 |
| responseLogprobs | bool | 否 | 是否在响应中导出logprobs结果 |
| logprobs | integer | 否 | 返回的顶部logprob的数量 |
| enableEnhancedCivicAnswers | bool | 否 | 启用增强型城市服务回答 |
| speechConfig | object | 否 | 语音生成配置 |
| thinkingConfig | object | 否 | 思考功能的配置 |
| mediaResolution | enum | 否 | 指定的媒体分辨率 |
| imageConfig | object | 否 | 指定的参数 |
imageConfig 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| aspectRatio | string | 否 | 图片分辨率1K 2K 4K |
| imageSize | string | 否 | 图片尺寸1:1 4:3 1:4… |
responseSchema 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| type | enum | 是 | 数据类型 |
| description | string | 否 | 字段描述 |
| enum | arrary | 否 | 枚举值列表(当type为string时) |
| example | 任意类型 | 否 | 示例值 |
| nullable | bool | 否 | 是否可为null |
| format | string | 否 | 字符串格式(如date、date-time等) |
| items | object | 否 | 数组项的Schema(当type为array时) |
| properties | object | 否 | 对象属性的Schema映射(当type为object时) |
| required | arrary | 否 | 必需属性的名称列表 |
| minimum | number | 否 | 数字的最小值 |
| maximum | number | 否 | 数字的最大值 |
| minItems | integer | 否 | 数组的最小长度 |
| maxItems | integer | 否 | 数组的最大长度 |
| minLength | integer | 否 | 字符串的最小长度 |
| maxLength | integer | 否 | 字符串的最大长度 |
SafetySetting 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| category | enum | 是 | 安全类别
HARM_CATEGORY_HARASSMENT: 骚扰内容
HARM_CATEGORY_HATE_SPEECH: 仇恨言论和内容
HARM_CATEGORY_SEXUALLY_EXPLICIT: 露骨色情内容
HARM_CATEGORY_DANGEROUS_CONTENT: 危险内容
HARM_CATEGORY_CIVIC_INTEGRITY: 可能用于破坏公民诚信的内容 |
| threshold | enum | 是 | 屏蔽阈值
HARM_BLOCK_THRESHOLD_UNSPECIFIED: 未指定阈值
BLOCK_LOW_AND_ABOVE: 屏蔽低概率及以上的有害内容,只允许 NEGLIGIBLE 级别的内容
BLOCK_MEDIUM_AND_ABOVE: 屏蔽中等概率及以上的有害内容,允许 NEGLIGIBLE 和 LOW 级别的内容
BLOCK_ONLY_HIGH: 只屏蔽高概率的有害内容,允许 NEGLIGIBLE、LOW 和 MEDIUM 级别的内容
BLOCK_NONE: 不屏蔽任何内容,允许所有级别的内容
OFF: 完全关闭安全过滤器 |
| 参数名 | 类型 | 必填 | 说明 |
|---|
| functionDeclarations | array | 否 | 可选的函数声明列表 |
| codeExecution | object | 否 | 启用模型执行代码 |
CodeExecution 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| 对象 | null | - | 启用代码执行功能的空配置对象 |
| 参数名 | 类型 | 必填 | 说明 |
|---|
| functionCallingConfig | object | 否 | 函数调用配置 |
FunctionCallingConfig 对象属性:
| 参数名 | 类型 | 必填 | 说明 |
|---|
| mode | enum | 否 | 指定函数调用的模式 MODE_UNSPECIFIED: 默认模式,模型决定是否调用函数 AUTO: 模型自动决定何时调用函数 ANY: 模型必须调用函数 NONE: 模型不能调用函数 |
| allowedFunctionNames | array | 否 | 允许调用的函数名列表 |
响应体 (Response Body)
状态码: 200 (成功)
Content-Type: application/json
响应字段说明
| 字段名 | 类型 | 说明 |
|---|
| candidates | array | 候选结果列表 |
| usageMetadata | object | 使用量统计信息 |
| promptFeedback | object | 与内容过滤器相关的提示反馈 |
| responseId | string | 用于标识每个响应的ID |
| modelVersion | string | 用于生成回答的模型版本 |
candidates 对象结构
| 字段名 | 类型 | 说明 |
|---|
| content | object | 模型返回的生成内容 |
| finishReason | enum | 模型停止生成词元的原因
STOP: 模型的自然停止点或提供的停止序列 MAX_TOKENS: 已达到请求中指定的词元数量上限 SAFETY: 出于安全考虑,系统已标记回答候选内容 RECITATION: 由于背诵原因,回答候选内容被标记 LANGUAGE: 回答候选内容因使用不受支持的语言而被标记 OTHER: 原因未知 BLOCKLIST: 由于内容包含禁止使用的字词,因此token生成操作已停止 PROHIBITED_CONTENT: 由于可能包含禁止的内容,因此token生成操作已停止 SPII: 由于内容可能包含敏感的个人身份信息,因此token生成操作已停止 MALFORMED_FUNCTION_CALL: 模型生成的函数调用无效 IMAGE_SAFETY: 由于生成的图片违反了安全规定,因此词元生成已停止 |
| safetyRatings | array | 候选回答安全性的评分列表 |
| citationMetadata | object | 模型生成的候选项的引用信息 |
| tokenCount | integer | 此候选项的令牌数 |
| groundingAttributions | array | 为生成有依据的回答所参考的来源提供方信息 |
| groundingMetadata | object | 候选对象的参考元数据 |
| avgLogprobs | number | 候选项的平均对数概率得分 |
| logprobsResult | object | 回答令牌和前置令牌的对数似然度得分 |
| urlRetrievalMetadata | object | 与网址情境检索工具相关的元数据 |
| urlContextMetadata | object | 与网址情境检索工具相关的元数据 |
| index | integer | 响应候选列表中候选项的索引 |
| 字段名 | 类型 | 说明 |
|---|
| promptTokenCount | integer | 提示中的词元数 |
| cachedContentTokenCount | integer | 提示的缓存部分中的词元数 |
| candidatesTokenCount | integer | 所有生成的候选回答中的词元总数 |
| totalTokenCount | integer | 生成请求的总令牌数 |
| toolUsePromptTokenCount | integer | 工具使用提示中的词元数量 |
| thoughtsTokenCount | integer | 思考模型的想法词元数 |
| promptTokensDetails | integer | 在请求输入中处理的模态列表 |
| candidatesTokensDetails | integer | 响应中返回的模态列表 |
| cacheTokensDetails | integer | 请求输入中缓存内容的模态列表 |
| toolUsePromptTokensDetails | integer | 为工具使用请求输入处理的模态列表 |
promptFeedback 对象结构
| 字段名 | 类型 | 说明 |
|---|
| blockReason | enum | 屏蔽该提示的原因
BLOCK_REASON_UNSPECIFIED: 默认值,此值未使用 SAFETY: 出于安全原因,系统屏蔽了提示 OTHER: 提示因未知原因被屏蔽了 BLOCKLIST: 系统屏蔽了此提示,因为其中包含术语屏蔽名单中包含的术语 PROHIBITED_CONTENT: 系统屏蔽了此提示,因为其中包含禁止的内容 IMAGE_SAFETY: 候选图片因生成不安全的内容而被屏蔽 |
| safetyRatings | array | 问题安全性的评分 |
请求示例
cURL
curl -X POST "https://www.ominiapi.com/v1beta/models/string:generateContent" \
-H "Authorization: Bearer " \
-H "Content-Type: application/json" \
-d '{}'
200
{
"candidates": [
{
"content": {
"role": "string",
"parts": [
{}
]
},
"finishReason": "string",
"safetyRatings": [
{}
]
}
],
"usageMetadata": {
"promptTokenCount": 0,
"candidatesTokenCount": 0,
"totalTokenCount": 0
}
}