canonical: https://jentic.com/apis/sfu.mirotalk.com/sfu-mirotalk

# Sfu Mirotalk MiroTalk SFU API

REST API for external applications that integrate with MiroTalk SFU video conferencing. Provides endpoints for managing meetings, generating join URLs, creating tokens, and retrieving statistics. The API exposes 6 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get meeting statistics, list all active meetings. Covers 6 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for productivity only.

## Capabilities

- Get meeting statistics
- List all active meetings
- Create a new meeting
- End a meeting
- Generate a direct join URL

## Use cases

### Productivity Operations

Use the MiroTalk SFU API to perform productivity operations programmatically. The API provides 6 endpoints covering core functionality including get meeting statistics, list all active meetings, create a new meeting.

Example prompt: Call GET /stats to get meeting statistics

### Automated Join Management

Automate join operations by combining multiple MiroTalk SFU API endpoints. Agents can list all active meetings and then create a new meeting in a single workflow.

Example prompt: Call GET /meetings to list all active meetings, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call MiroTalk SFU API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get meeting statistics', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/stats` | Get meeting statistics |
| GET | `/meetings` | List all active meetings |
| POST | `/meeting` | Create a new meeting |
| DELETE | `/meeting/{room}` | End a meeting |
| POST | `/join` | Generate a direct join URL |
| POST | `/token` | Create an authentication token |

## Key resources

- **Join** — Operations for join
- **Meeting** — Operations for meeting
- **Meetings** — Operations for meetings
- **Stats** — Operations for stats
- **Token** — Operations for token

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 65 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 79 / 100
- **View full report:** https://jentic.com/apis/sfu.mirotalk.com/sfu-mirotalk/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the MiroTalk SFU API by hand means setting its API key in the authorization header, pointing at the sfu.mirotalk.com host, and handling the room lifecycle calls yourself. Through Jentic you install once, import the MiroTalk SFU API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** MiroTalk SFU puts the room in the URL path (`/meeting/{room}`), so a rule can pin your agent to work against one room. You choose the operations it may call, so destructive ones like deleting a meeting are not included unless you add them.
- **Credential handling:** Your MiroTalk SFU API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get meeting statistics' or 'create a meeting room', and Jentic returns the matching MiroTalk SFU operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana** — Alternative productivity API
- **Monday** — Alternative productivity API
- **Clickup** — Complementary productivity API

## FAQ

### What authentication does the MiroTalk SFU API use?

The MiroTalk SFU API uses an API key passed in the `authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get meeting statistics with the MiroTalk SFU API?

Yes. Use the GET /stats endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the MiroTalk SFU API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get meeting statistics through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get meeting statistics'. Jentic returns the matching MiroTalk SFU API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the MiroTalk SFU API have?

The MiroTalk SFU API exposes 6 endpoints covering join, meeting, meetings operations.

### Can I limit what my agent is allowed to do with the MiroTalk SFU API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which MiroTalk SFU operations and credentials your agent may use. You pick the operations it can call, so read-only work like GET /stats or GET /meetings is available while destructive calls such as DELETE `/meeting/{room}` stay off unless you add them. Since the room is part of the URL path (`/meeting/{room}`), you can also pin the agent to a single room so it only acts against the meeting you allow.