Nyaraka za API
Llumi Cut ni huduma ya HTTP. Unapakia faili, unatuma ratiba ya JSON na kupakua matokeo. Ukurasa huu unafupisha sehemu; schema kamili iliyokaguliwa iko kwenye /openapi.json katika kila usakinishaji.
Uthibitishaji
Kila usakinishaji una ufunguo wake. Utume kwenye kila njia ya /v1:
Authorization: Bearer <ufunguo-wako>Mtiririko
- Pakia kila faili kwa
POST /v1/assets?kind=image|video|audiona faili kama mwili wa binary. Inarudisha{"id": "…"}. - Weka kwenye foleni uhariri kwa
POST /v1/rendersna ratiba kama JSON. Tumia kichwaIdempotency-Keyili kujaribu tena kusiunde utengenezaji wa pili. - Uliza hali kwa
GET /v1/renders/{id}hadistatusiwecompleted, kisha pakua kila faili kutokaresult.files.
Endpoints
| Mbinu | Njia | Inachofanya |
|---|---|---|
| GET | /health | Hali ya huduma |
| POST | /v1/assets?kind=image|video|audio | Inapakia faili la binary na kurudisha kitambulisho chake |
| POST | /v1/renders | Inakagua ratiba na kuiweka kwenye foleni |
| GET | /v1/renders | Utengenezaji 100 wa hivi karibuni |
| GET | /v1/renders/{id} | Hali, maendeleo, matukio na makosa |
| POST | /v1/renders/{id}/cancel | Inaghairi utengenezaji ulio kwenye foleni au unaoendelea |
| POST | /v1/renders/{id}/retry | Inajaribu tena utengenezaji uliosimama |
| DELETE | /v1/renders/{id} | Inafuta utengenezaji uliosimama na faili zake |
| GET | /v1/renders/{id}/files/{name} | Inapakua matokeo moja |
| POST | /v1/maintenance/purge?older_than_days=N | Inafuta utengenezaji uliosimama wenye zaidi ya siku N |
Ratiba
Ni title, duration na clips tu zinazohitajika. Jumla ya urefu wa picha za video lazima ilingane na duration.
| Sehemu | Thamani |
|---|---|
duration | 3–600 s |
width · aspect | 640, 1280 au 1920 (upande mrefu) · 16:9, 9:16, 1:1 |
fps | 24 au 30 |
background | Rangi ya mistari ya pembeni, #RRGGBB |
transition · transition_duration | cut, fade, fadeblack, fadewhite, dissolve, slideleft, slideright, wipeleft, wiperight, smoothleft, smoothright, circleopen, circleclose · 0.1–2 s |
image_motion | none, zoom_in, zoom_out, pan_left, pan_right, auto |
fade_in · fade_out | Kufifia kwa video nzima na sauti yake, 0–5 s |
audio_asset_id · pauses | Wimbo mkuu wa hiari na hadi vituo kumi vya ukimya wa kidijitali |
Picha za video (clips[])
| Sehemu | Thamani |
|---|---|
asset_id · duration | Picha au video · hadi 60 s |
trim_start · speed | Sekunde ya kuanzia kwenye chanzo · 0.25–4 |
volume | Sauti ya klipu yenyewe, 0–2 (0 inaizima) |
fit | contain (yenye mistari) au cover (inajaza kwa kukata) |
freeze · motion | Inagandisha fremu ya kwanza · mwendo wa Ken Burns |
effects | Hadi sita kati ya grayscale, sepia, vintage, noir, warm, cool, blur, sharpen, vignette, invert, mirror, flip |
brightness · contrast · saturation | −0.5–0.5 · 0.3–2 · 0–3 |
transition · transition_duration | Mpito kutoka picha ya video iliyotangulia |
Sauti (audio_tracks[])
asset_id, start, trim_start, duration, volume (0–2), fade_in, fade_out, loop na duck. Wimbo wenye duck: true hupungua kwa takriban 10 dB wakati wimbo mkuu, sauti ya mtu au sauti ya klipu inapocheza.
Vichwa (texts[])
text (hadi mistari mitano), start, end, position (nafasi tisa) au x/y kama sehemu za fremu, size, color, outline_color, outline, box, box_color, box_opacity, font, bold, italic na animation (none, fade, slide_up, slide_left, pop, typewriter).
Tabaka (overlays[])
asset_id (picha au video), start, end, position au x/y, width, height (ukiweka zote mbili, kisanduku kinajazwa: skrini iliyogawanywa na gridi), margin, opacity, trim_start, volume, fade, border na border_color.
Manukuu (captions[])
start, end na text. Yanatolewa kama SRT na WebVTT na, kwa burn_subtitles: true, yanachomwa ndani ya picha.
Matokeo
video.mp4 (H.264 + AAC), audio.wav (wimbo wa sauti wa mwisho), song.wav (ikiwa tu kuna wimbo mkuu), subtitles.srt, subtitles.vtt, qc.json (urefu, ubora, vyanzo vya sauti, maonyo) na manifest.json.
Mipaka
- Faili hadi 250 MB, picha hadi 8192 × 8192 na media hadi 610 s.
- Hadi picha za video 150, nyimbo za sauti 20, tabaka 20, vichwa 100 na manukuu 500.
- Vichwa, tabaka na manukuu huishia ndani ya video. Mpito hauwezi kuwa mrefu kuliko nusu ya picha yoyote ya video unayoiunganisha.
- Njia za diski, URL na orodha za kucheza hazikubaliwi kama media.