API Reference — subpackage_assistant

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_assistant
  description: 'API Reference — subpackage_assistant. 5 operations. Lead operation: List prompts. Self-contained Naftiko capability
    covering one Flatfile business surface.'
  tags:
  - Flatfile
  - subpackage_assistant
  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-assistant
    baseUri: https://api.x.flatfile.com/v1
    description: API Reference — subpackage_assistant business capability. Self-contained, no shared references.
    resources:
    - name: prompts
      path: //prompts
      operations:
      - name: list
        method: GET
        description: List prompts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: promptType
          in: query
          type: string
          description: Type of prompt (default AI_ASSIST)
        - name: pageSize
          in: query
          type: integer
          description: Number of prompts to return in a page (default 7)
        - name: pageNumber
          in: query
          type: integer
          description: Based on pageSize, which page of prompts to return
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: create
        method: POST
        description: Create a prompt
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: prompts-promptId
      path: //prompts/{promptId}
      operations:
      - name: get
        method: GET
        description: Get a prompt
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: promptId
          in: path
          type: string
          description: ID of prompts
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
      - name: update
        method: PATCH
        description: Update a prompt
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: promptId
          in: path
          type: string
          description: ID of prompts
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer authentication
          required: true
        - name: X-Disable-Hooks
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete a prompts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: promptId
          in: path
          type: string
          description: ID of prompts
          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-assistant-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_assistant. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/prompts
      name: prompts
      description: REST surface for prompts.
      operations:
      - method: GET
        name: list
        description: List prompts
        call: flatfile-subpackage-assistant.list
        with:
          promptType: rest.promptType
          pageSize: rest.pageSize
          pageNumber: rest.pageNumber
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create a prompt
        call: flatfile-subpackage-assistant.create
        with:
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prompts/{promptid}
      name: prompts-promptid
      description: REST surface for prompts-promptId.
      operations:
      - method: GET
        name: get
        description: Get a prompt
        call: flatfile-subpackage-assistant.get
        with:
          promptId: rest.promptId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: Update a prompt
        call: flatfile-subpackage-assistant.update
        with:
          promptId: rest.promptId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a prompts
        call: flatfile-subpackage-assistant.delete
        with:
          promptId: rest.promptId
          Authorization: rest.Authorization
          X-Disable-Hooks: rest.X-Disable-Hooks
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: flatfile-subpackage-assistant-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_assistant. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-prompts
      description: List prompts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-assistant.list
      with:
        promptType: tools.promptType
        pageSize: tools.pageSize
        pageNumber: tools.pageNumber
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: create-prompt
      description: Create a prompt
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: flatfile-subpackage-assistant.create
      with:
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-prompt
      description: Get a prompt
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: flatfile-subpackage-assistant.get
      with:
        promptId: tools.promptId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.
    - name: update-prompt
      description: Update a prompt
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: flatfile-subpackage-assistant.update
      with:
        promptId: tools.promptId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-prompts
      description: Delete a prompts
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: flatfile-subpackage-assistant.delete
      with:
        promptId: tools.promptId
        Authorization: tools.Authorization
        X-Disable-Hooks: tools.X-Disable-Hooks
      outputParameters:
      - type: object
        mapping: $.