Skip to content

missing incomplete status for WebSearchToolCall schema #556

Description

@baywet

Based on the following call

curl https://api.openai.com/v1/responses \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "gpt-5.5",
  "tools": [{"type":"web_search"}],
  "max_output_tokens": 32,
  "input": "According to the internet, how is the weather in Seattle?"
}'

We get the following results

// shortened
 "output": [
    {
      "id": "rs_064ff13535065b42006a4be85a2600819b91fbf10721be965a",
      "type": "reasoning",
      "content": [],
      "summary": []
    },
    {
      "id": "ws_064ff13535065b42006a4be85a97b4819b83030d541692dc13",
      "type": "web_search_call",
      "status": "incomplete"
    }
  ],

As you can see, the web search tool call has an incomplete status

But this value is missing from the OpenAPI description of the WebSearchToolCall component schema

components:
  schemas:
    WebSearchToolCall:
      properties:
        #shortened
        status:
          type: string
          description: |
            The status of the web search tool call.
          enum:
            - in_progress
            - searching
            - completed
            - failed

This is causing breakages on generated clients since they are not expecting this value.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions