Mintlify Agent API

Programmatic documentation editing via AI agent jobs.

Operations 2

POST /v1/agent/{projectId}/job Create agent job #
GET /v1/agent/{projectId}/job/{id} Get agent job #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/mintlify-agent-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mintlify-agent-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Mintlify Agent API
  description: Mintlify provides a suite of APIs for managing documentation deployments, automating documentation editing through agents, embedding AI assistants, and exporting analytics. Endpoints span the Update, Agent, Assistant, and Analytics APIs.
  version: '1.0'
  contact:
    name: Mintlify
    url: https://www.mintlify.com/docs/api/introduction
servers:
- url: https://api.mintlify.com
  description: Mintlify primary API server
- url: https://api.mintlify.com/discovery
  description: Discovery server (Assistant and Search APIs)
security:
- adminKey: []
tags:
- name: Agent
  description: Programmatic documentation editing via AI agent jobs.
paths:
  /v1/agent/{projectId}/job:
    post:
      tags:
      - Agent
      summary: Create agent job
      operationId: createAgentJob
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentJobRequest'
      responses:
        '200':
          description: Server-sent event stream of agent execution.
          content:
            text/event-stream:
              schema:
                type: string
  /v1/agent/{projectId}/job/{id}:
    get:
      tags:
      - Agent
      summary: Get agent job
      operationId: getAgentJob
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Agent job details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentJob'
components:
  schemas:
    AgentJob:
      type: object
      properties:
        sessionId:
          type: string
        subdomain:
          type: string
        branch:
          type: string
        haultReason:
          type: string
        pullRequestLink:
          type: string
        title:
          type: string
        createdAt:
          type: string
          format: date-time
    AgentJobRequest:
      type: object
      required:
      - messages
      properties:
        messages:
          type: array
          items:
            type: object
            properties:
              role:
                type: string
                enum:
                - user
                - system
                - assistant
              content:
                type: string
        branch:
          type: string
        asDraft:
          type: boolean
          default: false
        model:
          type: string
          enum:
          - sonnet
          - opus
          default: sonnet
  securitySchemes:
    adminKey:
      type: http
      scheme: bearer
      bearerFormat: mint_*
      description: Admin API key prefixed with mint_.
    assistantKey:
      type: http
      scheme: bearer
      bearerFormat: mint_dsc_*
      description: Public assistant API key prefixed with mint_dsc_.