データ API / OpenAI Web Search / Search

Model-grounded web search (OpenAI).

Generate a cited answer with an OpenAI model and web search. Supply input as a string or message array. The model, tools and search limit are managed by the service. The response is a Responses object whose output includes web_search_call and message items with URL citations. usage reports resource consumption, not a Felo charge.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

inputstring必須
Your question or instruction, same format as the OpenAI Responses API input. A message array is also accepted.
max_output_tokensinteger任意
Optional cap on the number of tokens generated in the answer.
instructionsstring任意
Optional high-level instructions to steer the answer's tone or format.

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/openai-websearch/search" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "<string>",
  "max_output_tokens": 0,
  "instructions": "<string>"
}'

レスポンス

レスポンスのフィールド

idstring任意
objectstring任意
statusstring任意
outputobject[]任意
Ordered items: web_search_call (searches performed) and message (the cited answer).
usageobject任意
input_tokensinteger任意
output_tokensinteger任意
input_tokens_detailsobject任意
cached_tokensinteger任意