Structured Outputs

Create Structured Output

post/structured-output

Request body

namestring required

This is the name of the structured output.

descriptionstring

This is the description of what the structured output extracts.

Use this to provide context about what data will be extracted and how it will be used.

assistantIdsstring[]

These are the assistant IDs that this structured output is linked to.

When linked to assistants, this structured output will be available for extraction during those assistant's calls.

workflowIdsstring[]

These are the workflow IDs that this structured output is linked to.

When linked to workflows, this structured output will be available for extraction during those workflow's execution.

idstring required

This is the unique identifier for the structured output.

orgIdstring required

This is the unique identifier for the org that this structured output belongs to.

createdAtstring date-time required

This is the ISO 8601 date-time string of when the structured output was created.

updatedAtstring date-time required

This is the ISO 8601 date-time string of when the structured output was last updated.