Responses

curl --request POST \
  --url https://api.tikway.ai/v1/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "gpt-5.6-sol",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Write a short bedtime story about a unicorn."
        }
      ]
    }
  ]
}
'

"{\n    \"background\": false,\n    \"completed_at\": 1788668639,\n    \"created_at\": 1788668638,\n    \"error\": null,\n    \"frequency_penalty\": 0,\n    \"id\": \"resp_074472f9988a119f006a9ceade27888194add2283781e99db5::Q_Olg6GjTjN-VysDZS83LBWBO3NVTBTLcLGOvp0PrBP_XWO97d8Yq9ztZQZONcJzIV1Cug\",\n    \"incomplete_details\": null,\n    \"instructions\": null,\n    \"max_output_tokens\": null,\n    \"max_tool_calls\": null,\n    \"metadata\": {},\n    \"model\": \"gpt-5.6-sol\",\n    \"object\": \"response\",\n    \"output\": [\n        {\n            \"content\": [\n                {\n                    \"annotations\": [],\n                    \"logprobs\": [],\n                    \"text\": \"Hello! How can I help?\",\n                    \"type\": \"output_text\"\n                }\n            ],\n            \"id\": \"msg_074472f9988a119f006a9ceadecd488194a8a5c2f9f4c1d83e\",\n            \"phase\": \"final_answer\",\n            \"role\": \"assistant\",\n            \"status\": \"completed\",\n            \"type\": \"message\"\n        }\n    ],\n    \"parallel_tool_calls\": true,\n    \"presence_penalty\": 0,\n    \"previous_response_id\": null,\n    \"prompt_cache_key\": null,\n    \"prompt_cache_retention\": \"24h\",\n    \"reasoning\": {\n        \"context\": \"all_turns\",\n        \"effort\": \"medium\",\n        \"mode\": \"standard\",\n        \"summary\": null\n    },\n    \"safety_identifier\": null,\n    \"service_tier\": \"default\",\n    \"status\": \"completed\",\n    \"store\": true,\n    \"temperature\": 1,\n    \"text\": {\n        \"format\": {\n            \"type\": \"text\"\n        },\n        \"verbosity\": \"medium\"\n    },\n    \"tool_choice\": \"auto\",\n    \"tools\": [],\n    \"top_logprobs\": 0,\n    \"top_p\": 0.98,\n    \"truncation\": \"disabled\",\n    \"usage\": {\n        \"input_tokens\": 7,\n        \"input_tokens_details\": {\n            \"cache_write_tokens\": 0,\n            \"cached_read_tokens\": 0,\n            \"cached_tokens\": 0,\n            \"cached_write_tokens\": 0\n        },\n        \"output_tokens\": 11,\n        \"output_tokens_details\": {\n            \"reasoning_tokens\": 0\n        },\n        \"total_tokens\": 18\n    }\n}"

POST

https://api.tikway.ai

responses

curl --request POST \
  --url https://api.tikway.ai/v1/responses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "gpt-5.6-sol",
  "input": [
    {
      "role": "user",
      "content": [
        {
          "type": "input_text",
          "text": "Write a short bedtime story about a unicorn."
        }
      ]
    }
  ]
}
'

"{\n    \"background\": false,\n    \"completed_at\": 1788668639,\n    \"created_at\": 1788668638,\n    \"error\": null,\n    \"frequency_penalty\": 0,\n    \"id\": \"resp_074472f9988a119f006a9ceade27888194add2283781e99db5::Q_Olg6GjTjN-VysDZS83LBWBO3NVTBTLcLGOvp0PrBP_XWO97d8Yq9ztZQZONcJzIV1Cug\",\n    \"incomplete_details\": null,\n    \"instructions\": null,\n    \"max_output_tokens\": null,\n    \"max_tool_calls\": null,\n    \"metadata\": {},\n    \"model\": \"gpt-5.6-sol\",\n    \"object\": \"response\",\n    \"output\": [\n        {\n            \"content\": [\n                {\n                    \"annotations\": [],\n                    \"logprobs\": [],\n                    \"text\": \"Hello! How can I help?\",\n                    \"type\": \"output_text\"\n                }\n            ],\n            \"id\": \"msg_074472f9988a119f006a9ceadecd488194a8a5c2f9f4c1d83e\",\n            \"phase\": \"final_answer\",\n            \"role\": \"assistant\",\n            \"status\": \"completed\",\n            \"type\": \"message\"\n        }\n    ],\n    \"parallel_tool_calls\": true,\n    \"presence_penalty\": 0,\n    \"previous_response_id\": null,\n    \"prompt_cache_key\": null,\n    \"prompt_cache_retention\": \"24h\",\n    \"reasoning\": {\n        \"context\": \"all_turns\",\n        \"effort\": \"medium\",\n        \"mode\": \"standard\",\n        \"summary\": null\n    },\n    \"safety_identifier\": null,\n    \"service_tier\": \"default\",\n    \"status\": \"completed\",\n    \"store\": true,\n    \"temperature\": 1,\n    \"text\": {\n        \"format\": {\n            \"type\": \"text\"\n        },\n        \"verbosity\": \"medium\"\n    },\n    \"tool_choice\": \"auto\",\n    \"tools\": [],\n    \"top_logprobs\": 0,\n    \"top_p\": 0.98,\n    \"truncation\": \"disabled\",\n    \"usage\": {\n        \"input_tokens\": 7,\n        \"input_tokens_details\": {\n            \"cache_write_tokens\": 0,\n            \"cached_read_tokens\": 0,\n            \"cached_tokens\": 0,\n            \"cached_write_tokens\": 0\n        },\n        \"output_tokens\": 11,\n        \"output_tokens_details\": {\n            \"reasoning_tokens\": 0\n        },\n        \"total_tokens\": 18\n    }\n}"

授权

Authorization

string

header

必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json

model

string

用于生成响应的模型 ID，例如 gpt-5.6-sol。

input

提供给模型的文本、图片、音频或文件输入。可直接为字符串，或为输入消息数组。

instructions

string

插入模型上下文的系统或开发者指令。使用 previous_response_id 时，前一响应的 instructions 不会自动继承。

previous_response_id

string

上一条 Response 的唯一 ID，用于多轮对话；不能与 conversation 同时使用。

conversation

本次响应所属的会话。会话项会自动加入本次上下文，输入和输出项也会写入该会话。

background

boolean

是否在后台运行模型响应。

include

enum<string>[]

指定需要额外包含在响应中的数据。

可用选项:

web_search_call.action.sources,

code_interpreter_call.outputs,

computer_call_output.output.image_url,

file_search_call.results,

message.input_image.image_url,

message.output_text.logprobs,

reasoning.encrypted_content

max_output_tokens

integer

生成响应允许使用的最大词元数，包含可见输出和推理词元。

必填范围: x >= 1

max_tool_calls

integer

响应中可处理的内置工具调用总次数上限。

必填范围: x >= 0

metadata

object

最多 16 个键值对元数据；键最长 64 个字符，值最长 512 个字符。

Hide child attributes

metadata.{key}

string

Maximum string length: 512

moderation

object

对输入和输出执行内容审核的配置。

Hide child attributes

moderation.model

string

审核模型 ID。

moderation.policy

string

审核策略。

parallel_tool_calls

boolean

是否允许模型并行调用工具。

prompt

object

提示词模板及其变量。

Hide child attributes

prompt.id

string

提示词模板 ID。

prompt.version

string

模板版本。

prompt.variables

object

模板变量。

prompt_cache_key

string

用于提高相似请求缓存命中率的稳定键；取代 user 字段。

prompt_cache_options

object

提示词缓存选项。

Hide child attributes

prompt_cache_options.mode

enum<string>

缓存断点模式。explicit 会关闭隐式断点。

可用选项:

implicit,

explicit

prompt_cache_options.ttl

enum<string>

缓存最短有效期。

可用选项:

30m

prompt_cache_retention

enum<string>

已弃用，请使用 prompt_cache_options.ttl。

可用选项:

in_memory,

24h

reasoning

object

推理模型配置。

Hide child attributes

reasoning.effort

enum<string>

推理强度。

可用选项:

none,

low,

medium,

high,

xhigh

reasoning.summary

enum<string>

推理摘要级别。

可用选项:

auto,

concise,

detailed

reasoning.generate_summary

string

推理摘要生成设置。

reasoning.context

string

推理上下文设置。

safety_identifier

string

稳定的终端用户标识符，用于协助检测滥用；建议使用用户名或邮箱的哈希值。

Maximum string length: 64

service_tier

enum<string>

请求的服务层级。

可用选项:

auto,

default,

flex,

scale,

priority,

fast,

ultrafast

store

boolean

是否存储生成的 Response 以供后续通过 API 获取。

stream

boolean

是否以 SSE 流式返回事件。

stream_options

object

流式选项，仅在 stream 为 true 时设置。

Hide child attributes

stream_options.include_obfuscation

boolean

是否包含流式事件的混淆字段。

temperature

number

采样温度；通常与 top_p 二选一调整。

必填范围: 0 <= x <= 2

top_p

number

核采样阈值；通常与 temperature 二选一调整。

必填范围: 0 <= x <= 1

text

object

文本或结构化 JSON 输出配置。

Hide child attributes

text.verbosity

enum<string>

文本输出详细程度。

可用选项:

low,

medium,

high

text.format

object

文本输出格式。

Hide child attributes

text.format.type

enum<string>

输出格式类型。

可用选项:

text,

json_object,

json_schema

text.format.name

string

JSON Schema 名称。

text.format.description

string

JSON Schema 说明。

text.format.schema

object

结构化输出的目标 JSON Schema。

text.format.strict

boolean

是否严格遵循 JSON Schema。

tools

object[]

模型在生成响应时可调用的工具，包括 function、web_search、file_search、code_interpreter、computer、MCP 等。

Hide child attributes

tools.type

string

工具类型。

tools.name

string

函数或工具名称。

tools.description

string

工具用途说明。

tools.parameters

object

函数输入参数的 JSON Schema。

tools.strict

boolean

函数参数是否严格遵循 Schema。

tools.output_schema

object

函数输出的 JSON Schema。

tools.vector_store_ids

string[]

file_search 使用的向量存储 ID 列表。

tools.filters

any

file_search 的筛选条件。

tools.container

any

code_interpreter 容器配置。

tools.server_label

string

MCP 服务器标签。

tools.server_url

string

MCP 服务器 URL。

tool_choice

控制模型如何选择工具。

可用选项:

none,

auto,

required

top_logprobs

integer

每个输出位置最多返回的高概率词元数量。

必填范围: 0 <= x <= 20

truncation

enum<string>

已弃用。输入超出上下文窗口时的截断策略。

可用选项:

auto,

disabled

user

string

已弃用，请使用 safety_identifier 和 prompt_cache_key。

context_management

object[]

上下文管理配置。

Hide child attributes

context_management.type

string

上下文管理策略类型。

context_management.compact_threshold

integer

触发压缩的阈值。

响应

200 - application/json

string

必填

Response 的唯一 ID。

object

enum<string>

必填

对象类型，固定为 response。

可用选项:

response

created_at

integer

必填

Response 创建时间的 Unix 时间戳，单位为秒。

model

string

必填

实际使用的模型 ID。

output

object[]

必填

模型生成的输出项列表，顺序和数量取决于模型响应。

Hide child attributes

output.id

string

输出项 ID。

output.type

enum<string>

输出项类型。

可用选项:

message,

function_call,

custom_tool_call,

reasoning,

web_search_call,

file_search_call,

code_interpreter_call,

computer_call,

image_generation_call

output.status

string

输出项状态。

output.role

enum<string>

message 输出项的角色。

可用选项:

assistant

output.content

object[]

message 输出项的内容块。

Hide child attributes

output.content.type

enum<string>

内容块类型。

可用选项:

output_text,

refusal,

summary_text

output.content.text

string

output_text 或 summary_text 的文本。

output.content.refusal

string

模型拒绝说明。

output.content.annotations

object[]

文本注释，例如文件引用或 URL 引用。

Hide child attributes

output.content.annotations.type

string

注释类型。

output.content.annotations.file_id

string

被引用文件的 ID。

output.content.annotations.filename

string

被引用文件名。

output.content.annotations.url

string

被引用 URL。

output.content.annotations.title

string

引用标题。

output.content.annotations.start_index

integer

引用起始字符位置。

output.content.annotations.end_index

integer

引用结束字符位置。

output.content.logprobs

object[]

词元对数概率信息，仅在 include 请求该数据时返回。

Hide child attributes

output.content.logprobs.token

string

output.content.logprobs.bytes

integer[]

output.content.logprobs.logprob

number

output.content.logprobs.top_logprobs

string[]

output.call_id

string

函数或工具调用 ID。

output.name

string

被调用函数或自定义工具名称。

output.arguments

string

JSON 字符串形式的函数调用参数。

output.input

string

自定义工具调用输入。

output.encrypted_content

string

加密的推理内容；需通过 include 请求。

output.summary

string[]

推理摘要内容。

completed_at

integer

Response 完成时间的 Unix 时间戳；仅 status 为 completed 时出现。

status

enum<string>

响应生成状态。

可用选项:

completed,

failed,

in_progress,

cancelled,

queued,

incomplete

output_text

string

SDK 便捷字段：输出中所有文本内容的拼接结果。

error

object

生成失败时的错误对象。

Hide child attributes

error.code

string

错误代码。

error.message

string

错误说明。

incomplete_details

object

响应不完整的原因。

Hide child attributes

incomplete_details.reason

string

不完整原因，例如 max_output_tokens 或 content_filter。

instructions

应用于该响应的系统或开发者指令。

conversation

object

该响应所属的会话。

Hide child attributes

conversation.id

string

会话 ID。

previous_response_id

string

上一条 Response 的 ID。

metadata

object

关联元数据。

Hide child attributes

metadata.{key}

string

usage

object

词元使用统计。

Hide child attributes

usage.input_tokens

integer

输入词元数。

usage.output_tokens

integer

输出词元数。

usage.total_tokens

integer

总词元数。

usage.input_tokens_details

object

Hide child attributes

usage.input_tokens_details.cached_tokens

integer

命中缓存的输入词元数。

usage.output_tokens_details

object

Hide child attributes

usage.output_tokens_details.reasoning_tokens

integer

推理词元数。

parallel_tool_calls

boolean

是否允许并行工具调用。

temperature

number

本响应使用的采样温度。

top_p

number

本响应使用的核采样阈值。

max_output_tokens

integer

请求设置的最大输出词元数。

max_tool_calls

integer

请求设置的最大工具调用次数。

service_tier

string

实际使用的服务层级。

background

boolean

是否后台运行。

store

boolean

是否存储该响应。

safety_identifier

string

请求使用的安全标识符。

对话补全

图片生成

视频生成

向量嵌入

语音转写

授权

请求体

响应