additionalProperties should not be set for object types

[PraveenKS30]

Please read this first

• Have you read the docs?Agents SDK docs
• Have you searched for related issues? Others may have had similar requests

Question

I am trying to get structured output from the Agent using output_type .
My output would be in the JSON format and dynamic in nature so I kept the field as payload : dict.

class FHIRPayload(BaseModel):
    payload : dict

# define agent 
fhir_agent = Agent(
        name = "FHIR agent",
        instructions= fhir_system_prompt,
        model = "gpt-4o",
        output_type= FHIRPayload
    )

  response = Runner.run_sync(fhir_agent, input)
  print("Initial FHIR payload" + response.final_output)

But, keep getting this error :

agents.exceptions.UserError: additionalProperties should not be set for object types. This could be because you're using an older version of Pydantic, or because you configured additional properties to be allowed. If you really need this, update the function or output tool to not use a strict schema.

[rogerioluizsi]

Sorry I didn't answer your question directly. But this might happen to others too. This error also comes up when you use **kwargs in the function signature.

[dkundel-openai]

Hey @PraveenKS30,

overall Structured Outputs require additionalProperties to be set to false in the JSON schema.

You would have to modify your Agent to turn off strict output to be able to use use it with a more generic JSON.

fhir_agent = Agent(
        name = "FHIR agent",
        instructions= fhir_system_prompt,
        model = "gpt-4o",
        output_type= FHIRPayload
+       strict_json_schema=False
    )

Generally we don't recommend this though and if possible you should try to type the expected output as much as possible.