Telnyx API — Documents

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Documents
  description: 'Telnyx API — Documents. 8 operations. Lead operation: List all document links. Self-contained Naftiko capability
    covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-documents
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Documents business capability. Self-contained, no shared references.
    resources:
    - name: document_links
      path: /document_links
      operations:
      - name: listdocumentlinks
        method: GET
        description: List all document links
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents
      path: /documents
      operations:
      - name: listdocuments
        method: GET
        description: List all documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdocument
        method: POST
        description: Upload a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: documents-id
      path: /documents/{id}
      operations:
      - name: deletedocument
        method: DELETE
        description: Delete a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: retrievedocument
        method: GET
        description: Retrieve a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedocument
        method: PATCH
        description: Update a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: documents-id-download
      path: /documents/{id}/download
      operations:
      - name: downloaddocument
        method: GET
        description: Download a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents-id-download_link
      path: /documents/{id}/download_link
      operations:
      - name: getdocumentdownloadlink
        method: GET
        description: Generate a temporary download link for a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Uniquely identifies the document
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-documents-rest
    port: 8080
    description: REST adapter for Telnyx API — Documents. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/document-links
      name: document-links
      description: REST surface for document_links.
      operations:
      - method: GET
        name: listdocumentlinks
        description: List all document links
        call: telnyx-documents.listdocumentlinks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents
      name: documents
      description: REST surface for documents.
      operations:
      - method: GET
        name: listdocuments
        description: List all documents
        call: telnyx-documents.listdocuments
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdocument
        description: Upload a document
        call: telnyx-documents.createdocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{id}
      name: documents-id
      description: REST surface for documents-id.
      operations:
      - method: DELETE
        name: deletedocument
        description: Delete a document
        call: telnyx-documents.deletedocument
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrievedocument
        description: Retrieve a document
        call: telnyx-documents.retrievedocument
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatedocument
        description: Update a document
        call: telnyx-documents.updatedocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{id}/download
      name: documents-id-download
      description: REST surface for documents-id-download.
      operations:
      - method: GET
        name: downloaddocument
        description: Download a document
        call: telnyx-documents.downloaddocument
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{id}/download-link
      name: documents-id-download-link
      description: REST surface for documents-id-download_link.
      operations:
      - method: GET
        name: getdocumentdownloadlink
        description: Generate a temporary download link for a document
        call: telnyx-documents.getdocumentdownloadlink
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Documents. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-document-links
      description: List all document links
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-documents.listdocumentlinks
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-documents
      description: List all documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-documents.listdocuments
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-document
      description: Upload a document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-documents.createdocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-document
      description: Delete a document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-documents.deletedocument
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-document
      description: Retrieve a document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-documents.retrievedocument
      outputParameters:
      - type: object
        mapping: $.
    - name: update-document
      description: Update a document
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-documents.updatedocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: download-document
      description: Download a document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-documents.downloaddocument
      outputParameters:
      - type: object
        mapping: $.
    - name: generate-temporary-download-link-document
      description: Generate a temporary download link for a document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-documents.getdocumentdownloadlink
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.