Telnyx API — Session Analysis

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Session Analysis
  description: 'Telnyx API — Session Analysis. 3 operations. Lead operation: Get metadata overview. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Session Analysis
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-session-analysis
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Session Analysis business capability. Self-contained, no shared references.
    resources:
    - name: session_analysis-metadata
      path: /session_analysis/metadata
      operations:
      - name: getsessionanalysismetadata
        method: GET
        description: Get metadata overview
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: session_analysis-metadata-record_type
      path: /session_analysis/metadata/{record_type}
      operations:
      - name: getsessionanalysisrecordtypemetadata
        method: GET
        description: Get record type metadata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: record_type
          in: path
          type: string
          description: The record type identifier (e.g. "call-control").
          required: true
    - name: session_analysis-record_type-event_id
      path: /session_analysis/{record_type}/{event_id}
      operations:
      - name: getsessionanalysis
        method: GET
        description: Get session analysis
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: record_type
          in: path
          type: string
          description: The record type identifier.
          required: true
        - name: event_id
          in: path
          type: string
          description: The event identifier (UUID).
          required: true
        - name: include_children
          in: query
          type: boolean
          description: Whether to include child events in the response.
        - name: max_depth
          in: query
          type: integer
          description: Maximum traversal depth for the event tree.
        - name: expand
          in: query
          type: string
          description: Controls what data to expand on each event node.
        - name: date_time
          in: query
          type: string
          description: ISO 8601 timestamp or date to narrow index selection for faster lookups. Accepts full datetime (e.g.,
            2026-03-17T10:00:00Z) or date-only format (e.g., 2026-03-1
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-session-analysis-rest
    port: 8080
    description: REST adapter for Telnyx API — Session Analysis. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/session-analysis/metadata
      name: session-analysis-metadata
      description: REST surface for session_analysis-metadata.
      operations:
      - method: GET
        name: getsessionanalysismetadata
        description: Get metadata overview
        call: telnyx-session-analysis.getsessionanalysismetadata
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/session-analysis/metadata/{record-type}
      name: session-analysis-metadata-record-type
      description: REST surface for session_analysis-metadata-record_type.
      operations:
      - method: GET
        name: getsessionanalysisrecordtypemetadata
        description: Get record type metadata
        call: telnyx-session-analysis.getsessionanalysisrecordtypemetadata
        with:
          record_type: rest.record_type
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/session-analysis/{record-type}/{event-id}
      name: session-analysis-record-type-event-id
      description: REST surface for session_analysis-record_type-event_id.
      operations:
      - method: GET
        name: getsessionanalysis
        description: Get session analysis
        call: telnyx-session-analysis.getsessionanalysis
        with:
          record_type: rest.record_type
          event_id: rest.event_id
          include_children: rest.include_children
          max_depth: rest.max_depth
          expand: rest.expand
          date_time: rest.date_time
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-session-analysis-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Session Analysis. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-metadata-overview
      description: Get metadata overview
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-session-analysis.getsessionanalysismetadata
      outputParameters:
      - type: object
        mapping: $.
    - name: get-record-type-metadata
      description: Get record type metadata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-session-analysis.getsessionanalysisrecordtypemetadata
      with:
        record_type: tools.record_type
      outputParameters:
      - type: object
        mapping: $.
    - name: get-session-analysis
      description: Get session analysis
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-session-analysis.getsessionanalysis
      with:
        record_type: tools.record_type
        event_id: tools.event_id
        include_children: tools.include_children
        max_depth: tools.max_depth
        expand: tools.expand
        date_time: tools.date_time
      outputParameters:
      - type: object
        mapping: $.