> For the complete documentation index, see [llms.txt](https://docs.mikopbx.com/mikopbx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mikopbx.com/mikopbx/english/modules/miko/module-cloud-speech-to-text/rest-api.md).

# REST API

Route descriptions

The module lets you retrieve completed transcripts and perform other actions through its REST API. This can be useful for integrations with external systems. The most important REST API information is provided below.\
\
Base path:

```
/pbxcore/api/v3/module-cloud-speech-to-text
```

| Purpose                    | Endpoint                         |
| -------------------------- | -------------------------------- |
| Summary and status         | `GET /dashboard`, `GET /health`  |
| Selection rules            | `GET/PATCH /rule-sets/current`   |
| Mode and retention         | `GET/PATCH /settings`            |
| Connection check           | `POST /connection-checks`        |
| Processing control         | `GET/PATCH /processing-controls` |
| Job queue                  | `GET /jobs`                      |
| Job cancellation and retry | `POST /job-cancellations`        |
| Transcript list            | `GET /transcripts`               |
| Transcript export          | `GET /transcript-exports/{id}`   |
| Module log                 | `GET /logs`                      |
| Diagnostic archives        | `GET/POST /diagnostic-reports`   |
| Transcript lookup by call  | `GET /cdr-transcript-lookups`    |

**Integrations: call-transcripts**

External modules read completed transcripts through two dedicated resources: `GET /call-transcripts` and `GET /call-transcript-events`. These resources accept only a dedicated integration key and return the complete immutable transcript contract: segments, merged turns, and plain text.

The identification scheme ensures that an external system does not repeat its analysis after a clean reinstallation of the module:

* `call_id` — a stable Asterisk call identifier (`linkedid`, or `UNIQUEID` when `linkedid` is empty);
* `source_instance_id` — the module installation identifier;
* `semantic_hash` — a hash of the transcript content using the `call-transcript-analysis-v1` profile: it matches only if the text, participants, and timings have not changed.

The `call-transcript.completed`, `call-transcript.updated`, and `call-transcript.deleted` events are delivered through cursor-based pagination and are idempotent. The public contract schema is `call-transcript.v1`. After a transcript is deleted, events no longer expose `call_id` or hashes.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mikopbx.com/mikopbx/english/modules/miko/module-cloud-speech-to-text/rest-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.