Skip to main content
Mintlify logo

​
Overview

Add Mintlify to any ModuleX agent or workflow. Documentation platform with AI-powered assistant chat, semantic search, and project update triggers against the Mintlify REST APIs (api-dsc.mintlify.com/v1 and api.mintlify.com/v1).
Categories: Developer Tools & Infrastructure · Documentation · Auth: Mintlify API Keys · Actions: 3

​
Authentication

​
Mintlify API Keys

Authenticate using Mintlify assistant API key, admin API key, and project ID. Different actions use different credentials.

​
Required Credentials

FieldDescriptionRequiredFormat
Assistant API KeyYour Mintlify Assistant API key for chat and search endpoints.Yes-
Admin API KeyYour Mintlify Admin API key for triggering project updates.Yes-
Project IDYour Mintlify project ID used for update triggers.Yes-

​
Available Actions

​
Parameters

​
domain
string
required
The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.
​
fp
string
required
Browser fingerprint or arbitrary string identifier for message tracking.
​
message
string
required
The content of the message to send to the assistant.

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "message_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message Id"
    },
    "response": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Response"
    }
  },
  "required": [
    "success"
  ],
  "title": "ChatWithAssistantOutput",
  "type": "object"
}

​
Parameters

​
domain
string
required
The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.
​
query
string
required
The search query to execute against your documentation content.
​
page_size
integer
Number of search results to return. Defaults to 10 if not specified.
​
version
string
Filter results by documentation version.
​
language
string
Filter results by content language.

​
Response

{
  "$defs": {
    "SearchResultItem": {
      "additionalProperties": false,
      "description": "A single search result from the documentation.",
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Title"
        },
        "url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Url"
        },
        "content": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Content"
        },
        "score": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Score"
        }
      },
      "title": "SearchResultItem",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "results": {
      "items": {
        "$ref": "#/$defs/SearchResultItem"
      },
      "title": "Results",
      "type": "array"
    },
    "total": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Total"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchDocumentationOutput",
  "type": "object"
}

​
Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "TriggerUpdateOutput",
  "type": "object"
}

​
Limits & Quotas

  • No publicly documented rate limits for the Mintlify API.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising.

Algolia

Amazon Web Services

Apify