VAvapiai
Structured Outputs

List Structured Outputs

Changed on
get/structured-output

Request

  • Base URL
    https://api.vapi.ai
  • Auth
    HTTP bearer

Query parameters

idstring

This will return structured outputs where the id matches the specified value.

namestring

This will return structured outputs where the name matches the specified value.

pagenumber

This is the page number to return. Defaults to 1.

sortOrder'ASC' | 'DESC'

This is the sort order for pagination. Defaults to 'DESC'.

sortBy'createdAt' | 'duration' | 'cost'

This is the column to sort by. Defaults to 'createdAt'.

limitnumber

This is the maximum number of items to return. Defaults to 100.

createdAtGtstring date-time

This will return items where the createdAt is greater than the specified value.

createdAtLtstring date-time

This will return items where the createdAt is less than the specified value.

createdAtGestring date-time

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestring date-time

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstring date-time

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstring date-time

This will return items where the updatedAt is less than the specified value.

updatedAtGestring date-time

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestring date-time

This will return items where the updatedAt is less than or equal to the specified value.

Response

Example response

{
  "results": [
    {
      "conditions": [
        {
          "type": "minMessages",
          "count": 4
        },
        {
          "type": "minCallDuration",
          "seconds": 10
        }
      ]
    }
  ]
}

Changes

  • 05bdbfb8f1d9Revision changes
    • info

      added the optional property //// to the response with the status

  • 796dc3003764Revision changes
    • warning

      added the new gemini-3.8-flash enum value to the //// response property for the response status

    This list may be incomplete.

Some revisions have not been checked yet.