Proompty — Topic

naftiko: 1.0.0-alpha2
info:
  label: Proompty — Topic
  description: 'Proompty — Topic. 11 operations. Lead operation: Retrieve details about a specific topic in the Proompty API.
    By sending a GET request to this endpoint with the corresponding topicId parameter, users can access information such
    as the topic''s title, description, and any associated documents or chats. The API responds with the topic object in JSON
    format, containing the relevant details. In case th'
  tags:
  - Proompty
  - Topic
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PROOMPTY_API_KEY: PROOMPTY_API_KEY
capability:
  consumes:
  - type: http
    namespace: proompty-topic
    baseUri: https://app.proompty.com/api
    description: Proompty — Topic business capability. Self-contained, no shared references.
    resources:
    - name: topics-topicId
      path: /topics/{topicId}
      operations:
      - name: get
        method: GET
        description: Retrieve details about a specific topic in the Proompty API. By sending a GET request to this endpoint
          with the corresponding topicId parameter, users can access information such as the topic's title, description, and
          any associated documen
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: include
          in: query
          type: string
          description: 'Include additional data in the response. Possible values: documents, chats.'
      - name: put
        method: PUT
        description: Update the details of a specific topic in the Proompty API. By sending a PUT request to this endpoint
          with the corresponding topicId parameter and the updated topic object in the request body, users can modify the
          topic's title, description
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: topics-topicId-documents-upload
      path: /topics/{topicId}/documents/upload
      operations:
      - name: post
        method: POST
        description: Upload a document to a specific topic. Users can send a POST request to this endpoint with the relevant
          topicId parameter and a document file to upload a new document to the specified topic. The API responds with a JSON
          object containing th
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: topics-topicId-documents-documentId
      path: /topics/{topicId}/documents/{documentId}
      operations:
      - name: get
        method: GET
        description: Retrieve details about a specific document within a designated topic in the Proompty API. By sending
          a GET request to this endpoint with the corresponding topicId and documentId parameters, users can access information
          such as the document'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: documentId
          in: path
          type: string
          required: true
      - name: delete
        method: DELETE
        description: Delete a specific document within a designated topic in the Proompty API. Users can send a DELETE request
          to this endpoint with the relevant topicId and documentId parameters to remove the specified document from the topic.
          The API responds
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: documentId
          in: path
          type: string
          required: true
    - name: topics-topicId-prompts
      path: /topics/{topicId}/prompts
      operations:
      - name: get
        method: GET
        description: Retrieve a list of all prompts associated with a specific topic. Users can send a GET request to this
          endpoint with the relevant topicId parameter to access comprehensive information about each prompt within the specified
          topic. The API res
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
      - name: post
        method: POST
        description: Create a new prompts within a specified topic. Users can send a POST request to this endpoint, including
          the topicId parameter in the URL path and a JSON payload containing the details of the prompt to be created. This
          payload typically inc
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: topics-topicId-prompts-promptId
      path: /topics/{topicId}/prompts/{promptId}
      operations:
      - name: get
        method: GET
        description: Retrieve details about a specific prompt within a designated topic in the Proompty API. By sending a
          GET request to this endpoint with the corresponding topicId and promptId parameters, users can access information
          such as the prompt's cont
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: promptId
          in: path
          type: string
          required: true
      - name: put
        method: PUT
        description: Proompty Update a specific prompt within a designated topic. Users can send a PUT request to this endpoint
          with the corresponding topicId and promptId parameters, along with a JSON payload containing the updated prompt
          information. This ena
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: promptId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: delete
        method: DELETE
        description: Remove a specific prompt associated with a particular topic. To utilize this endpoint, users send a DELETE
          request with the relevant topicId and promptId parameters. Upon successful execution, the specified prompt is permanently
          deleted fro
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: promptId
          in: path
          type: string
          required: true
    - name: topics-topicId-prompts-promptId-chat
      path: /topics/{topicId}/prompts/{promptId}/chat
      operations:
      - name: post
        method: POST
        description: Retrieves user information within the Proompty API system. By sending a GET request to this endpoint,
          users can obtain detailed data pertaining to their profile and associated claims. This includes essential user attributes
          such as email, f
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: topicId
          in: path
          type: string
          required: true
        - name: promptId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: proompty-topic-rest
    port: 8080
    description: REST adapter for Proompty — Topic. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/topics/{topicid}
      name: topics-topicid
      description: REST surface for topics-topicId.
      operations:
      - method: GET
        name: get
        description: Retrieve details about a specific topic in the Proompty API. By sending a GET request to this endpoint
          with the corresponding topicId parameter, users can access information such as the topic's title, description, and
          any associated documen
        call: proompty-topic.get
        with:
          topicId: rest.topicId
          include: rest.include
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Update the details of a specific topic in the Proompty API. By sending a PUT request to this endpoint
          with the corresponding topicId parameter and the updated topic object in the request body, users can modify the
          topic's title, description
        call: proompty-topic.put
        with:
          topicId: rest.topicId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/topics/{topicid}/documents/upload
      name: topics-topicid-documents-upload
      description: REST surface for topics-topicId-documents-upload.
      operations:
      - method: POST
        name: post
        description: Upload a document to a specific topic. Users can send a POST request to this endpoint with the relevant
          topicId parameter and a document file to upload a new document to the specified topic. The API responds with a JSON
          object containing th
        call: proompty-topic.post
        with:
          topicId: rest.topicId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/topics/{topicid}/documents/{documentid}
      name: topics-topicid-documents-documentid
      description: REST surface for topics-topicId-documents-documentId.
      operations:
      - method: GET
        name: get
        description: Retrieve details about a specific document within a designated topic in the Proompty API. By sending
          a GET request to this endpoint with the corresponding topicId and documentId parameters, users can access information
          such as the document'
        call: proompty-topic.get
        with:
          topicId: rest.topicId
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a specific document within a designated topic in the Proompty API. Users can send a DELETE request
          to this endpoint with the relevant topicId and documentId parameters to remove the specified document from the topic.
          The API responds
        call: proompty-topic.delete
        with:
          topicId: rest.topicId
          documentId: rest.documentId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/topics/{topicid}/prompts
      name: topics-topicid-prompts
      description: REST surface for topics-topicId-prompts.
      operations:
      - method: GET
        name: get
        description: Retrieve a list of all prompts associated with a specific topic. Users can send a GET request to this
          endpoint with the relevant topicId parameter to access comprehensive information about each prompt within the specified
          topic. The API res
        call: proompty-topic.get
        with:
          topicId: rest.topicId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a new prompts within a specified topic. Users can send a POST request to this endpoint, including
          the topicId parameter in the URL path and a JSON payload containing the details of the prompt to be created. This
          payload typically inc
        call: proompty-topic.post
        with:
          topicId: rest.topicId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/topics/{topicid}/prompts/{promptid}
      name: topics-topicid-prompts-promptid
      description: REST surface for topics-topicId-prompts-promptId.
      operations:
      - method: GET
        name: get
        description: Retrieve details about a specific prompt within a designated topic in the Proompty API. By sending a
          GET request to this endpoint with the corresponding topicId and promptId parameters, users can access information
          such as the prompt's cont
        call: proompty-topic.get
        with:
          topicId: rest.topicId
          promptId: rest.promptId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: Proompty Update a specific prompt within a designated topic. Users can send a PUT request to this endpoint
          with the corresponding topicId and promptId parameters, along with a JSON payload containing the updated prompt
          information. This ena
        call: proompty-topic.put
        with:
          topicId: rest.topicId
          promptId: rest.promptId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Remove a specific prompt associated with a particular topic. To utilize this endpoint, users send a DELETE
          request with the relevant topicId and promptId parameters. Upon successful execution, the specified prompt is permanently
          deleted fro
        call: proompty-topic.delete
        with:
          topicId: rest.topicId
          promptId: rest.promptId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/topics/{topicid}/prompts/{promptid}/chat
      name: topics-topicid-prompts-promptid-chat
      description: REST surface for topics-topicId-prompts-promptId-chat.
      operations:
      - method: POST
        name: post
        description: Retrieves user information within the Proompty API system. By sending a GET request to this endpoint,
          users can obtain detailed data pertaining to their profile and associated claims. This includes essential user attributes
          such as email, f
        call: proompty-topic.post
        with:
          topicId: rest.topicId
          promptId: rest.promptId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: proompty-topic-mcp
    port: 9090
    transport: http
    description: MCP adapter for Proompty — Topic. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: retrieve-details-about-specific-topic
      description: Retrieve details about a specific topic in the Proompty API. By sending a GET request to this endpoint
        with the corresponding topicId parameter, users can access information such as the topic's title, description, and
        any associated documen
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proompty-topic.get
      with:
        topicId: tools.topicId
        include: tools.include
      outputParameters:
      - type: object
        mapping: $.
    - name: update-details-specific-topic-proompty
      description: Update the details of a specific topic in the Proompty API. By sending a PUT request to this endpoint with
        the corresponding topicId parameter and the updated topic object in the request body, users can modify the topic's
        title, description
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: proompty-topic.put
      with:
        topicId: tools.topicId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-document-specific-topic-users
      description: Upload a document to a specific topic. Users can send a POST request to this endpoint with the relevant
        topicId parameter and a document file to upload a new document to the specified topic. The API responds with a JSON
        object containing th
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: proompty-topic.post
      with:
        topicId: tools.topicId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-details-about-specific-document
      description: Retrieve details about a specific document within a designated topic in the Proompty API. By sending a
        GET request to this endpoint with the corresponding topicId and documentId parameters, users can access information
        such as the document'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proompty-topic.get
      with:
        topicId: tools.topicId
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-specific-document-within-designated
      description: Delete a specific document within a designated topic in the Proompty API. Users can send a DELETE request
        to this endpoint with the relevant topicId and documentId parameters to remove the specified document from the topic.
        The API responds
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: proompty-topic.delete
      with:
        topicId: tools.topicId
        documentId: tools.documentId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-list-all-prompts-associated
      description: Retrieve a list of all prompts associated with a specific topic. Users can send a GET request to this endpoint
        with the relevant topicId parameter to access comprehensive information about each prompt within the specified topic.
        The API res
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proompty-topic.get
      with:
        topicId: tools.topicId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-prompts-within-specified
      description: Create a new prompts within a specified topic. Users can send a POST request to this endpoint, including
        the topicId parameter in the URL path and a JSON payload containing the details of the prompt to be created. This
        payload typically inc
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: proompty-topic.post
      with:
        topicId: tools.topicId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-details-about-specific-prompt
      description: Retrieve details about a specific prompt within a designated topic in the Proompty API. By sending a GET
        request to this endpoint with the corresponding topicId and promptId parameters, users can access information such
        as the prompt's cont
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: proompty-topic.get
      with:
        topicId: tools.topicId
        promptId: tools.promptId
      outputParameters:
      - type: object
        mapping: $.
    - name: proompty-update-specific-prompt-within
      description: Proompty Update a specific prompt within a designated topic. Users can send a PUT request to this endpoint
        with the corresponding topicId and promptId parameters, along with a JSON payload containing the updated prompt information.
        This ena
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: proompty-topic.put
      with:
        topicId: tools.topicId
        promptId: tools.promptId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-specific-prompt-associated-particular
      description: Remove a specific prompt associated with a particular topic. To utilize this endpoint, users send a DELETE
        request with the relevant topicId and promptId parameters. Upon successful execution, the specified prompt is permanently
        deleted fro
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: proompty-topic.delete
      with:
        topicId: tools.topicId
        promptId: tools.promptId
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-user-information-within-proompty
      description: Retrieves user information within the Proompty API system. By sending a GET request to this endpoint, users
        can obtain detailed data pertaining to their profile and associated claims. This includes essential user attributes
        such as email, f
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: proompty-topic.post
      with:
        topicId: tools.topicId
        promptId: tools.promptId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.