API Reference — subpackage_agent-exports

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_agent-exports
  description: 'API Reference — subpackage_agent-exports. 4 operations. Lead operation: List agent exports. Self-contained
    Naftiko capability covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_agent-exports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FLATFILE_API_KEY: FLATFILE_API_KEY
capability:
  consumes:
  - type: http
    namespace: flatfile-subpackage-agent-exports
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_agent-exports business capability. Self-contained, no shared references.
    resources:
    - name: agent-exports
      path: /agent-exports
      operations:
      - name: list
        method: GET
        description: List agent exports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: environmentId
          in: query
          type: string
        - name: agentId
          in: query
          type: string
        - name: pageSize
          in: query
          type: string
        - name: pageNumber
          in: query
          type: string
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: agent-exports-agentExportId
      path: /agent-exports/{agentExportId}
      operations:
      - name: get
        method: GET
        description: Get an agent export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: agentExportId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: delete
        method: DELETE
        description: Delete an agent export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: agentExportId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    - name: agent-exports-agentExportId-download
      path: /agent-exports/{agentExportId}/download
      operations:
      - name: download
        method: GET
        description: Download an agent export
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: agentExportId
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.FLATFILE_API_KEY}}'
  exposes:
  - type: rest
    namespace: flatfile-subpackage-agent-exports-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_agent-exports. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/agent-exports
      name: agent-exports
      description: REST surface for agent-exports.
      operations:
      - method: GET
        name: list
        description: List agent exports
        call: flatfile-subpackage-agent-exports.list
        with:
          environmentId: rest.environmentId
          agentId: rest.agentId
          pageSize: rest.pageSize
          pageNumber: rest.pageNumber
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agent-exports/{agentexportid}
      name: agent-exports-agentexportid
      description: REST surface for agent-exports-agentExportId.
      operations:
      - method: GET
        name: get
        description: Get an agent export
        call: flatfile-subpackage-agent-exports.get
        with:
          agentExportId: rest.agentExportId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete an agent export
        call: flatfile-subpackage-agent-exports.delete
        with:
          agentExportId: rest.agentExportId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agent-exports/{agentexportid}/download
      name: agent-exports-agentexportid-download
      description: REST surface for agent-exports-agentExportId-download.
      operations:
      - method: GET
        name: download
        description: Download an agent export
        call: flatfile-subpackage-agent-exports.download
        with:
          agentExportId: rest.agentExportId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-agent-exports-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_agent-exports. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-agent-exports
      description: List agent exports
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-agent-exports.list
      with:
        environmentId: tools.environmentId
        agentId: tools.agentId
        pageSize: tools.pageSize
        pageNumber: tools.pageNumber
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: get-agent-export
      description: Get an agent export
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-agent-exports.get
      with:
        agentExportId: tools.agentExportId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-agent-export
      description: Delete an agent export
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: flatfile-subpackage-agent-exports.delete
      with:
        agentExportId: tools.agentExportId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: download-agent-export
      description: Download an agent export
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-agent-exports.download
      with:
        agentExportId: tools.agentExportId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.