---
title: "Create Response"
method: POST
path: "/v1/responses"
---

# Create Response

`POST /v1/responses`

## Request body

- object
  - `top_logprobs` integer
  - `top_k` union
    - number
    - unknown
  - `temperature` union
    - number
    - unknown
  - `top_p` union
    - number
    - unknown
  - `user` string
  - `safety_identifier` string
  - `prompt_cache_key` string
  - `service_tier` union
    - 'auto' | 'default' | 'flex' | 'scale' | 'priority'
    - unknown
  - `model` union
    - string
    - string
    - string
  - `reasoning` union
    - object
      - `effort` union
        - 'minimal' | 'low' | 'medium' | 'high'
        - unknown
      - `summary` union
        - 'auto' | 'concise' | 'detailed'
        - unknown
      - `generate_summary` union
        - 'auto' | 'concise' | 'detailed'
        - unknown
    - unknown
  - `reasoning_options` object
    - `budget_tokens` integer
  - `max_output_tokens` union
    - number
    - unknown
  - `max_tool_calls` union
    - number
    - unknown
  - `text` object
    - `format` union
      - object
        - `type` 'text', required
      - object
        - `type` 'json_schema', required
        - `description` string
        - `name` string, required
        - `schema` object, required
        - `strict` union
          - boolean
          - unknown
      - object
        - `type` 'json_object', required
    - `verbosity` union
      - 'low' | 'medium' | 'high'
      - unknown
  - `tools` union[]
    - union
      - object
        - `type` 'function'
        - `name` string, required
        - `description` union
          - string
          - unknown
        - `parameters` union, required
          - object
          - unknown
        - `strict` union
          - boolean
          - unknown
      - object
        - `type` 'mcp', required
        - `server_label` string, required
        - `server_url` string
        - `connector_id` 'connector_dropbox' | 'connector_gmail' | 'connector_googlecalendar' | 'connector_googledrive' | 'connector_microsoftteams' | 'connector_outlookcalendar' | 'connector_outlookemail' | 'connector_sharepoint'
        - `authorization` string
        - `server_description` string
        - `headers` union
          - object
          - unknown
        - `allowed_tools` union
          - string[]
          - object
            - `tool_names` string[]
            - `read_only` boolean
          - unknown
        - `require_approval` union
          - object
            - `always` object
              - …
            - `never` object
              - …
          - 'always' | 'never'
          - unknown
      - object
        - `type` 'code_interpreter', required
        - `container` union, required
          - string
          - object
            - `type` 'auto'
            - `file_ids` string[]
      - object
        - `type` 'image_generation', required
        - `model` 'gpt-image-1' | 'gpt-image-1-mini'
        - `quality` 'low' | 'medium' | 'high' | 'auto'
        - `size` '1024x1024' | '1024x1536' | '1536x1024' | 'auto'
        - `output_format` 'png' | 'webp' | 'jpeg'
        - `output_compression` integer
        - `moderation` 'auto' | 'low'
        - `background` 'transparent' | 'opaque' | 'auto'
        - `input_fidelity` union
          - 'high' | 'low'
          - unknown
        - `input_image_mask` object
          - `image_url` string
          - `file_id` string
        - `partial_images` integer
      - object
        - `type` 'web_search' | 'web_search_2025_08_26', required
        - `filters` object
          - `allowed_domains` string[]
        - `search_context_size` 'low' | 'medium' | 'high'
        - `user_location` object
          - `city` string
          - `country` string
          - `region` string
          - `timezone` string
          - `type` 'approximate'
      - object
        - `type` 'custom'
        - `name` string, required
        - `description` string
        - `format` union
          - object
            - `type` 'text'
          - object
            - `type` 'grammar'
            - `syntax` 'lark' | 'regex', required
            - `definition` string, required
  - `tool_choice` union
    - 'none' | 'auto' | 'required'
    - object
      - `type` 'allowed_tools', required
      - `mode` 'auto' | 'required', required
      - `tools` object[], required
    - object
      - `type` 'image_generation' | 'web_search' | 'code_interpreter', required
    - object
      - `type` 'function', required
      - `name` string, required
    - object
      - `type` 'mcp', required
      - `server_label` string, required
      - `name` union
        - string
        - unknown
    - object
      - `type` 'custom', required
      - `name` string, required
  - `truncation` union
    - 'auto' | 'disabled'
    - unknown
  - `input` union
    - string
    - union[]
      - union
        - object
          - `role` 'user' | 'assistant' | 'system' | 'developer', required
          - `content` union, required
            - string
            - union[]
              - …
          - `type` 'message'
        - object
          - `type` 'message'
          - `role` 'user' | 'system' | 'developer', required
          - `status` 'in_progress' | 'completed' | 'incomplete'
          - `content` union[], required
            - union
              - …
        - object
          - `id` string, required
          - `type` 'message', required
          - `role` 'assistant', required
          - `content` union[], required
            - union
              - …
          - `status` 'in_progress' | 'completed' | 'incomplete', required
        - object
          - `id` string
          - `type` 'function_call', required
          - `call_id` string, required
          - `name` string, required
          - `arguments` string, required
          - `status` 'in_progress' | 'completed' | 'incomplete'
        - object
          - `id` union
            - string
            - unknown
          - `call_id` string, required
          - `type` 'function_call_output'
          - `output` union, required
            - string
            - union[]
              - …
          - `status` union
            - 'in_progress' | 'completed' | 'incomplete'
            - unknown
        - object
          - `type` 'reasoning', required
          - `id` string, required
          - `encrypted_content` union
            - string
            - unknown
          - `summary` object[], required
            - `type` 'summary_text'
            - `text` string, required
          - `content` object[]
            - `type` 'reasoning_text'
            - `text` string, required
          - `status` 'in_progress' | 'completed' | 'incomplete'
        - object
          - `type` 'image_generation_call', required
          - `id` string, required
          - `status` 'in_progress' | 'completed' | 'generating' | 'failed', required
          - `result` union, required
            - string
            - unknown
        - object
          - `type` 'code_interpreter_call'
          - `id` string, required
          - `status` 'in_progress' | 'completed' | 'incomplete' | 'interpreting' | 'failed', required
          - `container_id` string, required
          - `code` union, required
            - string
            - unknown
          - `outputs` union, required
            - union[]
              - …
            - unknown
        - object
          - `type` 'mcp_list_tools', required
          - `id` string, required
          - `server_label` string, required
          - `tools` object[], required
            - `name` string, required
            - `description` union
              - …
            - `input_schema` object, required
            - `annotations` union
              - …
          - `error` union
            - string
            - unknown
        - object
          - `type` 'mcp_approval_request', required
          - `id` string, required
          - `server_label` string, required
          - `name` string, required
          - `arguments` string, required
        - object
          - `type` 'mcp_approval_response', required
          - `id` union
            - string
            - unknown
          - `approval_request_id` string, required
          - `approve` boolean, required
          - `reason` union
            - string
            - unknown
        - object
          - `type` 'mcp_call', required
          - `id` string, required
          - `server_label` string, required
          - `name` string, required
          - `arguments` string, required
          - `output` union
            - string
            - unknown
          - `error` union
            - string
            - unknown
          - `status` 'in_progress' | 'completed' | 'incomplete' | 'calling' | 'failed'
          - `approval_request_id` union
            - string
            - unknown
        - object
          - `type` 'custom_tool_call_output', required
          - `id` string
          - `call_id` string, required
          - `output` union, required
            - string
            - union[]
              - …
        - object
          - `type` 'custom_tool_call', required
          - `id` string
          - `call_id` string, required
          - `name` string, required
          - `input` string, required
        - object
          - `type` union
            - 'item_reference'
            - unknown
          - `id` string, required
  - `include` union
    - string[]
    - unknown
  - `parallel_tool_calls` union
    - boolean
    - unknown
  - `instructions` union
    - string
    - unknown
  - `stream` union
    - boolean
    - unknown
  - `stream_options` union
    - object
      - `include_obfuscation` boolean
    - unknown
  - `context_editing` object
    - `enabled` boolean, required
    - `clear_tool_uses` object
      - `trigger` integer
      - `keep` integer
      - `clear_at_least` integer
      - `exclude_tools` string[]
      - `clear_tool_inputs` boolean
    - `clear_thinking` object
      - `keep` union
        - integer
        - 'all'
  - `image_generation` object
    - `aspect_ratio` string, required
    - `image_size` string, required

## Response `200`

Request accepted

---

[API](https://skmtc.net/helicone/apis/helicone-ai-gateway-api.md) · [All operations](https://skmtc.net/helicone/apis/helicone-ai-gateway-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helicone/helicone-ai-gateway-api/versions/921a3ac63a09/schema)