Mintlify API

naftiko: 1.0.0-alpha2
info:
  label: Mintlify API
  description: Mintlify provides a suite of APIs for managing documentation deployments, automating documentation editing
    through agents, embedding AI assistants, and exporting analytics. Endpoints span the Update, Agent, Assistant, and Analytics
    APIs.
  tags:
  - Mintlify
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: mintlify
    baseUri: https://api.mintlify.com
    description: Mintlify API HTTP API.
    authentication:
      type: bearer
      token: '{{MINTLIFY_TOKEN}}'
    resources:
    - name: v1-project-update-projectid
      path: /v1/project/update/{projectId}
      operations:
      - name: triggerupdate
        method: POST
        description: Trigger documentation update
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-project-update-status-statusid
      path: /v1/project/update-status/{statusId}
      operations:
      - name: getupdatestatus
        method: GET
        description: Get update status
        inputParameters:
        - name: statusId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-agent-projectid-job
      path: /v1/agent/{projectId}/job
      operations:
      - name: createagentjob
        method: POST
        description: Create agent job
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-agent-projectid-job-id
      path: /v1/agent/{projectId}/job/{id}
      operations:
      - name: getagentjob
        method: GET
        description: Get agent job
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: discovery-v2-assistant-domain-message
      path: /discovery/v2/assistant/{domain}/message
      operations:
      - name: createassistantmessage
        method: POST
        description: Create assistant message
        inputParameters:
        - name: domain
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: discovery-v1-search-domain
      path: /discovery/v1/search/{domain}
      operations:
      - name: searchdocs
        method: POST
        description: Search documentation
        inputParameters:
        - name: domain
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-analytics-feedback
      path: /v1/analytics/feedback
      operations:
      - name: getfeedback
        method: GET
        description: Get user feedback
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-analytics-conversations
      path: /v1/analytics/conversations
      operations:
      - name: getconversations
        method: GET
        description: Get assistant conversations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: mintlify-rest
    description: REST adapter for Mintlify API.
    resources:
    - path: /v1/project/update/{projectId}
      name: triggerupdate
      operations:
      - method: POST
        name: triggerupdate
        description: Trigger documentation update
        call: mintlify.triggerupdate
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/project/update-status/{statusId}
      name: getupdatestatus
      operations:
      - method: GET
        name: getupdatestatus
        description: Get update status
        call: mintlify.getupdatestatus
        with:
          statusId: rest.statusId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agent/{projectId}/job
      name: createagentjob
      operations:
      - method: POST
        name: createagentjob
        description: Create agent job
        call: mintlify.createagentjob
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agent/{projectId}/job/{id}
      name: getagentjob
      operations:
      - method: GET
        name: getagentjob
        description: Get agent job
        call: mintlify.getagentjob
        with:
          projectId: rest.projectId
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /discovery/v2/assistant/{domain}/message
      name: createassistantmessage
      operations:
      - method: POST
        name: createassistantmessage
        description: Create assistant message
        call: mintlify.createassistantmessage
        with:
          domain: rest.domain
        outputParameters:
        - type: object
          mapping: $.
    - path: /discovery/v1/search/{domain}
      name: searchdocs
      operations:
      - method: POST
        name: searchdocs
        description: Search documentation
        call: mintlify.searchdocs
        with:
          domain: rest.domain
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/feedback
      name: getfeedback
      operations:
      - method: GET
        name: getfeedback
        description: Get user feedback
        call: mintlify.getfeedback
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/conversations
      name: getconversations
      operations:
      - method: GET
        name: getconversations
        description: Get assistant conversations
        call: mintlify.getconversations
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: mintlify-mcp
    transport: http
    description: MCP adapter for Mintlify API for AI agent use.
    tools:
    - name: triggerupdate
      description: Trigger documentation update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mintlify.triggerupdate
      with:
        projectId: tools.projectId
      inputParameters:
      - name: projectId
        type: string
        description: projectId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getupdatestatus
      description: Get update status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mintlify.getupdatestatus
      with:
        statusId: tools.statusId
      inputParameters:
      - name: statusId
        type: string
        description: statusId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: createagentjob
      description: Create agent job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mintlify.createagentjob
      with:
        projectId: tools.projectId
      inputParameters:
      - name: projectId
        type: string
        description: projectId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getagentjob
      description: Get agent job
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mintlify.getagentjob
      with:
        projectId: tools.projectId
        id: tools.id
      inputParameters:
      - name: projectId
        type: string
        description: projectId
        required: true
      - name: id
        type: string
        description: id
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: createassistantmessage
      description: Create assistant message
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mintlify.createassistantmessage
      with:
        domain: tools.domain
      inputParameters:
      - name: domain
        type: string
        description: domain
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: searchdocs
      description: Search documentation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: mintlify.searchdocs
      with:
        domain: tools.domain
      inputParameters:
      - name: domain
        type: string
        description: domain
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getfeedback
      description: Get user feedback
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mintlify.getfeedback
      outputParameters:
      - type: object
        mapping: $.
    - name: getconversations
      description: Get assistant conversations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: mintlify.getconversations
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    MINTLIFY_TOKEN: MINTLIFY_TOKEN