Mintlify

Mintlify is an AI-native intelligent documentation platform designed for the next generation of technical documentation, combining beautiful out-of-the-box design with advanced collaboration and AI capabilities.

5 APIs 0 Features

Documentation

APIs

Mintlify

Mintlify is a developer documentation platform that helps product and engineering teams create, maintain, and host modern docs. It uses a docs‑as‑code workflow (Markdown in your...

Mintlify Update API

The Mintlify Update API allows you to programmatically trigger deployment updates for your documentation project and check update status. You can queue a deployment update from ...

Mintlify Agent API

The Mintlify Agent API enables you to programmatically automate documentation editing through agent jobs. You can create agent jobs that generate and edit documentation based on...

Mintlify Assistant API

The Mintlify Assistant API allows you to embed the AI chat experience grounded in your documentation into any application. You can generate assistant messages trained on your do...

Mintlify Analytics API

The Mintlify Analytics API enables you to export user feedback and assistant conversation history from your documentation for external analysis. You can retrieve user feedback r...

Collections

Mintlify API

OPEN

Pricing Plans

Mintlify Plans Pricing

4 plans

PLANS

Rate Limits

Mintlify Rate Limits

3 limits

RATE LIMITS

FinOps

Mintlify Finops

FINOPS

JSON Structure

Mintlify Structure

0 properties

JSON STRUCTURE

Resources

AgentSkills

Documentation

GettingStarted

PrivacyPolicy

TermsOfService

SalesContact

Testimonials

ResponsibleDisclosure

ResponsibleDisclosure

Sources

opencollection: 1.0.0
info:
  name: Mintlify API
  version: '1.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Update
    type: folder
  items:
  - info:
      name: Trigger documentation update
      type: http
    http:
      method: POST
      url: https://api.mintlify.com/v1/project/update/:projectId
      params:
      - name: projectId
        value: ''
        type: path
    docs: Trigger documentation update
  - info:
      name: Get update status
      type: http
    http:
      method: GET
      url: https://api.mintlify.com/v1/project/update-status/:statusId
      params:
      - name: statusId
        value: ''
        type: path
    docs: Get update status
- info:
    name: Agent
    type: folder
  items:
  - info:
      name: Create agent job
      type: http
    http:
      method: POST
      url: https://api.mintlify.com/v1/agent/:projectId/job
      params:
      - name: projectId
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create agent job
  - info:
      name: Get agent job
      type: http
    http:
      method: GET
      url: https://api.mintlify.com/v1/agent/:projectId/job/:id
      params:
      - name: projectId
        value: ''
        type: path
      - name: id
        value: ''
        type: path
    docs: Get agent job
- info:
    name: Assistant
    type: folder
  items:
  - info:
      name: Create assistant message
      type: http
    http:
      method: POST
      url: https://api.mintlify.com/discovery/v2/assistant/:domain/message
      params:
      - name: domain
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Generate an AI assistant response grounded in your documentation.
  - info:
      name: Search documentation
      type: http
    http:
      method: POST
      url: https://api.mintlify.com/discovery/v1/search/:domain
      params:
      - name: domain
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Search documentation
- info:
    name: Analytics
    type: folder
  items:
  - info:
      name: Get user feedback
      type: http
    http:
      method: GET
      url: https://api.mintlify.com/v1/analytics/feedback
    docs: Get user feedback
  - info:
      name: Get assistant conversations
      type: http
    http:
      method: GET
      url: https://api.mintlify.com/v1/analytics/conversations
    docs: Get assistant conversations
bundled: true