Skip to main content
POST
Create Cached Content

授权

x-goog-api-key
string
header
必填

Tikway API Key。按 Gemini 原生协议通过 x-goog-api-key 请求头传递。

请求体

application/json

创建缓存内容的请求体。缓存内容经过预处理后,可以在后续生成请求中重复使用。缓存只能用于创建它时指定的模型。

model
string
必填

用于创建和使用该缓存的模型资源名称。缓存只能用于这里指定的模型,格式为 models/{model}。该字段为必填项,创建后不可修改。

Pattern: ^models/[^/]+$
示例:

"models/gemini-1.5-flash-001"

"models/gemini-2.5-flash"

contents
object[]

需要缓存的内容列表。可以包含单轮内容,也可以按照对话顺序包含多轮历史内容。该字段仅用于输入,缓存创建后不可修改。

Minimum array length: 1
tools
object[]

模型在后续生成内容时可以使用的工具列表。该字段仅用于输入,缓存创建后不可修改。

expireTime
string<date-time>

缓存失效的绝对时间,使用 RFC 3339 格式。服务端输出时会规范化为 UTC 时间。该字段与 ttl 互斥,最多设置其中一个。

示例:

"2026-09-08T12:00:00Z"

"2026-09-08T12:00:00.123Z"

ttl
string

缓存的相对有效时长,以秒为单位,最多支持 9 位小数,并以 s 结尾。该字段仅用于输入,与 expireTime 互斥。

Pattern: ^[0-9]+(?:\.[0-9]{1,9})?s$
示例:

"300s"

"3600s"

"3.5s"

displayName
string

用户为缓存内容设置的可读名称,最多包含 128 个 Unicode 字符。该字段在缓存创建后不可修改。

Maximum string length: 128
systemInstruction
object

由开发者设置的系统指令。当前仅支持纯文本 Part。该字段仅用于输入,缓存创建后不可修改。

toolConfig
object

工具调用配置。该配置由所有 tools 共享,仅用于输入,缓存创建后不可修改。

响应

200 - application/json

创建成功后返回的缓存内容资源。响应主要包含缓存标识、模型、创建时间、更新时间、实际过期时间和令牌用量。

name
string
必填

缓存内容的唯一资源名称,由服务端生成,格式为 cachedContents/{id}。

Pattern: ^cachedContents/[^/]+$
示例:

"cachedContents/abc123def456"

model
string
必填

该缓存绑定的模型资源名称。缓存只能用于此模型。

Pattern: ^models/[^/]+$
示例:

"models/gemini-1.5-flash-001"

expireTime
string<date-time>
必填

缓存实际失效的绝对时间。无论请求中使用 expireTime 还是 ttl,服务端都会在响应中返回该字段。

示例:

"2026-09-08T11:00:00Z"

displayName
string

创建缓存时设置的可读名称。未设置时可能不返回该字段。

Maximum string length: 128
createTime
string<date-time>

缓存资源的创建时间,由服务端生成,采用 RFC 3339 格式并通常规范化为 UTC 时间。

示例:

"2026-09-08T10:00:00Z"

updateTime
string<date-time>

缓存资源最后一次更新的时间,由服务端生成,采用 RFC 3339 格式并通常规范化为 UTC 时间。

示例:

"2026-09-08T10:00:00Z"

usageMetadata
object

缓存内容的令牌用量信息。