# Apžvalga

> Ką galima daryti su viešu Diko API ir nuo ko pradėti.

Šaltinis: https://diko.app/api-docs/apzvalga

## Kas yra Diko API

Diko API leidžia jūsų sistemoms skaityti susitikimus ir transkripcijų biblioteką (YouTube vaizdo įrašus ir įkeltus failus), importuoti YouTube vaizdo įrašus ir sužinoti apie pokyčius, niekam nespaudžiant mygtukų programėlėje. Tai REST API: JSON atsakymai, standartiniai HTTP statusai, autentifikacija `Bearer` raktu.

- **Bazinis URL:** `https://api.diko.app/api/v1`
- **Prieiga:** Verslo planas. Raktą susikuriate patys Diko programėlėje, skiltyje **Nustatymai → API** (`/settings/api`).
- **Versija:** `v1`. Suderinamumo pažadai aprašyti puslapyje [Versijos ir suderinamumas](https://diko.app/api-docs/versijos.md).

> **Pastaba:**
> API raktas negali kurti raktų. Raktus ir webhooks kuriate, keičiate ir atšaukiate tik prisijungę naršyklėje. Taip nutekėjęs raktas negali susikurti nuolatinio duomenų nutekėjimo kanalo.

## Ką galite daryti

| Sritis | Ką gaunate | Leidimas |
|---|---|---|
| Susitikimai | Metaduomenys, transkriptas (JSON, tekstas, SRT, VTT), protokolas, užduotys | `meetings:read` |
| Biblioteka | YouTube vaizdo įrašų ir įkeltų failų transkripcijos (`source_type`: `youtube` arba `upload`), segmentai, santraukos, skyriai | `library:read` |
| Importai | YouTube vaizdo įrašų importas į biblioteką (asinchroninis, su idempotentiškumu) | `library:write` |
| Įvykiai | Webhooks ir įvykių srautas `GET /events`, kad nereikėtų nuolat tikrinti būsenos | pagal turimus leidimus |

Pilną endpointų sąrašą rasite [API žinyne](https://diko.app/api-docs/zinynas.md).

## Pagrindiniai principai

- **Raktas priklauso naudotojui** ir mato tik tai, ką mato jo savininkas: savo susitikimus ir savo biblioteką (YouTube vaizdo įrašus ir įkeltus failus). Komandos nedalija duomenų, todėl komandos lygio raktų v1 nėra.
- **Svetimas arba neegzistuojantis resursas visada grąžina 404**, o ne 403, kad nebūtų atskleidžiama, ar jis egzistuoja.
- **JSON, `snake_case`.** Laikai: RFC 3339 UTC su milisekundėmis (`2026-10-11T09:30:00.000Z`). Trukmės: sveikieji skaičiai, laukai su priesaga `*_ms`. Kreditai: dešimtainės eilutės (`"123.5000"`).
- **Kiekvienas resursas turi `object`.** Null laukai pateikiami visada. Klientai turi ignoruoti nežinomus laukus, enum reikšmes ir įvykių tipus.
- **Kiekvienas atsakymas turi `Request-Id`** (`req_...`). Nurodykite jį kreipdamiesi į pagalbą.

### Viešų ID priešdėliai

ID yra neskaidrūs, iki 64 simbolių. Nepabandykite jų skaidyti ar kurti patys.

| Priešdėlis | Resursas |
|---|---|
| `usr_` | naudotojas |
| `key_` | API raktas |
| `mtg_` | susitikimas |
| `prt_` | dalyvis |
| `spk_` | įraše atpažintas dalyvis |
| `act_` | užduotis |
| `trn_` | bibliotekos transkripcija |
| `imp_` | importas |
| `evt_` | įvykis |
| `whe_` | webhook endpointas |
| `whd_` | webhook pristatymas |

## Nuo ko pradėti

1. [Greita pradžia](https://diko.app/api-docs/greita-pradzia.md): raktas, pirmas jūsų duomenų nuskaitymas, YouTube vaizdo įrašo importas ir transkripcijos skaitymas per kelias minutes.
2. [Autentifikacija ir raktai](https://diko.app/api-docs/autentifikacija.md): kaip veikia raktai ir jų gyvavimo ciklas.
3. [Leidimai](https://diko.app/api-docs/leidimai.md): kokį leidimą pasirinkti.
4. [Klaidos](https://diko.app/api-docs/klaidos.md), [Ribos](https://diko.app/api-docs/ribos.md), [Puslapiavimas](https://diko.app/api-docs/puslapiavimas.md) ir [Idempotentiškumas](https://diko.app/api-docs/idempotentiskumas.md): kaip parašyti patikimą klientą.
5. [Įvykiai ir webhooks](https://diko.app/api-docs/webhooks.md): kaip gauti pranešimus apie pokyčius.

## Ko v1 nedaro

- Nerašo į susitikimus: komentarų ir užduočių kūrimo nėra, protokolo pergeneruoti negalima.
- Nekeičia bendros transkriptų būsenos ir nenaudoja platformos LLM biudžeto, todėl vertimų nėra.
- Neturi `dk_test_` smėlio dėžės: raktas visada veikia su tikrais duomenimis.
- Webhooks ir raktai valdomi tik Diko programėlėje, o ne per API.

## Mašinoms ir agentams

Dokumentacija parašyta ir žmonėms, ir programoms:

- kiekvienas puslapis turi švarią Markdown versiją, pavyzdžiui, `/api-docs/klaidos.md`;
- turinio indeksas yra [`/api-docs/llms.txt`](https://diko.app/api-docs/llms.txt);
- visas API aprašas (OpenAPI 3.1) yra [`/api-docs/openapi.json`](https://diko.app/api-docs/openapi.json).