WebsiteStatusSupportDashboard
DocumentationAPI ReferenceMCPSDKsCLI (new)Changelog
DocumentationAPI ReferenceMCPSDKsCLI (new)Changelog
  • Assistants
    • GETList Assistants
    • POSTCreate Assistant
    • GETGet Assistant
    • DELDelete Assistant
    • PATCHUpdate Assistant
  • Squads
    • GETList Squads
    • POSTCreate Squad
    • GETGet Squad
    • DELDelete Squad
    • PATCHUpdate Squad
  • Calls
    • GETList Calls
    • POSTCreate Call
    • GETGet Call
    • DELDelete Call Data
    • PATCHUpdate Call
  • Chats
    • GETList Chats
    • POSTCreate Chat
    • GETGet Chat
    • DELDelete Chat
    • POSTCreate Chat (OpenAI Compatible)
  • Campaigns
    • GETList Campaigns
    • POSTCreate Campaign
    • GETGet Campaign
    • DELDelete Campaign
    • PATCHUpdate Campaign
  • Sessions
    • GETList Sessions
    • POSTCreate Session
    • GETGet Session
    • DELDelete Session
    • PATCHUpdate Session
  • Phone Numbers
    • GETList Phone Numbers
    • POSTCreate Phone Number
    • GETGet Phone Number
    • DELDelete Phone Number
    • PATCHUpdate Phone Number
  • Tools
    • GETList Tools
    • POSTCreate Tool
    • GETGet Tool
    • DELDelete Tool
    • PATCHUpdate Tool
  • Files
    • GETList Files
    • POSTUpload File
    • GETGet File
    • DELDelete File
    • PATCHUpdate File
  • Structured Outputs
    • GETList Structured Outputs
    • POSTCreate Structured Output
    • GETGet Structured Output
    • DELDelete Structured Output
    • PATCHUpdate Structured Output
  • Eval
    • GETList Evals
    • POSTCreate Eval
    • GETGet Eval
    • DELDelete Eval
    • PATCHUpdate Eval
    • GETGet Eval Run
    • DELDelete Eval Run
    • GETList Eval Runs
    • POSTCreate Eval Run
  • Provider Resources
    • GETList Provider Resources
    • POSTCreate Provider Resource
    • GETGet Provider Resource
    • DELDelete Provider Resource
    • PATCHUpdate Provider Resource
  • Analytics
    • POSTCreate Analytics Queries
  • Webhooks
    • POSTServer Message
    • POSTClient Message
    • Swagger
    • OpenAPI
LogoLogo
WebsiteStatusSupportDashboard
Structured Outputs

Create Structured Output

POST
https://api.vapi.ai/structured-output
POST
/structured-output
1from vapi import JsonSchema, Vapi
2
3client = Vapi(
4    token="YOUR_TOKEN",
5)
6client.structured_outputs.structured_output_controller_create(
7    name="name",
8    schema=JsonSchema(
9        type="string",
10    ),
11)
Try it
201Created
1{
2  "id": "string",
3  "orgId": "string",
4  "createdAt": "2024-01-15T09:30:00Z",
5  "updatedAt": "2024-01-15T09:30:00Z",
6  "name": "string",
7  "schema": {
8    "type": "string",
9    "items": {},
10    "properties": {},
11    "description": "string",
12    "pattern": "string",
13    "format": "date-time",
14    "required": [
15      "string"
16    ],
17    "enum": [
18      "string"
19    ],
20    "title": "string"
21  },
22  "model": {
23    "provider": "openai",
24    "model": "gpt-5",
25    "temperature": 1.1,
26    "maxTokens": 1.1
27  },
28  "description": "string",
29  "assistantIds": [
30    "string"
31  ],
32  "workflowIds": [
33    "string"
34  ]
35}
Was this page helpful?
Previous

Get Structured Output

Next
Built with
Get Structured Output

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired>=1 character<=40 characters
This is the name of the structured output.
schemaobjectRequired
This is the JSON Schema definition for the structured output. This is required when creating a structured output. Defines the structure and validation rules for the data that will be extracted. Supports all JSON Schema features including: - Objects and nested properties - Arrays and array validation - String, number, boolean, and null types - Enums and const values - Validation constraints (min/max, patterns, etc.) - Composition with allOf, anyOf, oneOf
modelobjectOptional
This is the model that will be used to extract the structured output. To provide your own custom system and user prompts for structured output extraction, populate the messages array with your system and user messages. You can specify liquid templating in your system and user messages. Between the system or user messages, you must reference either 'transcript' or 'messages' with the '{{}}' syntax to access the conversation history. Between the system or user messages, you must reference a variation of the structured output with the '{{}}' syntax to access the structured output definition. i.e.: {{structuredOutput}} {{structuredOutput.name}} {{structuredOutput.description}} {{structuredOutput.schema}} If model is not specified, GPT-4.1 will be used by default for extraction, utilizing default system and user prompts. If messages or required fields are not specified, the default system and user prompts will be used.
descriptionstringOptional
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.
assistantIdslist of stringsOptional
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.
workflowIdslist of stringsOptional
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.

Response

idstring
This is the unique identifier for the structured output.
orgIdstring
This is the unique identifier for the org that this structured output belongs to.
createdAtstringformat: "date-time"

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

updatedAtstringformat: "date-time"

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

namestring>=1 character<=40 characters
This is the name of the structured output.
schemaobject
This is the JSON Schema definition for the structured output. Defines the structure and validation rules for the data that will be extracted. Supports all JSON Schema features including: - Objects and nested properties - Arrays and array validation - String, number, boolean, and null types - Enums and const values - Validation constraints (min/max, patterns, etc.) - Composition with allOf, anyOf, oneOf
modelobject or null
This is the model that will be used to extract the structured output. To provide your own custom system and user prompts for structured output extraction, populate the messages array with your system and user messages. You can specify liquid templating in your system and user messages. Between the system or user messages, you must reference either 'transcript' or 'messages' with the '{{}}' syntax to access the conversation history. Between the system or user messages, you must reference a variation of the structured output with the '{{}}' syntax to access the structured output definition. i.e.: {{structuredOutput}} {{structuredOutput.name}} {{structuredOutput.description}} {{structuredOutput.schema}} If model is not specified, GPT-4.1 will be used by default for extraction, utilizing default system and user prompts. If messages or required fields are not specified, the default system and user prompts will be used.
descriptionstring or null
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.
assistantIdslist of strings or null
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.
workflowIdslist of strings or null
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.

This is the JSON Schema definition for the structured output.

This is required when creating a structured output. Defines the structure and validation rules for the data that will be extracted. Supports all JSON Schema features including:

  • Objects and nested properties
  • Arrays and array validation
  • String, number, boolean, and null types
  • Enums and const values
  • Validation constraints (min/max, patterns, etc.)
  • Composition with allOf, anyOf, oneOf

This is the JSON Schema definition for the structured output.

Defines the structure and validation rules for the data that will be extracted. Supports all JSON Schema features including:

  • Objects and nested properties
  • Arrays and array validation
  • String, number, boolean, and null types
  • Enums and const values
  • Validation constraints (min/max, patterns, etc.)
  • Composition with allOf, anyOf, oneOf

Bearer authentication of the form Bearer <token>, where token is your auth token.