# Mintlify

> Connect Mintlify to manage your account records and automate everyday work.

App · 18 actions. Web page: https://docs.lodol.com/docs/integrations/mintlify

## Actions

### Create agent job

Create agent job.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Prompt (`prompt`, text, required): The instruction for the agent to execute.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "archivedAt": "2026-10-01T12:00:00Z",
    "createdAt": "2026-10-01T12:00:00Z",
    "id": "example",
    "model": "example",
    "prLink": "https://github.com/org/repo/pull/123",
    "source": {
      "ref": "example",
      "repository": "example"
    },
    "status": "active"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get agent job

Get agent job.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Id (`id`, text, required): The unique identifier of the agent job.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "archivedAt": "2026-10-01T12:00:00Z",
    "createdAt": "2026-10-01T12:00:00Z",
    "id": "example",
    "model": "example",
    "prLink": "https://github.com/org/repo/pull/123",
    "source": {
      "ref": "example",
      "repository": "example"
    },
    "status": "active"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get an assistant conversation thread

Get an assistant conversation thread.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Thread ID (`thread_id`, text, required): Thread id for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "messages": [],
    "threadId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get assistant caller stats

Get assistant caller stats.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "api": 1,
    "other": 1,
    "total": 1,
    "web": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get assistant conversations

Get assistant conversations.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.
- Limit (`limit`, number): Limit for this request. From 1 to 1000.
- Cursor (`cursor`, text): Cursor for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "conversations": [],
    "hasMore": false,
    "nextCursor": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get deployment status

Get update status.

**Inputs**

- Status ID (`status_id`, text, required): The status ID of a triggered update.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "_id": "example",
    "author": {
      "avatarUrl": "example",
      "githubUserId": 1,
      "name": "example"
    },
    "commit": {
      "filesChanged": {
        "added": [],
        "modified": [],
        "removed": []
      },
      "message": "example",
      "ref": "example",
      "sha": "example"
    },
    "createdAt": "example",
    "endedAt": "example",
    "logs": [],
    "projectId": "example",
    "screenshot": "example",
    "screenshotDark": "example",
    "screenshotLight": "example",
    "source": "internal",
    "status": "queued",
    "subdomain": "example",
    "summary": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get feedback by page

Get feedback by page.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.
- Limit (`limit`, number): Limit for this request. From 1 to 100.
- Source (`source`, text): Source for this request. One of: `code_snippet`, `contextual`, `agent`, `thumbs_only`.
- Status (`status`, text): Status for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "feedback": [],
    "hasMore": false
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get page content

Get page content.

**Inputs**

- Domain (`domain`, text, required): The domain identifier from your domain.mintlify.site URL. Can be found at the end of your dashboard URL. For example, app.mintlify.com/organization/domain has a domain identifier of domain.
- Path (`path`, text, required): The page slug or path to retrieve content for. This corresponds to the path field returned by the [Search documentation](/api/assistant/search) endpoint.
- Groups (`groups`, list): Optional documentation groups that narrow results. The assistant API key can read all content, including protected pages. If omitted or empty, includes protected pages in results. Mintlify doesn't verify group membership, so your backend must choose the groups for each user. On password-protected deployments, groups doesn't restrict anything.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "content": "example",
    "path": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get page views

Get page views.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.
- Limit (`limit`, number): Limit for this request. From 1 to 250.
- Offset (`offset`, number): Offset for this request. At least 0.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "hasMore": false,
    "totals": {
      "ai": 1,
      "human": 1,
      "total": 1
    },
    "views": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get search queries

Get search queries.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.
- Limit (`limit`, number): Limit for this request. From 1 to 100.
- Cursor (`cursor`, text): Cursor for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "nextCursor": "example",
    "searches": [],
    "totalSearches": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get unique visitors

Get unique visitors.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.
- Limit (`limit`, number): Limit for this request. From 1 to 250.
- Offset (`offset`, number): Offset for this request. At least 0.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "hasMore": false,
    "totals": {
      "ai": 1,
      "human": 1,
      "total": 1
    },
    "visitors": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get user feedback

Get user feedback.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Date from (`date_from`, date): Date from for this request.
- Date to (`date_to`, date): Date to for this request.
- Source (`source`, text): Source for this request. One of: `code_snippet`, `contextual`, `agent`, `thumbs_only`.
- Status (`status`, text): Status for this request.
- Limit (`limit`, number): Limit for this request. From 1 to 100.
- Cursor (`cursor`, text): Cursor for this request.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "feedback": [],
    "hasMore": false,
    "nextCursor": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Search documentation

Search documentation.

**Inputs**

- Domain (`domain`, text, required): The domain identifier from your domain.mintlify.site URL. Can be found at the end of your dashboard URL. For example, app.mintlify.com/organization/domain has a domain identifier of domain.
- Query (`query`, text, required): The search query to execute against your documentation content.
- Page size (`page_size`, number): Number of search results to return. Must be between 1 and 50. Defaults to 10 if not specified. From 1 to 50.
- Score threshold (`score_threshold`, number): Minimum relevance score for results. Only results with a score at or above this threshold are returned. Must be between 0 and 1. From 0 to 1.
- Filter (`filter`, object): Optional filtering parameters to narrow search results.

**Outputs**: Value.

- `data` (list): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Send follow-up message

Send follow-up message.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Id (`id`, text, required): The unique identifier of the agent job to send a message to.
- Prompt (`prompt`, text, required): The follow-up instruction for the agent.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "archivedAt": "2026-10-01T12:00:00Z",
    "createdAt": "2026-10-01T12:00:00Z",
    "id": "example",
    "model": "example",
    "prLink": "https://github.com/org/repo/pull/123",
    "source": {
      "ref": "example",
      "repository": "example"
    },
    "status": "active"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Trigger automation

Trigger automation.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Workflow schema ID (`workflow_schema_id`, text, required): The ID of the automation to trigger. Can be copied from the automation's settings panel in your [Automations](https://app.mintlify.com/settings/project/automations) settings.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "instanceId": "example",
    "jobId": "example",
    "schemaId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Trigger automation webhook

Trigger automation webhook.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Workflow schema ID (`workflow_schema_id`, text, required): The ID of the automation to trigger. Copy it from the automation's settings panel in your [Automations](https://app.mintlify.com/settings/project/automations) settings.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "runId": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}
```

### Trigger deployment

Trigger update.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "statusId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Trigger preview deployment

Trigger preview deployment.

**Inputs**

- Project ID (`project_id`, text): Leave empty to use the project saved in your connection, or enter another project ID.
- Branch (`branch`, text, required): The name of the Git branch to create a preview deployment for.
- Auth (`auth`, object): Access restriction to apply to the preview. Omit to leave the preview's current access settings unchanged. Requires a plan that includes preview authentication, and your site must have authentication or preview authentication enabled.

**Outputs**: Value.

- `data` (object): Response from the service.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Next page cursor; empty when there are no more pages.

**Example output**

```json
{
  "data": {
    "previewUrl": "example",
    "statusId": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
