Mintlify

App · 18 actions

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

Actions

ActionWhat it does
Create agent jobCreate agent job.
Get agent jobGet agent job.
Get an assistant conversation threadGet an assistant conversation thread.
Get assistant caller statsGet assistant caller stats.
Get assistant conversationsGet assistant conversations.
Get deployment statusGet update status.
Get feedback by pageGet feedback by page.
Get page contentGet page content.
Get page viewsGet page views.
Get search queriesGet search queries.
Get unique visitorsGet unique visitors.
Get user feedbackGet user feedback.
Search documentationSearch documentation.
Send follow-up messageSend follow-up message.
Trigger automationTrigger automation.
Trigger automation webhookTrigger automation webhook.
Trigger deploymentTrigger update.
Trigger preview deploymentTrigger preview deployment.

Create agent job

Create agent job.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
PromptprompttextRequired
The instruction for the agent to execute.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "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 IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
IdidtextRequired
The unique identifier of the agent job.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "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 IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Thread IDthread_idtextRequired
Thread id for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "createdAt": "example",
    "messages": [],
    "threadId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get assistant caller stats

Get assistant caller stats.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "api": 1,
    "other": 1,
    "total": 1,
    "web": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get assistant conversations

Get assistant conversations.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.
Limitlimitnumber
Limit for this request.From 1 to 1000.
Cursorcursortext
Cursor for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "conversations": [],
    "hasMore": false,
    "nextCursor": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get deployment status

Get update status.

Inputs

Status IDstatus_idtextRequired
The status ID of a triggered update.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "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 IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.
Limitlimitnumber
Limit for this request.From 1 to 100.
Sourcesourcetext
Source for this request.One of: code_snippet, contextual, agent, thumbs_only.
Statusstatustext
Status for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "feedback": [],
    "hasMore": false
  },
  "has_more": false,
  "next_cursor": null
}

Get page content

Get page content.

Inputs

DomaindomaintextRequired
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.
PathpathtextRequired
The page slug or path to retrieve content for. This corresponds to the path field returned by the [Search documentation](/api/assistant/search) endpoint.
Groupsgroupslist
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.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "content": "example",
    "path": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get page views

Get page views.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.
Limitlimitnumber
Limit for this request.From 1 to 250.
Offsetoffsetnumber
Offset for this request.At least 0.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "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 IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.
Limitlimitnumber
Limit for this request.From 1 to 100.
Cursorcursortext
Cursor for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "nextCursor": "example",
    "searches": [],
    "totalSearches": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get unique visitors

Get unique visitors.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.
Limitlimitnumber
Limit for this request.From 1 to 250.
Offsetoffsetnumber
Offset for this request.At least 0.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "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 IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Date fromdate_fromdate
Date from for this request.
Date todate_todate
Date to for this request.
Sourcesourcetext
Source for this request.One of: code_snippet, contextual, agent, thumbs_only.
Statusstatustext
Status for this request.
Limitlimitnumber
Limit for this request.From 1 to 100.
Cursorcursortext
Cursor for this request.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "feedback": [],
    "hasMore": false,
    "nextCursor": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Search documentation

Search documentation.

Inputs

DomaindomaintextRequired
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.
QueryquerytextRequired
The search query to execute against your documentation content.
Page sizepage_sizenumber
Number of search results to return. Must be between 1 and 50. Defaults to 10 if not specified.From 1 to 50.
Score thresholdscore_thresholdnumber
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.
Filterfilterobject
Optional filtering parameters to narrow search results.

Outputs

Value.

datalist
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Send follow-up message

Send follow-up message.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
IdidtextRequired
The unique identifier of the agent job to send a message to.
PromptprompttextRequired
The follow-up instruction for the agent.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "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 IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Workflow schema IDworkflow_schema_idtextRequired
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.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "instanceId": "example",
    "jobId": "example",
    "schemaId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Trigger automation webhook

Trigger automation webhook.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
Workflow schema IDworkflow_schema_idtextRequired
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.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "runId": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}

Trigger deployment

Trigger update.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.

Outputs

Value.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "statusId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Trigger preview deployment

Trigger preview deployment.

Inputs

Project IDproject_idtext
Leave empty to use the project saved in your connection, or enter another project ID.
BranchbranchtextRequired
The name of the Git branch to create a preview deployment for.
Authauthobject
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.

dataobject
Response from the service.
has_moretrue/false
Whether another page is available.
next_cursortext
Next page cursor; empty when there are no more pages.
Example output
{
  "data": {
    "previewUrl": "example",
    "statusId": "example"
  },
  "has_more": false,
  "next_cursor": null
}

On this page