integrations

Resume an export (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/exports/{id}/resume
Access token

Re-queues a failed, cancelled or stuck in-progress export so its next run reuses the conversations an earlier attempt finished, keeping its checkpoints and progress counters. Only conversation PDF exports can be resumed; other exports and other statuses return 400, an unknown export 404, and 403 while export resume is turned off. Super admin only.

Path parameters

  • id string Required

    Id of the export to resume

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • exportId string Required
      • resumed boolean Required

        Always true on a successful response: the export has been re-queued and will restore what a previous attempt finished.

      • resumedFrom string Required

        The status the export was resumed from. Only failed, cancelled and inprogress (the stuck case) exports can be resumed.

        Values are not-started, inprogress, completed, failed, or cancelled.

      • attemptCount number Required

        How many times this export has been re-started. Counts resumes only — a first run and a re-run do not bump it.

      • restorableConversations number Required

        Conversations a previous attempt already finished and checkpointed — an upper bound on what this run restores, not a promise: a checkpoint is only reused when it was rendered with the same render settings this run picks up, and anything else is re-rendered. Zero is a legitimate resume: an export that died on its first conversation simply starts over.

      • message string Required

        Plain-English summary of what happened, safe to show as-is.

    • statusCode number Required
    • timestamp string(date-time) Required
POST /admin/exports/{id}/resume 
curl \
 --request POST 'http://api.example.com/admin/exports/{id}/resume' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "exportId": "65a1b2c3d4e5f6a7b8c9d0f1",
    "resumed": true,
    "resumedFrom": "failed",
    "attemptCount": 1,
    "restorableConversations": 12,
    "message": "Export re-queued; it restores up to 12 finished conversations."
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}