integrations

Start a tag migration (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
POST /admin/tags/migrate
Access token

Queues a job that backfills the tag links (attachedTags) from the legacy tag fields of the listed collections (every registered collection when omitted), batchSize documents at a time (50 to 5000, 1000 by default), optionally as a dryRun. Returns the queued job, or 400 for a collection that is not registered. Super admin only.

application/json

Body Required

  • collections array[string]

    Specific collections to migrate. Empty/omitted = all 20.

  • batchSize number

    Default value is 1000.

  • dryRun boolean

    Default value is false.

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • jobId string Required
      • status string Required
      • collections array[object] Required
        Hide collections attributes Show collections attributes object
        • name string Required
        • total number Required
        • processed number Required
        • skipped number Required
        • errored number Required
        • startedAt string(date-time) | null
        • completedAt string(date-time) | null
      • lastError string | null
    • statusCode number Required
    • timestamp string(date-time) Required
POST /admin/tags/migrate 
curl \
 --request POST 'http://api.example.com/admin/tags/migrate' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "collections": [
    "string"
  ],
  "batchSize": 1000,
  "dryRun": false
}'
Request examples 
{
  "collections": [
    "string"
  ],
  "batchSize": 1000,
  "dryRun": false
}
Response examples (201) 
{
  "data": {
    "jobId": "65a1b2c3d4e5f6a7b8c9d0f2",
    "status": "running",
    "collections": [
      {
        "name": "devicemessages",
        "total": 50000,
        "processed": 12000,
        "skipped": 40,
        "errored": 0,
        "startedAt": "2026-01-15T10:15:00.000Z",
        "completedAt": "2026-05-04T09:42:00Z"
      }
    ],
    "lastError": "string"
  },
  "statusCode": 201,
  "timestamp": "2026-01-15T10:15:00.000Z"
}