Responses

POST https://api.tikway.ai/v1/responses

cURL

Text input

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."
        }
      ]
    }
  ]
}
'

200

"{\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}"

Authorizations

Authorization · string · header · required

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

Body

application/json

model · string

The model ID used to generate the response, such as gpt-5.6-sol.

input · string object[]

Text, image, audio, or file input provided to the model. It can be a string directly or an array of input messages.

instructions · string | null

System or developer directive that inserts into the model context. When using previous_response_id, instructions from the previous response are not automatically inherited.

previous_response_id · string | null

The unique ID of the previous Response, used for multi-turn conversations; cannot be used at the same time as conversation.

conversation · string object

The session to which this response belongs. Session items are automatically added to this context, and input and output items are also written to the session.

background · boolean | null

Whether to run model responses in the background.

include · enum<string>[] | null

Specifies additional data that needs to be included in the response.

Available options: 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 | null

The maximum number of tokens allowed in the generated response, including visible output and inference tokens.

Required range: x >= 1

max_tool_calls · integer | null

The maximum number of total built-in tool calls that can be processed in a response.

Required range: x >= 0

metadata · object | null

Up to 16 key-value pair metadata; keys can be up to 64 characters and values can be up to 512 characters.

Hide child attributes

metadata. {key} · string

Maximum string length: 512

moderation · object | null

Configuration to perform auditing on request input and build output.

Hide child attributes

moderation. model · string

Audit model ID, such as omni-moderation-latest.

moderation. policy · object | null

Input and output audit policies.

Hide child attributes

moderation.policy. input · object | null

Hide child attributes

moderation.policy.input. mode · enum<string>

Available options: score, block

moderation.policy. output · object | null

Hide child attributes

moderation.policy.output. mode · enum<string>

Available options: score, block

parallel_tool_calls · boolean | null

Whether to allow models to call tools in parallel.

prompt · object | null

Prompt word template and its variables.

Hide child attributes

prompt. id · string

Prompt word template ID.

prompt. version · string

Template version.

prompt. variables · object

Template variables.

prompt_cache_key · string | null

Stable key used to improve cache hit rate for similar requests; replaces user field.

prompt_cache_options · object

Prompt word caching options.

Hide child attributes

prompt_cache_options. mode · enum<string>

Cache breakpoint mode. explicit turns off implicit breakpoints.

Available options: implicit, explicit

prompt_cache_options. ttl · enum<string>

The minimum cache validity period.

Available options: 30m

prompt_cache_options. comparison_response_id · string | null

Comparison response ID used to diagnose cache reuse.

prompt_cache_options. prewarm · boolean

Only warms up the prompt word cache and does not generate output.

prompt_cache_retention · enum<string> | null

Deprecated, use prompt_cache_options.ttl.

Available options: in_memory, 24h

reasoning · object | null

Inference model configuration.

Hide child attributes

reasoning. effort · enum<string>

Reasoning strength.

Available options: none, minimal, low, medium, high, xhigh, max

reasoning. summary · enum<string>

Reasoning summary level.

Available options: auto, concise, detailed

reasoning. generate_summary · enum<string> · deprecated

Inference summary generation settings.

Available options: auto, concise, detailed

reasoning. context · enum<string>

Inference context settings.

Available options: auto, current_turn, all_turns

reasoning. mode · string

Speculative execution mode, common values are standard or pro.

safety_identifier · string | null

A stable end-user identifier to assist in detecting abuse; it is recommended to use a hash of the username or email address.

Maximum string length: 64

service_tier · enum<string> | null

The requested service level.

Available options: auto, default, flex, scale, priority, fast, ultrafast

store · boolean | null

Whether to store the generated Response for subsequent retrieval through the API.

stream · boolean | null

Whether to return events as SSE streaming.

stream_options · object | null

Streaming option, only set when stream is true.

Hide child attributes

stream_options. include_obfuscation · boolean

Whether to include obfuscated fields for streaming events.

temperature · number | null

Sampling temperature; usually adjusted with top_p alternatively.

Required range: 0 <= x <= 2

top_p · number | null

Kernel sampling threshold; usually adjusted alternatively with temperature.

Required range: 0 <= x <= 1

text · object

Text or structured JSON output configuration.

Hide child attributes

text. verbosity · enum<string> | null

Text output verbosity.

Available options: low, medium, high

text. format · object

Text output format.

Option 1

Option 2

Option 3

Hide child attributes

text.format. type · enum<string> · required

Available options: text

tools · object[]

Tools that the model can call when generating responses, including function, web_search, file_search, code_interpreter, computer, MCP, etc.

Hide child attributes

tools. type · string

Tool type.

tools. name · string

Function or tool name.

tools. description · string

Description of tool usage.

tools. parameters · object

JSON Schema of function input parameters.

tools. strict · boolean

Whether the function parameters strictly follow the Schema.

tools. output_schema · object

JSON Schema of function output.

tools. vector_store_ids · string[]

The vector used by file_search stores a list of IDs.

tools. filters · any

Filter conditions for file_search.

tools. container · any

code_interpreter container configuration.

tools. server_label · string

MCP server label.

tools. server_url · string

MCP server URL.

tool_choice · enum<string> object

Controls how the model selects tools.

Available options: none, auto, required

top_logprobs · integer | null

The maximum number of high-probability tokens returned for each output position.

Required range: 0 <= x <= 20

truncation · enum<string> | null

Deprecated. The truncation strategy for input when it exceeds the context window.

Available options: auto, disabled

user · string

Deprecated, use safety_identifier and prompt_cache_key.

context_management · object[] | null

Context management configuration.

Hide child attributes

context_management. type · string

Context management policy type.

context_management. compact_threshold · integer

The threshold that triggers compression.

access_programs · object

Request a domain access plan to use.

Hide child attributes

access_programs. cyber · enum<string>

Available options: standard, daybreak_blue, daybreak_red

Response

200 - application/json

id · string · required

The unique ID of the Response.

object · enum<string> · required

Object type, fixed to response.

Available options: response

created_at · integer · required

Unix timestamp of the creation time of the Response, in seconds.

model · string · required

The actual model ID used.

output · object[] · required

A list of outputs generated by the model, the order and number of which depends on the model response.

Hide child attributes

output. id · string

Output item ID.

output. type · enum<string>

Output item type.

Available options: 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 item status.

output. role · enum<string>

message The role of the output item.

Available options: assistant

output. content · object[]

message The content block of the output item.

Hide child attributes

output.content. type · enum<string>

Content block type.

Available options: output_text, refusal, summary_text

output.content. text · string

The text of output_text or summary_text.

output.content. refusal · string

Model rejects explanation.

output.content. annotations · object[]

Text annotations, such as file references or URL references.

Hide child attributes

output.content.annotations. type · string

Annotation type.

output.content.annotations. file_id · string

The ID of the referenced file.

output.content.annotations. filename · string

The name of the referenced file.

output.content.annotations. url · string

The referenced URL.

output.content.annotations. title · string

Quote title.

output.content.annotations. start_index · integer

Reference starting character position.

output.content.annotations. end_index · integer

The end character position of the quote.

output.content. logprobs · object[]

Token log probability information, returned only when include requests this data.

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

Function or tool call ID.

output. name · string

The called function or custom tool name.

output. arguments · string

Function call parameters in JSON string form.

output. input · string

Custom tool call input.

output. encrypted_content · string

Encrypted inference content; required via include request.

output. summary · string[]

Reasoning summary content.

completed_at · integer

Unix timestamp of response completion time; only appears if status is completed.

status · enum<string>

Response build status.

Available options: completed, failed, in_progress, cancelled, queued, incomplete

output_text · string

SDK convenience field: The concatenation of all text content in the output.

error · object

Error object when generation fails.

Hide child attributes

error. code · string

error code.

error. message · string

Error description.

incomplete_details · object

Reason for incomplete response.

Hide child attributes

incomplete_details. reason · string

Incomplete reasons such as max_output_tokens or content_filter.

instructions · string string[]

The system or developer directive that applies to this response.

conversation · object

The session to which this response belongs.

Hide child attributes

conversation. id · string

Session ID.

previous_response_id · string

The ID of the previous Response.

metadata · object

Associated metadata.

Hide child attributes

metadata. {key} · string

usage · object

Word usage statistics.

Hide child attributes

usage. input_tokens · integer

Enter the number of tokens.

usage. output_tokens · integer

Output the number of tokens.

usage. total_tokens · integer

The total number of tokens.

usage. input_tokens_details · object

Hide child attributes

usage.input_tokens_details. cached_tokens · integer

The number of input tokens that hit the cache.

usage. output_tokens_details · object

Hide child attributes

usage.output_tokens_details. reasoning_tokens · integer

Reasoning about the number of tokens.

parallel_tool_calls · boolean

Whether to allow parallel tool calls.

temperature · number

The sampling temperature used by this response.

top_p · number

The kernel sampling threshold used by this response.

max_output_tokens · integer

The maximum number of output tokens requested.

max_tool_calls · integer

The maximum number of tool calls requested to be set.

service_tier · string

The actual service level used.

background · boolean

Whether to run in the background.

store · boolean

Whether to store the response.

safety_identifier · string

The security identifier requested to be used.