Vapi Sessions API — Sessions

naftiko: 1.0.0-alpha2
info:
  label: Vapi Sessions API — Sessions
  description: "Vapi Sessions API — Sessions. 5 operations. Self-contained Naftiko capability covering the Vapi Sessions business surface."
  tags:
  - Vapi
  - Sessions
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
- namespace: env
  keys:
    VAPI_API_KEY: VAPI_API_KEY
capability:
  consumes:
  - type: http
    namespace: sessions-sessions
    baseUri: https://api.vapi.ai
    description: Vapi Sessions API business capability. Self-contained, no shared references.
    resources:
    - name: session
      path: /session
      operations:
      - name: sessioncontrollercreate
        method: POST
        description: "Vapi Create Session"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: sessioncontrollerfindallpaginated
        method: GET
        description: "Vapi List Sessions"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: "This is the unique identifier for the session to filter by."
          required: false
        - name: name
          in: query
          type: string
          description: "This is the name of the session to filter by."
          required: false
        - name: assistantId
          in: query
          type: string
          description: "This is the ID of the assistant to filter sessions by."
          required: false
        - name: assistantIdAny
          in: query
          type: string
          description: "Filter by multiple assistant IDs. Provide as comma-separated values."
          required: false
        - name: squadId
          in: query
          type: string
          description: "This is the ID of the squad to filter sessions by."
          required: false
        - name: workflowId
          in: query
          type: string
          description: "This is the ID of the workflow to filter sessions by."
          required: false
        - name: numberE164CheckEnabled
          in: query
          type: string
          description: "This is the flag to toggle the E164 check for the `number` field. This is an advanced property which should be used if you know your use case requires it.  Use cases: - `false`: To allow non-E164 numb"
          required: false
        - name: extension
          in: query
          type: string
          description: "This is the extension that will be dialed after the call is answered."
          required: false
        - name: assistantOverrides
          in: query
          type: string
          description: "These are the overrides for the assistant's settings and template variables specific to this customer. This allows customization of the assistant's behavior for individual customers in batch calls."
          required: false
        - name: number
          in: query
          type: string
          description: "This is the number of the customer."
          required: false
        - name: sipUri
          in: query
          type: string
          description: "This is the SIP URI of the customer."
          required: false
        - name: name
          in: query
          type: string
          description: "This is the name of the customer. This is just for your own reference.  For SIP inbound calls, this is extracted from the `From` SIP header with format `\"Display Name\" <sip:username@domain>`."
          required: false
        - name: email
          in: query
          type: string
          description: "This is the email of the customer."
          required: false
        - name: externalId
          in: query
          type: string
          description: "This is the external ID of the customer."
          required: false
        - name: customerNumberAny
          in: query
          type: string
          description: "Filter by any of the specified customer phone numbers (comma-separated)."
          required: false
        - name: phoneNumberId
          in: query
          type: string
          description: "This will return sessions with the specified phoneNumberId."
          required: false
        - name: phoneNumberIdAny
          in: query
          type: string
          description: "This will return sessions with any of the specified phoneNumberIds."
          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: sessioncontrollerfindone
        method: GET
        description: "Vapi Get Session"
        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: sessioncontrollerupdate
        method: PATCH
        description: "Vapi Update Session"
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: sessioncontrollerremove
        method: DELETE
        description: "Vapi Delete Session"
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: "The unique identifier for the resource."
          required: true
    authentication:
      type: bearer
      key: Authorization
      value: 'Bearer {{env.VAPI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: sessions-sessions-rest
    port: 8080
    description: REST adapter for Vapi Sessions. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/session
      name: session
      description: REST surface for session.
      operations:
      - method: POST
        name: sessioncontrollercreate
        description: "Vapi Create Session"
        call: sessions-sessions.sessioncontrollercreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: sessioncontrollerfindallpaginated
        description: "Vapi List Sessions"
        call: sessions-sessions.sessioncontrollerfindallpaginated
        with:
          id: rest.id
          name: rest.name
          assistantId: rest.assistantId
          assistantIdAny: rest.assistantIdAny
          squadId: rest.squadId
          workflowId: rest.workflowId
          numberE164CheckEnabled: rest.numberE164CheckEnabled
          extension: rest.extension
          assistantOverrides: rest.assistantOverrides
          number: rest.number
          sipUri: rest.sipUri
          name: rest.name
          email: rest.email
          externalId: rest.externalId
          customerNumberAny: rest.customerNumberAny
          phoneNumberId: rest.phoneNumberId
          phoneNumberIdAny: rest.phoneNumberIdAny
          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: GET
        name: sessioncontrollerfindone
        description: "Vapi Get Session"
        call: sessions-sessions.sessioncontrollerfindone
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: sessioncontrollerupdate
        description: "Vapi Update Session"
        call: sessions-sessions.sessioncontrollerupdate
        with:
          body: rest.body
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: sessioncontrollerremove
        description: "Vapi Delete Session"
        call: sessions-sessions.sessioncontrollerremove
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sessions-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Vapi Sessions. One tool per consumed operation.
    tools:
    - name: vapi-sessioncontrollercreate
      description: "Vapi Create Session"
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sessions-sessions.sessioncontrollercreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-sessioncontrollerfindallpaginated
      description: "Vapi List Sessions"
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sessions-sessions.sessioncontrollerfindallpaginated
      with:
        id: tools.id
        name: tools.name
        assistantId: tools.assistantId
        assistantIdAny: tools.assistantIdAny
        squadId: tools.squadId
        workflowId: tools.workflowId
        numberE164CheckEnabled: tools.numberE164CheckEnabled
        extension: tools.extension
        assistantOverrides: tools.assistantOverrides
        number: tools.number
        sipUri: tools.sipUri
        name: tools.name
        email: tools.email
        externalId: tools.externalId
        customerNumberAny: tools.customerNumberAny
        phoneNumberId: tools.phoneNumberId
        phoneNumberIdAny: tools.phoneNumberIdAny
        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-sessioncontrollerfindone
      description: "Vapi Get Session"
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sessions-sessions.sessioncontrollerfindone
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-sessioncontrollerupdate
      description: "Vapi Update Session"
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sessions-sessions.sessioncontrollerupdate
      with:
        body: tools.body
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: vapi-sessioncontrollerremove
      description: "Vapi Delete Session"
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sessions-sessions.sessioncontrollerremove
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.