Vapi Structured Outputs API — Structured Outputs

naftiko: 1.0.0-alpha2
info:
  label: Vapi Structured Outputs API — Structured Outputs
  description: "Vapi Structured Outputs API — Structured Outputs. 6 operations. Self-contained Naftiko capability covering the Vapi Structured Outputs business surface."
  tags:
  - Vapi
  - Structured Outputs
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
- namespace: env
  keys:
    VAPI_API_KEY: VAPI_API_KEY
capability:
  consumes:
  - type: http
    namespace: structured-outputs-structured-outputs
    baseUri: https://api.vapi.ai
    description: Vapi Structured Outputs API business capability. Self-contained, no shared references.
    resources:
    - name: structured-output
      path: /structured-output
      operations:
      - name: structuredoutputcontrollerfindall
        method: GET
        description: "Vapi List Structured Outputs"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: "This will return structured outputs where the id matches the specified value."
          required: false
        - name: name
          in: query
          type: string
          description: "This will return structured outputs where the name matches the specified value."
          required: false
        - name: page
          in: query
          type: string
          description: "This is the page number to return. Defaults to 1."
          required: false
        - name: sortOrder
          in: query
          type: string
          description: "This is the sort order for pagination. Defaults to 'DESC'."
          required: false
        - name: sortBy
          in: query
          type: string
          description: "This is the column to sort by. Defaults to 'createdAt'."
          required: false
        - name: limit
          in: query
          type: string
          description: "This is the maximum number of items to return. Defaults to 100."
          required: false
        - name: createdAtGt
          in: query
          type: string
          description: "This will return items where the createdAt is greater than the specified value."
          required: false
        - name: createdAtLt
          in: query
          type: string
          description: "This will return items where the createdAt is less than the specified value."
          required: false
        - name: createdAtGe
          in: query
          type: string
          description: "This will return items where the createdAt is greater than or equal to the specified value."
          required: false
        - name: createdAtLe
          in: query
          type: string
          description: "This will return items where the createdAt is less than or equal to the specified value."
          required: false
        - name: updatedAtGt
          in: query
          type: string
          description: "This will return items where the updatedAt is greater than the specified value."
          required: false
        - name: updatedAtLt
          in: query
          type: string
          description: "This will return items where the updatedAt is less than the specified value."
          required: false
        - name: updatedAtGe
          in: query
          type: string
          description: "This will return items where the updatedAt is greater than or equal to the specified value."
          required: false
        - name: updatedAtLe
          in: query
          type: string
          description: "This will return items where the updatedAt is less than or equal to the specified value."
          required: false
      - name: structuredoutputcontrollercreate
        method: POST
        description: "Vapi Create Structured Output"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: structuredoutputcontrollerfindone
        method: GET
        description: "Vapi Get Structured Output"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: "The unique identifier for the resource."
          required: true
      - name: structuredoutputcontrollerupdate
        method: PATCH
        description: "Vapi Update Structured Output"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: "The unique identifier for the resource."
          required: true
        - name: schemaOverride
          in: query
          type: string
          description: "Query parameter schemaOverride"
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: structuredoutputcontrollerremove
        method: DELETE
        description: "Vapi Delete Structured Output"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: "The unique identifier for the resource."
          required: true
    - name: structured-output-run
      path: /structured-output/run
      operations:
      - name: structuredoutputcontrollerrun
        method: POST
        description: "Vapi Run Structured Output"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      key: Authorization
      value: 'Bearer {{env.VAPI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: structured-outputs-structured-outputs-rest
    port: 8080
    description: REST adapter for Vapi Structured Outputs. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/structured-output
      name: structured-output
      description: REST surface for structured-output.
      operations:
      - method: GET
        name: structuredoutputcontrollerfindall
        description: "Vapi List Structured Outputs"
        call: structured-outputs-structured-outputs.structuredoutputcontrollerfindall
        with:
          id: rest.id
          name: rest.name
          page: rest.page
          sortOrder: rest.sortOrder
          sortBy: rest.sortBy
          limit: rest.limit
          createdAtGt: rest.createdAtGt
          createdAtLt: rest.createdAtLt
          createdAtGe: rest.createdAtGe
          createdAtLe: rest.createdAtLe
          updatedAtGt: rest.updatedAtGt
          updatedAtLt: rest.updatedAtLt
          updatedAtGe: rest.updatedAtGe
          updatedAtLe: rest.updatedAtLe
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: structuredoutputcontrollercreate
        description: "Vapi Create Structured Output"
        call: structured-outputs-structured-outputs.structuredoutputcontrollercreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: structuredoutputcontrollerfindone
        description: "Vapi Get Structured Output"
        call: structured-outputs-structured-outputs.structuredoutputcontrollerfindone
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: structuredoutputcontrollerupdate
        description: "Vapi Update Structured Output"
        call: structured-outputs-structured-outputs.structuredoutputcontrollerupdate
        with:
          body: rest.body
          id: rest.id
          schemaOverride: rest.schemaOverride
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: structuredoutputcontrollerremove
        description: "Vapi Delete Structured Output"
        call: structured-outputs-structured-outputs.structuredoutputcontrollerremove
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/structured-output/run
      name: structured-output-run
      description: REST surface for structured-output-run.
      operations:
      - method: POST
        name: structuredoutputcontrollerrun
        description: "Vapi Run Structured Output"
        call: structured-outputs-structured-outputs.structuredoutputcontrollerrun
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: structured-outputs-structured-outputs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Vapi Structured Outputs. One tool per consumed operation.
    tools:
    - name: vapi-structuredoutputcontrollerfindall
      description: "Vapi List Structured Outputs"
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: structured-outputs-structured-outputs.structuredoutputcontrollerfindall
      with:
        id: tools.id
        name: tools.name
        page: tools.page
        sortOrder: tools.sortOrder
        sortBy: tools.sortBy
        limit: tools.limit
        createdAtGt: tools.createdAtGt
        createdAtLt: tools.createdAtLt
        createdAtGe: tools.createdAtGe
        createdAtLe: tools.createdAtLe
        updatedAtGt: tools.updatedAtGt
        updatedAtLt: tools.updatedAtLt
        updatedAtGe: tools.updatedAtGe
        updatedAtLe: tools.updatedAtLe
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-structuredoutputcontrollercreate
      description: "Vapi Create Structured Output"
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: structured-outputs-structured-outputs.structuredoutputcontrollercreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-structuredoutputcontrollerfindone
      description: "Vapi Get Structured Output"
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: structured-outputs-structured-outputs.structuredoutputcontrollerfindone
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-structuredoutputcontrollerupdate
      description: "Vapi Update Structured Output"
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: structured-outputs-structured-outputs.structuredoutputcontrollerupdate
      with:
        body: tools.body
        id: tools.id
        schemaOverride: tools.schemaOverride
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-structuredoutputcontrollerremove
      description: "Vapi Delete Structured Output"
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: structured-outputs-structured-outputs.structuredoutputcontrollerremove
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-structuredoutputcontrollerrun
      description: "Vapi Run Structured Output"
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: structured-outputs-structured-outputs.structuredoutputcontrollerrun
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.