88API88API
Руководство пользователяAI-приложенияAPIПомощь и поддержка
Чат (Chat)

Формат ответа OpenAI (Ответы)

Официальная документация

📝 Введение

Самый продвинутый интерфейс ответа модели OpenAI. Поддерживает ввод текста и изображений, а также вывод текста. Создайте взаимодействие с моделью с отслеживанием состояния, используя выходные данные предыдущих ответов в качестве входных данных. Возможность расширения модели с помощью встроенных инструментов, таких как поиск файлов, поиск в Интернете, использование компьютера и многое другое. Используйте вызовы функций, чтобы предоставить моделям доступ к внешним системам и данным.

Соответствующие руководства можно найти на официальном сайте OpenAI: Ответы

💡 Пример запроса

Базовый текстовый ответ ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "input": "讲一个三句话的关于独角兽的睡前故事。"
  }'

Пример ответа:

{
  "id": "resp_67ccd2bed1ec8190b14f964abc0542670bb6a6b452d3795b",
  "object": "response",
  "created_at": 1741476542,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-5.5",
  "output": [
    {
      "type": "message",
      "id": "msg_67ccd2bf17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "在一个宁静的月夜下,一只名叫璐米娜的独角兽发现了一个倒映着星星的隐藏水池。当她将独角浸入水中时,水池开始闪烁,显现出通往一个有着无尽夜空的魔法世界的路径。充满好奇,璐米娜为所有做梦的人许下愿望,希望他们能找到自己的隐藏魔法,当她回头望去,她的蹄印像星尘一样闪烁。",
          "annotations": []
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 36,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 87,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 123
  },
  "user": null,
  "metadata": {}
}

Ответ на анализ изображения ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "input": [
      {
        "role": "user",
        "content": [
          {"type": "input_text", "text": "Опишите, что изображено на этом изображении"},
          {
            "type": "input_image",
            "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg"
          }
        ]
      }
    ]
  }'

Пример ответа:

{
  "id": "resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41",
  "object": "response",
  "created_at": 1741476777,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-5.5",
  "output": [
    {
      "type": "message",
      "id": "msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "这张图片展示了一条木制栈道或小径穿过茂密的绿色草地,上方是点缀着几朵云的蓝天。场景呈现出一个宁静的自然区域,可能是公园或自然保护区。背景中有树木和灌木丛。整个景观展现出和谐的自然环境,栈道为游客提供了一条穿过湿地或草原而不影响周围生态系统的路径。",
          "annotations": []
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 328,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 52,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 380
  },
  "user": null,
  "metadata": {}
}

Инструмент поиска в Интернете ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "tools": [{ "type": "web_search_preview" }],
    "input": "Какие позитивные новости сегодня??"
  }'

Пример ответа:

{
  "id": "resp_67ccf18ef5fc8190b16dbee19bc54e5f087bb177ab789d5c",
  "object": "response",
  "created_at": 1741484430,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-5.5",
  "output": [
    {
      "type": "web_search_call",
      "id": "ws_67ccf18f64008190a39b619f4c8455ef087bb177ab789d5c",
      "status": "completed"
    },
    {
      "type": "message",
      "id": "msg_67ccf190ca3881909d433c50b1f6357e087bb177ab789d5c",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "截至今天,2025年3月9日,一则值得关注的积极新闻是中国科学家在可再生能源领域取得重大突破,成功研发出一种新型高效太阳能电池,转化率达到了创纪录的35%,这可能会极大推动清洁能源的普及和应用。这项技术预计将使太阳能发电成本降低约40%,为全球减少碳排放提供了新的解决方案。",
          "annotations": [
            {
              "type": "url_citation",
              "start_index": 42,
              "end_index": 100,
              "url": "https://example.com/renewable-energy-breakthrough/?utm_source=chatgpt.com",
              "title": "Китайские учёные совершили крупный прорыв в области возобновляемой энергетики"
            },
            {
              "type": "url_citation",
              "start_index": 101,
              "end_index": 150,
              "url": "https://example.com/solar-cell-efficiency-record/?utm_source=chatgpt.com",
              "title": "Новый высокоэффективный солнечный элемент установил рекорд конверсии"
            },
            {
              "type": "url_citation",
              "start_index": 151,
              "end_index": 200,
              "url": "https://example.com/clean-energy-cost-reduction/?utm_source=chatgpt.com",
              "title": "Затраты на производство солнечной энергии, как ожидается, снизятся40%"
            }
          ]
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [
    {
      "type": "web_search_preview",
      "domains": [],
      "search_context_size": "medium",
      "user_location": {
        "type": "approximate",
        "city": null,
        "country": "US",
        "region": null,
        "timezone": null
      }
    }
  ],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 328,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 356,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 684
  },
  "user": null,
  "metadata": {}
}

Инструмент поиска файлов ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "tools": [{
      "type": "file_search",
      "vector_store_ids": ["vs_1234567890"],
      "max_num_results": 20
    }],
    "input": "Каковы характеристики и атрибуты древнего коричневого дракона??"
  }'

Пример ответа:

{
  "id": "resp_67ccf4c55fc48190b71bd0463ad3306d09504fb6872380d7",
  "object": "response",
  "created_at": 1741485253,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-5.5",
  "output": [
    {
      "type": "file_search_call",
      "id": "fs_67ccf4c63cd08190887ef6464ba5681609504fb6872380d7",
      "status": "completed",
      "queries": ["Характеристики и свойства древнего бурого дракона"],
      "results": null
    },
    {
      "type": "message",
      "id": "msg_67ccf4c93e5c81909d595b369351a9d309504fb6872380d7",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "根据资料,古代棕龙具有以下特性和属性:\n\n1. 物理特征:古代棕龙体型庞大,体长可达25-30米,翼展约35米。它们的鳞片呈深棕色至铜色,随着年龄增长会变得更加暗沉。头部有特征性的双角和脊刺,下颚强壮,适合撕裂猎物。\n\n2. 能力:它们能喷吐强力的酸液,对目标造成严重腐蚀伤害。古代棕龙还拥有出色的掘地能力,常在沙漠或山地挖掘复杂的巢穴系统。\n\n3. 智力:被认为是龙族中最为狡猾和有耐心的品种,智力极高,精通多种语言,并具有复杂的战术思维。\n\n4. 栖息地:主要栖息在干旱的山地和沙漠地区,喜欢炎热干燥的环境。\n\n5. 宝藏:古代棕龙以其庞大的宝藏闻名,特别喜爱收集铜币、红宝石和火焰魔法物品。\n\n6. 寿命:是所有龙种中寿命最长的之一,可活2000-2500年,随着年龄增长其力量和魔法能力也会增强。\n\n7. 性格:极度领地意识强,性格暴躁易怒,对侵入者毫不留情,但也以其罕见的耐心著称,能为复仇等待几个世纪。",
          "annotations": [
            {
              "type": "file_citation",
              "index": 80,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 233,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 345,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 420,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 520,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 580,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 655,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            },
            {
              "type": "file_citation",
              "index": 781,
              "file_id": "file-4wDz5b167pAf72nx1h9eiN",
              "filename": "dragons.pdf"
            }
          ]
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [
    {
      "type": "file_search",
      "filters": null,
      "max_num_results": 20,
      "ranking_options": {
        "ranker": "auto",
        "score_threshold": 0.0
      },
      "vector_store_ids": ["vs_1234567890"]
    }
  ],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 18307,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 348,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 18655
  },
  "user": null,
  "metadata": {}
}

Ответ в потоковом режиме ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "instructions": "你是一个有帮助的助手。",
    "input": "你好!",
    "stream": true
  }'

Пример ответа потоковой передачи:

event: response.created
data: {"type":"response.created","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"你是一个有帮助的助手。","max_output_tokens":null,"model":"gpt-5.5","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}

event: response.in_progress
data: {"type":"response.in_progress","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"in_progress","error":null,"incomplete_details":null,"instructions":"你是一个有帮助的助手。","max_output_tokens":null,"model":"gpt-5.5","output":[],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}}

event: response.output_item.added
data: {"type":"response.output_item.added","output_index":0,"item":{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"in_progress","role":"assistant","content":[]}}

event: response.content_part.added
data: {"type":"response.content_part.added","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"part":{"type":"output_text","text":"","annotations":[]}}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"Привет"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"!"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":" я"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"способный"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"для"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"ты"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"поставлять"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"Что"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"помощь"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"?"}

event: response.output_text.delta
data: {"type":"response.output_text.delta","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"delta":"?"}

event: response.output_text.done
data: {"type":"response.output_text.done","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"text":"你好! 我能为您提供什么帮助吗?"}

event: response.content_part.done
data: {"type":"response.content_part.done","item_id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","output_index":0,"content_index":0,"part":{"type":"output_text","text":"你好! 我能为您提供什么帮助吗?","annotations":[]}}

event: response.output_item.done
data: {"type":"response.output_item.done","output_index":0,"item":{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"你好! 我能为您提供什么帮助吗?","annotations":[]}]}}

event: response.completed
data: {"type":"response.completed","response":{"id":"resp_67c9fdcecf488190bdd9a0409de3a1ec07b8b0ad4e5eb654","object":"response","created_at":1741290958,"status":"completed","error":null,"incomplete_details":null,"instructions":"你是一个有帮助的助手。","max_output_tokens":null,"model":"gpt-5.5","output":[{"id":"msg_67c9fdcf37fc8190ba82116e33fb28c507b8b0ad4e5eb654","type":"message","status":"completed","role":"assistant","content":[{"type":"output_text","text":"你好! 我能为您提供什么帮助吗?","annotations":[]}]}],"parallel_tool_calls":true,"previous_response_id":null,"reasoning":{"effort":null,"summary":null},"store":true,"temperature":1.0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":37,"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":48},"user":null,"metadata":{}}}

Вызов функции ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "input": "波士顿今天的天气如何?",
    "tools": [
      {
        "type": "function",
        "name": "get_current_weather",
        "description": "Получить текущую погоду для указанного места",
        "parameters": {
          "type": "object",
          "properties": {
            "location": {
              "type": "string",
              "description": "城市和州,例如 San Francisco, CA"
            },
            "unit": {
              "type": "string",
              "enum": ["celsius", "fahrenheit"]
            }
          },
          "required": ["location", "unit"]
        }
      }
    ],
    "tool_choice": "auto"
  }'

Пример ответа:

{
  "id": "resp_67ca09c5efe0819096d0511c92b8c890096610f474011cc0",
  "object": "response",
  "created_at": 1741294021,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-5.5",
  "output": [
    {
      "type": "function_call",
      "id": "fc_67ca09c6bedc8190a7abfec07b1a1332096610f474011cc0",
      "call_id": "call_unLAR8MvFNptuiZK6K6HCy5k",
      "name": "get_current_weather",
      "arguments": "{\"location\":\"Бостон, MA\",\"unit\":\"celsius\"}",
      "status": "completed"
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [
    {
      "type": "function",
      "description": "Получить текущую погоду для указанного места",
      "name": "get_current_weather",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "城市和州,例如 San Francisco, CA"
          },
          "unit": {
            "type": "string",
            "enum": ["celsius", "fahrenheit"]
          }
        },
        "required": ["location", "unit"]
      },
      "strict": true
    }
  ],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 291,
    "output_tokens": 23,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 314
  },
  "user": null,
  "metadata": {}
}

Способность рассуждать ✅

curl https://api.88api.ai/v1/responses \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "model": "gpt-5.5",
    "input": "Сколько древесины может клевать дятел??",
    "reasoning": {
      "effort": "high"
    }
  }'

Пример ответа:

{
  "id": "resp_67ccd7eca01881908ff0b5146584e408072912b2993db808",
  "object": "response",
  "created_at": 1741477868,
  "status": "completed",
  "error": null,
  "incomplete_details": null,
  "instructions": null,
  "max_output_tokens": null,
  "model": "gpt-5.5",
  "output": [
    {
      "type": "message",
      "id": "msg_67ccd7f7b5848190a6f3e95d809f6b44072912b2993db808",
      "status": "completed",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "这是一个源自英文绕口令"How much wood would a woodchuck chuck if a woodchuck could chuck wood"的问题。在现实中,啄木鸟(woodpecker)和土拨鼠(woodchuck)是不同的动物,而且土拨鼠实际上并不"啄(chuck)"木头。\n\n从科学角度看,啄木鸟每天确实会啄树木以寻找食物、建造巢穴或进行通讯。一只啄木鸟平均每天可能啄树约8000-12000次,视物种和具体目的而定。如果我们将这转换为木材量,假设每次啄击移除约0.1-0.2立方厘米的木材,那么一只啄木鸟理论上每天可能移除约800-2400立方厘米的木材。\n\n然而,啄木鸟主要是为了觅食和筑巢而啄木,而不是单纯地移除木材,所以这个计算只是一个有趣的理论估算。",
          "annotations": []
        }
      ]
    }
  ],
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": "high",
    "summary": null
  },
  "store": true,
  "temperature": 1.0,
  "text": {
    "format": {
      "type": "text"
    }
  },
  "tool_choice": "auto",
  "tools": [],
  "top_p": 1.0,
  "truncation": "disabled",
  "usage": {
    "input_tokens": 81,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 1035,
    "output_tokens_details": {
      "reasoning_tokens": 832
    },
    "total_tokens": 1116
  },
  "user": null,
  "metadata": {}
}

📮 Запрос

Конечная точка

POST /v1/responses

Создайте модель ответов. Предоставьте ввод текста или изображения для создания текста или вывода в формате JSON. Позвольте модели вызывать ваш собственный код или используйте встроенные инструменты, такие как веб-поиск или поиск файлов, чтобы использовать ваши собственные данные в качестве входных данных для ответа модели.

Метод аутентификации

Включите в заголовок запроса для аутентификации ключа API следующее:

Authorization: Bearer $API_KEY

Где $API_KEY — ваш ключ API.

Параметры тела запроса

input

Тип: строка или массив. Обязательно: Да

Ввод текста, изображения или файла, предоставляемый модели для генерации ответа.

Возможные типы
ТипОписание
СтрокаВвод текста, эквивалентный вводу текста с ролью пользователя
массив входовСписок из одного или нескольких входов, содержащих разные типы контента
Входной объект сообщения
СвойствоТипОбязательноОписание
contentСтрока или массивДаТекст, изображение или аудиовход, предоставляемый модели для генерации ответа. Также может включать предыдущие ответы помощника
roleстрокадаРоль входного сообщения. Необязательные значения: user, assistant, system или developer
typeСтрокаНетТип входного сообщения, всегда message
Тип элемента контента
Ввод текста
СвойствоТипОбязательноОписание
textстрокадаввод текста, предоставленный модели
typeстрокадаТип входа, всегда input_text
Ввод изображения
СвойствоТипОбязательноОписание
detailстрокадаУровень детализации изображения для отправки в модель. Необязательные значения: high, low или auto. По умолчанию — auto
typeстрокадаТип входа, всегда input_image
file_idСтрокаНетИдентификатор файла для отправки в модель
image_urlСтрокаНетURL-адрес изображения для отправки в модель. Может быть полным URL-адресом или изображением в кодировке Base64 в URL-адресе данных
Ввод файла
СвойствоТипОбязательноОписание
typeстрокадаТип входа, всегда input_file
file_dataСтрокаНетСодержимое файла для отправки модели
file_idСтрокаНетИдентификатор файла для отправки в модель
filenameСтрокаНетИмя файла для отправки в модель
Тип выходного элемента
Вывод текста
СвойствоТипОбязательноОписание
textстрокадатекстовый вывод, сгенерированный моделью
typeстрокадаТип выходного элемента, всегда output_text
annotationsмассивдааннотации для вывода текста
Тип комментария

Ссылка на документ:

СвойствоТипОбязательноОписание
file_idстрокадаID файла
indexцелое числодаИндекс файла в списке файлов
typeстрокадаТип ссылки на файл, всегда file_citation

URL-ссылка:

СвойствоТипОбязательноОписание
end_indexцелое числоДаИндекс последнего символа сообщения, на которое ссылается URL-адрес
start_indexцелое числоДаИндекс первого символа сообщения, на которое ссылается URL-адрес
titleСтрокаДаНазвание сетевого ресурса
typeстрокаДаТип ссылки URL, всегда url_citation
urlстрокадаURL сетевого ресурса

Путь к файлу:

СвойствоТипОбязательноОписание
file_idстрокадаID файла
indexцелое числодаИндекс файла в списке файлов
typeстрокадаТип пути к файлу, всегда file_path
Отказ от ответа
СвойствоТипОбязательноОписание
refusalстрокадаобъяснение отказа модели
typeстрокадаОтклоненный тип, всегда refusal
Тип вызова инструмента
Вызов инструмента поиска файлов
СвойствоТипОбязательноОписание
idстрокадауникальный идентификатор, который будет вызываться инструментом поиска файлов
queriesмассивдаЗапросы, используемые для поиска файлов
statusСтрокаДаСтатус вызова инструмента поиска файлов. Возможные значения: in_progress, searching, incomplete или failed
typeстрокадаТип, вызываемый инструментом поиска файлов, всегда file_search_call
resultsМассив или nullНетРезультаты вызова инструмента поиска файлов
Вызов инструмента поиска сети
СвойствоТипОбязательноОписание
idСтрокаДаУникальный идентификатор, вызываемый инструментом сетевого поиска
statusстрокадастатус вызова инструмента поиска сети
typeстрокадаТип, вызываемый инструментом сетевого поиска, всегда web_search_call
Вызов инструмента-функции
СвойствоТипОбязательноОписание
argumentsстрокаДаСтрока аргументов JSON, передаваемая функции
call_idСтрокаДаУникальный идентификатор вызова инструмента-функции, сгенерированный моделью
nameстрокадаИмя функции для запуска
typeстрокадаТип вызова функции, всегда function_call
idСтрокаНетУникальный идентификатор вызова инструмента-функции
statusСтрокаНетСтатус проекта. Возможные значения: in_progress, completed или incomplete
Вызов компьютерного инструмента
СвойствоТипОбязательноОписание
actionобъектэтооперации взаимодействия с компьютером, такие как щелчок, перетаскивание и т. д.
call_idстрокадаИдентификатор, используемый при ответе на вывод вызова инструмента
idстрокадауникальный идентификатор, называемый компьютером
pending_safety_checksмассивдаОжидаются проверки безопасности компьютерных звонков
statusСтрокаДаСтатус проекта. Возможные значения: in_progress, completed или incomplete
typeстрокадаТип компьютерного вызова, всегда computer_call

Тип работы компьютера:

Тип операцииОписание
clickоперация щелчка мыши
double_clickДвойной щелчок мышью
dragоперация перетаскивания
keypressключевая операция
moveоперация движения мыши
screenshotОперация снимка экрана
scrollоперация прокрутки
typeоперация ввода текста
waitДождитесь операции
Вывод вызова компьютерного инструмента
СвойствоТипОбязательноОписание
call_idстрокадаИдентификатор вызова компьютерного инструмента, выдавшего выходные данные
outputобъектэтоСкриншот компьютера для инструментов использования компьютера
typeстрокадаТип вывода вызова компьютерного инструмента, всегда computer_call_output
acknowledged_safety_checksМассивНетПроверки безопасности, сообщаемые API и подтвержденные разработчиком
idСтрокаНетВывод идентификатора при вызове компьютерного инструмента
statusСтрокаНетВведите статус сообщения. Возможные значения: in_progress, completed или incomplete
Вывод вызова инструмента-функции
СвойствоТипОбязательноОписание
call_idСтрокаДаУникальный идентификатор вызова инструмента-функции, сгенерированный моделью
outputстрокадаВывод строки JSON при вызове инструмента-функции
typeстрокадаТип вывода вызова функции, всегда function_call_output
idСтрокаНетВывод уникального идентификатора при вызове инструмента функции
statusСтрокаНетСтатус проекта. Возможные значения: in_progress, completed или incomplete
Элементы, связанные с выводом
СвойствоТипОбязательноОписание
idстрокаэтоуникальный идентификатор содержимого вывода
summaryмассивдатекстовое содержание вывода
typeстрокаДаТип объекта, всегда reasoning
encrypted_contentСтрока или nullНетЗашифрованное содержимое предполагаемого элемента, заполняемое при создании ответа с использованием параметра включения reasoning.encrypted_content
statusСтрокаНетСтатус проекта. Возможные значения: in_progress, completed или incomplete

Краткое изложение рассуждений:

СвойствоТипОбязательноОписание
textстрокадаКраткое изложение выводов, используемых моделью при формировании ответа
typeстрокаДаТип объекта, всегда summary_text
Справочник проекта
СвойствоТипОбязательноОписание
idстрокадаИдентификатор элемента для ссылки
typeстроканетТип ссылающегося проекта, всегда item_reference

model

Тип: строка Обязательно: Да

Идентификатор модели, используемый для создания ответа, например gpt-5.5. OpenAI предлагает множество моделей с различными возможностями, характеристиками производительности и ценой. См. руководство по моделям, чтобы просмотреть и сравнить доступные модели.

include

Тип: массив или null. Обязательно: Нет

Указывает дополнительные выходные данные для включения в ответ модели. В настоящее время поддерживаются следующие значения:

ценностьописание
file_search_call.resultsСодержит результаты поиска для вызовов инструментов поиска файлов
message.input_image.image_urlСодержит URL-адрес изображения во входном сообщении
computer_call_output.output.image_urlСодержит URL-адрес изображения в выводе компьютерного вызова
reasoning.encrypted_contentВключает зашифрованную версию токена вывода в выходные данные элемента вывода

instructions

Тип: строка или значение NULL. Обязательно: Нет

Вставьте сообщение системы (или разработчика) в качестве первого элемента в контексте модели.

При использовании с previous_response_id директивы предыдущего ответа не переносятся на следующий ответ. Это позволяет легко переключать системные (разработчикские) сообщения в новых ответах.

max_output_tokens

Тип: целое число или null. Обязательно: Нет

Верхний предел количества токенов, которые могут быть созданы для ответа, включая видимые выходные токены и токены вывода.

metadata

Тип: Объект Обязательно: Нет

Коллекция из 16 пар ключ-значение, которые можно прикрепить к объекту. Это полезно для хранения дополнительной информации об объекте в структурированном формате, а также для запроса объекта через API или панель мониторинга.

Ключи представляют собой строки длиной не более 64 символов. Значение представляет собой строку максимальной длиной 512 символов.

parallel_tool_calls

Тип: логическое значение или значение NULL. Обязательно: Нет Значение по умолчанию: true

Разрешить ли модели параллельный вызов инструментов.

previous_response_id

Тип: строка или значение NULL. Обязательно: Нет

Уникальный идентификатор предыдущего ответа модели. Используйте этот параметр для создания многоходового разговора. Узнайте больше о статусе разговора.

reasoning

Тип: объект или null. Обязательно: Нет Доступно только для моделей серии O.

Опции конфигурации для моделей вывода.

СвойствоТипОбязательноОписание
effortСтрока или nullНетУровень сложности рассуждений, необязательные значения: low, medium, high. Значение по умолчанию — medium. Сокращение усилий по выводу приводит к более быстрым ответам и уменьшению количества токенов, используемых для вывода в ответе
summaryСтрока или nullНетКраткое изложение вывода, выполненного моделью. Это полезно для отладки и понимания процесса вывода модели. Необязательные значения: auto, concise, detailed
generate_summaryСтрока или nullНетУСТАРЕЛО: вместо этого используйте summary. Краткое изложение выводов, выполненных моделью. Необязательные значения: auto, concise, detailed

service_tier

Тип: строка или значение NULL. Обязательно: Нет По умолчанию: автоматически

Указывает уровень задержки, используемый для обработки запросов. Этот параметр актуален для клиентов, подписанных на услугу уровня масштабирования:

ценностьописание
autoЕсли в проекте включен уровень масштабирования, кредиты уровня масштабирования будут использоваться до тех пор, пока не будут исчерпаны; если в проекте не включен уровень масштабирования, запросы будут обрабатываться с использованием уровня обслуживания по умолчанию, с меньшим временем бесперебойной работы SLA и без гарантий задержки
defaultЗапросы будут обрабатываться с использованием уровня служб по умолчанию с соглашением об уровне обслуживания с низким временем безотказной работы и отсутствием гарантий задержки
flexЗапрос будет обработан с использованием уровня службы Flex Processing. Для получения дополнительной информации обратитесь к официальной документации

Если этот параметр не установлен, поведение по умолчанию — auto.

Если этот параметр установлен, тело ответа будет содержать использованный service_tier.

store

Тип: логическое значение или значение NULL. Обязательно: Нет Значение по умолчанию: true

Сохранять ли сгенерированный ответ модели для последующего извлечения через API.

stream

Тип: логическое значение или значение NULL. Обязательно: Нет Значение по умолчанию: ложь

Если установлено значение true, данные ответа модели будут передаваться клиенту с использованием событий, отправленных сервером, при создании.

temperature

Тип: число или null. Обязательно: Нет По умолчанию: 1

Используемая температура выборки от 0 до 2. Более высокие значения (например, 0,8) делают выходные данные более случайными, а более низкие значения (например, 0,2) делают их более целенаправленными и детерминированными. Обычно мы рекомендуем изменить это значение или top_p, но не оба одновременно.

text

Тип: Объект Обязательно: Нет

Параметры конфигурации для текстовых ответов модели. Это может быть обычный текст или структурированные данные JSON.

СвойствоТипОбязательноОписание
formatОбъектНетУказывает формат, в котором должна быть выведена модель

Настройка { "type": "json_schema" } обеспечивает структурированный вывод, гарантируя, что модель будет соответствовать предоставленной вами схеме JSON. Дополнительную информацию см. в Руководстве по структурированному выводу.

Формат по умолчанию — { "type": "text" } без других опций.

Устаревший режим JSON (не рекомендуется): Установите значение { "type": "json_object" }, чтобы включить старый режим JSON и гарантировать, что сообщения, генерируемые моделью, являются допустимыми JSON. Для поддерживаемых моделей предпочтительным является json_schema.

Тип текстового формата
Текст
СвойствоТипОбязательноОписание
typeстрокаэтоопределенный тип формата ответа. Всегда text
Схема JSON
СвойствоТипОбязательноОписание
nameСтрокаДаИмя формата ответа. Должен содержать символы A–Z, A–Z, 0–9 или символы подчеркивания и тире. Максимальная длина — 64
schemaОбъектДаСхема формата ответа, описанная как объект схемы JSON
typeстрокаэтоопределенный тип формата ответа. Всегда json_schema
descriptionСтрокаНетОписание назначения формата ответа, используемого моделью для определения того, как отвечать в этом формате
strictЛогическое или нулевое значениеНетВключить ли строгое соблюдение режима при создании выходных данных. По умолчанию — false. Если установлено значение true, модель всегда будет следовать точной схеме, определенной в поле схемы. В строгом режиме поддерживается только часть схемы JSON
Объект JSON
СвойствоТипОбязательноОписание
typeстрокаэтоопределенный тип формата ответа. Всегда json_object

Примечание. Модель не будет генерировать JSON без системного или пользовательского сообщения, предписывающего модели сделать это. Для поддерживаемых моделей рекомендуется json_schema.

tool_choice

Тип: строка или объект. Обязательно: Нет

Как модель выбирает инструмент (или инструменты), который будет использоваться при генерации ответа. См. параметр tools, чтобы узнать, как указать инструменты, которые может вызывать модель.

Возможные типы
Режим выбора инструмента

Тип: строка

Определяет, вызывает ли модель инструменты и какие именно.

ценностьописание
noneМодель не вызывает никаких инструментов, но генерирует сообщение
autoМодель может выбирать между генерацией сообщения или вызовом одного или нескольких инструментов
requiredМодель должна вызывать один или несколько инструментов
Размещенный инструмент

Тип: Объект

Указывает, что модель должна использовать встроенные инструменты для генерации ответов.

СвойствоТипОбязательноОписание
typeстрокадаТип хост-инструмента, который должна использовать модель. Допустимые значения: file_search, web_search_preview, computer_use_preview
Функциональный инструмент

Тип: Объект

Используйте эту опцию, чтобы заставить модель вызывать определенную функцию.

СвойствоТипОбязательноОписание
nameстрокадаимя вызываемой функции
typeстрокадаДля вызовов функций всегда используйте тип function

tools

Тип: Массив Обязательно: Нет

Массив инструментов, которые модель может вызывать при генерации ответа. Вы можете указать, какой инструмент использовать, задав параметр tool_choice.

Для вашей модели можно использовать два типа инструментов:

  • Встроенные инструменты: инструменты, предоставляемые OpenAI для расширения возможностей модели, например поиск в Интернете или поиск файлов.
  • Вызовы функций (пользовательские инструменты): определенные вами функции, которые позволяют модели вызывать ваш собственный код.
Инструмент поиска файлов (Поиск файлов)

Тип: Объект

Инструмент для поиска соответствующего контента в загруженных файлах.

СвойствоТипОбязательноОписание
typeстрокадаТип инструмента поиска файлов, всегда file_search
vector_store_idsмассивдасписок идентификаторов векторных магазинов для поиска
filtersобъектнетприменить фильтр
max_num_resultsЦелое числоНетМаксимальное количество возвращаемых результатов. Это число должно быть от 1 до 50 (включительно)
ranking_optionsобъектнетварианты ранжирования поиска
Тип фильтра

Фильтр сравнения

СвойствоТипОбязательноОписание
keyстрокаэтоключ для сравнения значения с
typeстрокадаУказывает оператор сравнения: eq, ne, gt, gte, lt, lte
- eq: равно <br />- ne: не равно <br />- gt: больше, чем <br />- gte: больше или равно <br />- lt: меньше, чем <br />- lte: меньше или равно
valueстрока/число/логическое значениедаЗначение для сравнения с ключом свойства; поддерживает строковые, числовые и логические типы

Комплексный фильтр

СвойствоТипОбязательноОписание
filtersмассивэтомассив фильтров для объединения. Элементы могут быть фильтрами сравнения или составными фильтрами
typeстрокадатип операции: and или or
Варианты ранжирования
СвойствоТипОбязательноОписание
rankerстроканетРанкер для поиска файлов
score_thresholdНомерНетПорог оценки для поиска файлов — число от 0 до 1. Числа ближе к 1 будут пытаться вернуть только наиболее релевантные результаты, но могут возвращать меньше результатов
Инструмент «Функция» (Функция)

Тип: Объект

Определите функции в своем собственном коде, которые модель может дополнительно вызывать.

СвойствоТипОбязательноОписание
typeстрокадаТип функционального инструмента, всегда function
nameстрокадаимя вызываемой функции
parametersОбъектДаОбъект схемы JSON, описывающий параметры функции
strictлогическоедаНеобходимо ли применять строгую проверку параметров. По умолчанию — true
descriptionСтрокаНетОписание функции. Модель использует это, чтобы определить, следует ли вызывать функцию
Предварительный просмотр веб-поиска

Тип: Объект

Этот инструмент ищет в Интернете релевантные результаты для ответов.

СвойствоТипОбязательноОписание
typeстрокадаТип инструмента веб-поиска. Необязательные значения: web_search_preview или web_search_preview_2025_03_11
search_context_sizeстроканетОбщее руководство по объему контекстного окна, используемому для поиска. Необязательные значения: low, medium, high. По умолчанию — medium
user_locationОбъектНетМестоположение пользователя
domainsмассивнетсписок доменных имен для ограничения поиска
Местоположение пользователя
СвойствоТипОбязательноОписание
typeстрокаэтопозиционный тип аппроксимации. Всегда approximate
cityСтрокаНетСвободный ввод текста для города пользователя, например «Сан-Франциско»
countryСтрокаНетДвухбуквенный код страны пользователя по стандарту ISO, например «США»
regionСтрокаНетПроизвольный ввод текста для региона пользователя, например «Калифорния»
timezoneстроканетЧасовой пояс IANA пользователя, например. «Америка/Лос-Анджелес»
Предварительный просмотр использования компьютера

Тип: Объект

Инструменты для управления виртуальными компьютерами.

СвойствоТипОбязательноОписание
typeстрокадаТип инструмента, используемого компьютером. Всегда computer_use_preview
display_heightцелое числоДаВысота монитора компьютера
display_widthцелое числодаШирина монитора компьютера
environmentстрокадаТип компьютерной среды для управления

top_p

Тип: число или null. Обязательно: Нет По умолчанию: 1

Альтернатива температуре отбора проб называется выборкой ядра, где модель учитывает помеченные результаты с массой вероятности top_p. Следовательно, 0,1 означает, что учитываются только токены, содержащие верхнюю 10%-ную массу вероятности.

Обычно мы рекомендуем изменить это значение или temperature, но не оба одновременно.

truncation

Тип: строка или значение NULL. Обязательно: Нет Значение по умолчанию: отключено.

Стратегия усечения ответов модели:

ценностьописание
autoЕсли контекст этого ответа и предыдущего ответа превышает размер окна контекста модели, модель усекает ответ, чтобы он соответствовал окну контекста, удаляя записи в середине диалога
disabledЕсли ответ модели превысит размер контекстного окна модели, запрос завершится с ошибкой 400

user

Тип: строка Обязательно: Нет

Представляет уникальный идентификатор конечного пользователя, который помогает OpenAI отслеживать и обнаруживать злоупотребления.

📥 Ответ

Возвращает объект ответа.

Успешный ответ

Возвращает объект ответа или потоковую последовательность объектов ответа, если запрос был передан в потоковом режиме.

id

  • Тип: строка
  • Описание: Уникальный идентификатор ответа.

object

  • Тип: строка
  • Описание: Тип объекта, значение — «ответ».

created_at

  • Тип: целое число
  • Описание: временная метка создания ответа.

status

  • Тип: строка
  • Описание: статус ответа, например «завершено», «в_прогрессе» и т. д.

error

  • тип: объект или null
  • Описание: в случае возникновения ошибки укажите сообщение об ошибке.

incomplete_details

  • тип: объект или null
  • Описание: содержит подробную информацию, если ответ неполный.

instructions

  • Тип: строка или null.
  • Описание: Системные инструкции, прилагаемые к модели.

max_output_tokens

  • Тип: целое число или null.
  • Описание: Максимальное количество выходных тегов.

model

  • Тип: строка
  • Описание: используемое название модели.

output

  • Тип: массив
  • Описание: Содержит сгенерированные ответы и вызовы инструментов.
  • Может включать:
    • Объект сообщения (type: «сообщение»)
    • Объект использования инструмента (type: "tool_use")

parallel_tool_calls

  • Тип: Логический
  • Описание: включить ли параллельный вызов инструментов.

previous_response_id

  • Тип: строка или null.
  • Описание: идентификатор предыдущего ответа (для многораундовых разговоров)

reasoning

  • Тип: Объект
  • Описание: Информация, связанная с рассуждениями.

store

  • Тип: Логический
  • Описание: сохранять ли этот ответ.

temperature

  • Тип: Номер
  • Описание: используемая температура отбора проб.

text

  • Тип: Объект
  • Описание: Конфигурация формата вывода текста.

tool_choice

  • Тип: строка
  • Описание: Стратегия выбора инструмента.

tools

  • Тип: массив
  • Описание: Список доступных инструментов.

top_p

  • Тип: Номер
  • Описание: Порог выборки ядра.

truncation

  • Тип: строка
  • Описание: Стратегия усечения

usage

  • Тип: Объект
  • Описание: статистика использования токенов.
  • Свойства:
    • input_tokens: введите количество используемых токенов.
    • input_tokens_details: введите данные токена.
    • output_tokens: вывести количество использованных токенов.
    • output_tokens_details: сведения о выходном токене.
    • total_tokens: общее количество токенов

user

  • Тип: строка или null.
  • Описание: Идентификатор пользователя

metadata

  • Тип: Объект
  • Описание: Дополнительная информация метаданных.

Содержание

📝 Введение
💡 Пример запроса
Базовый текстовый ответ ✅
Ответ на анализ изображения ✅
Инструмент поиска в Интернете ✅
Инструмент поиска файлов ✅
Ответ в потоковом режиме ✅
Вызов функции ✅
Способность рассуждать ✅
📮 Запрос
Конечная точка
Метод аутентификации
Параметры тела запроса
input
Возможные типы
Входной объект сообщения
Тип элемента контента
Ввод текста
Ввод изображения
Ввод файла
Тип выходного элемента
Вывод текста
Тип комментария
Отказ от ответа
Тип вызова инструмента
Вызов инструмента поиска файлов
Вызов инструмента поиска сети
Вызов инструмента-функции
Вызов компьютерного инструмента
Вывод вызова компьютерного инструмента
Вывод вызова инструмента-функции
Элементы, связанные с выводом
Справочник проекта
model
include
instructions
max_output_tokens
metadata
parallel_tool_calls
previous_response_id
reasoning
service_tier
store
stream
temperature
text
Тип текстового формата
Текст
Схема JSON
Объект JSON
tool_choice
Возможные типы
Режим выбора инструмента
Размещенный инструмент
Функциональный инструмент
tools
Инструмент поиска файлов (Поиск файлов)
Тип фильтра
Варианты ранжирования
Инструмент «Функция» (Функция)
Предварительный просмотр веб-поиска
Местоположение пользователя
Предварительный просмотр использования компьютера
top_p
truncation
user
📥 Ответ
Успешный ответ
id
object
created_at
status
error
incomplete_details
instructions
max_output_tokens
model
output
parallel_tool_calls
previous_response_id
reasoning
store
temperature
text
tool_choice
tools
top_p
truncation
usage
user
metadata