Mintlify Integration

Field	Description	Required	Format
Assistant API Key	Your Mintlify Assistant API key for chat and search endpoints.	Yes	`-`
Admin API Key	Your Mintlify Admin API key for triggering project updates.	Yes	`-`
Project ID	Your Mintlify project ID used for update triggers.	Yes	`-`

chat_with_assistant — Generates a response message from the assistant for the specified domain.

Parameters

string

required

The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.

string

required

Browser fingerprint or arbitrary string identifier for message tracking.

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"
}

search_documentation — Perform semantic and keyword searches across your documentation.

Parameters

string

required

The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.

string

required

The search query to execute against your documentation content.

integer

Number of search results to return. Defaults to 10 if not specified.

string

Filter results by documentation version.

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"
}

trigger_update — Trigger an update for a project.

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"
}

Using

Providers

Building

Tools

Mintlify Integration for AI Agents & Workflows

Overview

Authentication

Mintlify API Keys

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Response

Limits & Quotas

Algolia

Amazon Web Services

Apify

Links

​Overview

​Authentication

​Mintlify API Keys

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Response

​Limits & Quotas

​Related integrations

Algolia

Amazon Web Services

Apify

​Links

Overview

Authentication

Mintlify API Keys

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Response

Limits & Quotas

Related integrations

Links