Search Documentation with Mintlify API

Pipedream makes it easy to connect APIs for Mintlify and 2,800+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search Documentation with the Mintlify API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Search Documentation with the Mintlify API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Documentation action
1. Connect your Mintlify account
2. Configure Domain
3. Configure Search Query
4. Optional- Configure Page Size
5. Optional- Configure Version
6. Optional- Configure Language
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search Documentation with Mintlify API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Mintlify

Try it

Search Documentation with Mintlify API on New Submission from Typeform API

Typeform + Mintlify

Try it

Search Documentation with Mintlify API on New Submission (Instant) from Jotform API

Jotform + Mintlify

Try it

Search Documentation with Mintlify API on New Scheduled Tasks from Pipedream API

Pipedream + Mintlify

Try it

Search Documentation with Mintlify API on New Download Counts from npm API

npm + Mintlify

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search Documentation on Mintlify

Description:Perform semantic and keyword searches across your documentation. [See the documentation](https://www.mintlify.com/docs/api-reference/assistant/search)

Version:0.0.1

Key:mintlify-search-documentation

View on GitHub

Code#

import mintlify from "../../mintlify.app.mjs";

export default {
  key: "mintlify-search-documentation",
  name: "Search Documentation",
  description: "Perform semantic and keyword searches across your documentation. [See the documentation](https://www.mintlify.com/docs/api-reference/assistant/search)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    mintlify,
    domain: {
      propDefinition: [
        mintlify,
        "domain",
      ],
    },
    query: {
      type: "string",
      label: "Search Query",
      description: "The search query to execute against your documentation content",
    },
    pageSize: {
      type: "integer",
      label: "Page Size",
      description: "Number of search results to return. Defaults to 10 if not specified",
      optional: true,
    },
    version: {
      type: "string",
      label: "Version",
      description: "Filter results by documentation version",
      optional: true,
    },
    language: {
      type: "string",
      label: "Language",
      description: "Filter results by content language",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.mintlify.searchDocumentation({
      $,
      domain: this.domain,
      data: {
        query: this.query,
        pageSize: this.pageSize,
        filter: this.version || this.language
          ? {
            version: this.version,
            language: this.language,
          }
          : undefined,
      },
    });

    $.export("$summary", `Found ${response.length} results`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Mintlify	`mintlify`	`app`	This component uses the Mintlify app.
Domain	`domain`	`string`	The domain identifier from your domain.mintlify.app URL. Can be found in the top left of your dashboard.
Search Query	`query`	`string`	The search query to execute against your documentation content
Page Size	`pageSize`	`integer`	Number of search results to return. Defaults to 10 if not specified
Version	`version`	`string`	Filter results by documentation version
Language	`language`	`string`	Filter results by content language