XRToken API Docs

Query meeting-minutes task status

API Configuration
After saving, the Try It panel below sends real requests with this key.
Base: api.xrtoken.ai

Poll a minutes task. Recommended interval ≥ 30 seconds. Do not poll faster than that: xrtoken-minutes summary is finished by the server poller, not by GET.

  • processing: still running
  • succeeded: xrtoken-minutes includes report / transcription / summary / chapters / extraction. Report quality is complete or partial (needs review). Historical tasks may omit report; use legacy fields. doubao-minutes may also include extraction / translation.
  • failed: inspect error. When only the summary failed, report / transcription / usage remain available, with transcription_status=succeeded, summary_status=failed, and report.quality.status=unavailable. Completed ASR and observed summary usage are settled; the remaining reservation is released. ASR failure releases the reservation.

xrtoken-minutes summary generation has an independent 30-minute limit; timeout adds summary_timeout to report.quality.issues. GET and list also present historical unavailable-summary results as failed without rewriting source data, billing, or timestamps. No automatic retry occurs. Submit this task_id to POST /v1/summaries to explicitly generate a new summary.

GET
/v1/audio/minutes/{taskId}

Authorization

BearerAuth
AuthorizationBearer <token>

API key authentication (OpenAI format). Pass in the Authorization header:

Authorization: Bearer tr-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

In: header

Path Parameters

taskId*string

Task ID returned by POST /v1/audio/minutes

Response Body

application/json

application/json

application/json

curl -X get "https://api.xrtoken.ai/v1/audio/minutes/string"
{
  "id": "string",
  "model": "string",
  "status": "processing",
  "transcription_status": "succeeded",
  "summary_status": "succeeded",
  "report": {
    "version": 2,
    "metadata": {
      "title": "string",
      "recordedAt": "string",
      "timezone": "string",
      "durationMs": 0
    },
    "overview": {
      "content": [
        {
          "type": "text",
          "text": "string"
        }
      ],
      "sourceSegmentIds": [
        "string"
      ],
      "verification": "sourced"
    },
    "keyPoints": [
      {
        "content": [
          {
            "type": "text",
            "text": "string"
          }
        ],
        "sourceSegmentIds": [
          "string"
        ],
        "verification": "sourced"
      }
    ],
    "sections": [
      {
        "id": "string",
        "heading": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "paragraphs": [
          {
            "content": [
              {
                "type": "text",
                "text": "string"
              }
            ],
            "sourceSegmentIds": [
              "string"
            ],
            "verification": "sourced"
          }
        ],
        "bullets": [
          {
            "content": [
              {
                "type": "text",
                "text": "string"
              }
            ],
            "sourceSegmentIds": [
              "string"
            ],
            "verification": "sourced"
          }
        ],
        "children": [
          {
            "id": "string",
            "heading": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            },
            "paragraphs": [
              {
                "content": [
                  {
                    "type": "text",
                    "text": "string"
                  }
                ],
                "sourceSegmentIds": [
                  "string"
                ],
                "verification": "sourced"
              }
            ],
            "bullets": [
              {
                "content": [
                  {
                    "type": "text",
                    "text": "string"
                  }
                ],
                "sourceSegmentIds": [
                  "string"
                ],
                "verification": "sourced"
              }
            ],
            "children": []
          }
        ]
      }
    ],
    "chapters": [
      {
        "id": "string",
        "heading": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "summary": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "startSegmentId": "string",
        "endSegmentId": "string",
        "startMs": 0,
        "endMs": 0,
        "children": [
          {
            "id": "string",
            "heading": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            },
            "summary": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            },
            "startSegmentId": "string",
            "endSegmentId": "string",
            "startMs": 0,
            "endMs": 0,
            "children": []
          }
        ]
      }
    ],
    "todos": [
      {
        "id": "string",
        "action": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "assigneeSpeakerId": "string",
        "assignmentQuote": "string",
        "deadline": "string",
        "status": "pending"
      }
    ],
    "decisions": [
      {
        "id": "string",
        "question": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "options": [
          {
            "proposal": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            },
            "proposerSpeakerId": "string"
          }
        ],
        "conclusion": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "basis": [
          {
            "content": [
              {
                "type": "text",
                "text": "string"
              }
            ],
            "sourceSegmentIds": [
              "string"
            ],
            "verification": "sourced"
          }
        ],
        "status": "proposed",
        "confirmationQuote": "string"
      }
    ],
    "quotes": [
      {
        "id": "string",
        "text": "string",
        "speakerId": "string",
        "startMs": 0,
        "endMs": 0,
        "reason": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "sourceSegmentIds": [
          "string"
        ]
      }
    ],
    "reviewItems": [
      {
        "id": "string",
        "kind": "proper_noun",
        "originalText": "string",
        "candidates": [
          "string"
        ],
        "sourceSegmentIds": [
          "string"
        ],
        "status": "pending"
      }
    ],
    "visuals": [
      {
        "id": "string",
        "type": "hierarchy",
        "origin": "summary_structure",
        "heading": {
          "content": [
            {
              "type": "text",
              "text": "string"
            }
          ],
          "sourceSegmentIds": [
            "string"
          ],
          "verification": "sourced"
        },
        "nodes": [
          {
            "id": "string",
            "label": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            },
            "children": [
              {
                "id": "string",
                "label": {
                  "content": [
                    {
                      "type": "text",
                      "text": "string"
                    }
                  ],
                  "sourceSegmentIds": [
                    "string"
                  ],
                  "verification": "sourced"
                },
                "children": []
              }
            ]
          }
        ],
        "edges": [
          {
            "id": "string",
            "from": "string",
            "to": "string",
            "relation": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            }
          }
        ],
        "columns": [
          {
            "id": "string",
            "label": {
              "content": [
                {
                  "type": "text",
                  "text": "string"
                }
              ],
              "sourceSegmentIds": [
                "string"
              ],
              "verification": "sourced"
            }
          }
        ],
        "rows": [
          {
            "id": "string",
            "cells": [
              {
                "content": [
                  {
                    "type": "text",
                    "text": "string"
                  }
                ],
                "sourceSegmentIds": [
                  "string"
                ],
                "verification": "sourced"
              }
            ]
          }
        ]
      }
    ],
    "speakers": [
      {
        "id": "string",
        "displayName": "string"
      }
    ],
    "segments": [
      {
        "id": "string",
        "text": "string",
        "startMs": 0,
        "endMs": 0,
        "speakerId": "string"
      }
    ],
    "quality": {
      "status": "complete",
      "issues": [
        {
          "code": "string",
          "path": "string"
        }
      ]
    }
  },
  "transcription": null,
  "summary": null,
  "chapters": null,
  "extraction": null,
  "translation": null,
  "usage": {
    "duration_ms": 0,
    "features": [
      "string"
    ],
    "all_activate": true,
    "engine": "string",
    "rate_per_hour": 0,
    "amount": 0,
    "asr_amount": 0,
    "flash_amount": 0,
    "flash_input_tokens": 0,
    "flash_output_tokens": 0
  },
  "error": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "error": "invalid or missing API key",
  "type": "auth_error"
}
{
  "error": "string",
  "type": "invalid_request_error"
}