API સંદર્ભ

દરેક endpoint, તેની વિનંતી અને પ્રતિસાદ સ્વરૂપ સાથે. બધા રૂટ https://sketchie.ai/api ને સાપેક્ષ છે.

સંમેલનો

દરેક /v1/* endpoint ને Authorization: Bearer sk_... હેડર જરૂરી છે. ભૂલો error ફ્લેગ અને message સાથે JSON તરીકે પાછી આવે છે:

ભૂલ પ્રતિસાદ 
{
  "error": true,
  "message": "length must be a positive multiple of 30 seconds, at most 360"
}

જનરેશન endpoint પ્રતિ મિનિટ 20 વિનંતીઓ સુધી મર્યાદિત છે. બાકીના બધા endpoint પ્રતિ મિનિટ 200 ની મર્યાદા વહેંચે છે.

એક સમજૂતી બનાવો

POST https://sketchie.ai/api/v1/explainer

એક જનરેશન શરૂ કરે છે અને કતારમાં રહેલા રેકોર્ડ સાથે 202 Accepted પાછું આપે છે. ready ન થાય ત્યાં સુધી એક સમજૂતી મેળવો poll કરો.

વિનંતી બોડી 
{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}
ફીલ્ડપ્રકારનોંધ
input string શું સમજાવવું. એક ટૂંકો prompt અથવા પૂરો દસ્તાવેજ ટેક્સ્ટ. source અથવા sceneGraph હાજર ન હોય ત્યાં સુધી આવશ્યક. ઉપનામ: prompt.
length string or number લક્ષ્ય લંબાઈ "M:SS" ("0:30", "1:00") અથવા સેકન્ડમાં. 30 નો ધન ગુણક, 360 સુધી. આપોઆપ લંબાઈ માટે છોડી દો. ઉપનામ: lengthSeconds (સંખ્યા).
voice string વૈકલ્પિક. એક અવાજ ref. ડિફૉલ્ટ પ્રમાણભૂત વર્ણનકાર (Nora). અવાજો જુઓ.
language string વૈકલ્પિક. એક સમર્થિત ભાષા કોડ (ડિફૉલ્ટ en). ભાષાઓ જુઓ.
aspect string વૈકલ્પિક. 16:9 (ડિફૉલ્ટ), 9:16, અથવા 1:1.
source string વૈકલ્પિક. એક સમજૂતીમાં ફેરવવા માટે એક દસ્તાવેજ, લેખ અથવા ટ્રાન્સક્રિપ્ટ. હાજર હોય ત્યારે, input એક વૈકલ્પિક માર્ગદર્શન બની જાય છે.
preset string વૈકલ્પિક ડ્રોઇંગ શૈલી: marker (ડિફૉલ્ટ), chalkboard, pencil, blueprint, crayon, clean.
fillMode string વૈકલ્પિક રિવીલ ફિલ ટેકનિક: A, B, C (ડિફૉલ્ટ), અથવા D.
sceneGraph object વૈકલ્પિક. પહેલેથી લખેલો scene graph. worker ગ્રાફ જનરેશન છોડીને તેને સીધો render કરે છે, પણ આ endpoint હજુ પણ એક નવી સમજૂતી બનાવે છે અને કૉલરની સામાન્ય મફત ફાળવણી અથવા પેઇડ-પ્લાન ક્વોટા વાપરે છે. હાલની સમજૂતી સંપાદિત કરવા એક સમજૂતી સંપાદિત કરો વાપરો.

સમજૂતી રેકોર્ડ પાછો આપે છે: id, status, prompt, lengthSeconds, voice, language, aspect, videoUrl (તૈયાર ન થાય ત્યાં સુધી null) અને sceneGraph (જનરેટ ન થાય ત્યાં સુધી null). source વગરના ખાલી input, ખોટા ઘાટના length, અથવા અમાન્ય aspect, preset, fillMode અથવા language માટે 400 પાછું આવે છે.

એક સમજૂતી મેળવો

GET https://sketchie.ai/api/v1/explainer/:id

પૂરો રેકોર્ડ પાછો આપે છે: વર્તમાન status, ready થાય ત્યારે videoUrl, સંપાદનયોગ્ય sceneGraph, આવૃત્તિ ઇતિહાસ (versions), અને હેડ આવૃત્તિના દૃશ્ય chunks. ગુમ id 404 પાછું આપે છે.

સમજૂતીઓ યાદી કરો

GET https://sketchie.ai/api/v1/explainer?limit=50

કૉલ કરતી કીની સમજૂતીઓ, નવીનતમ પહેલા, યાદી કરે છે. કીના માલિક સુધી મર્યાદિત. limit 1 થી 100 સુધી ક્લેમ્પ થાય છે (ડિફૉલ્ટ 50). હળવા સારાંશ પાછા આપે છે (scene graph કે આવૃત્તિઓ નહીં). પૂરા રેકોર્ડ માટે એક સમજૂતી મેળવો વાપરો.

એક સમજૂતી સંપાદિત કરો

POST https://sketchie.ai/api/v1/explainer/:id/edit

સંપાદનયોગ્યતાની ફાચર. સાદી-ભાષાની સૂચનાને એક લક્ષ્યિત ફરી-render માં ફેરવો. ફક્ત અસરગ્રસ્ત દૃશ્યો ફરી render થાય છે, એક નવી આવૃત્તિ ઉત્પન્ન કરે છે. કતારમાં રહેલી આવૃત્તિ સાથે 202 પાછું આપે છે. હેડ આવૃત્તિ ready ન થાય ત્યાં સુધી એક સમજૂતી મેળવો poll કરો. આ હાલના વિડિયોમાં ઉમેરાય છે, તેથી બીજું મફત-વિડિયો બનાવવાનું સ્લોટ વાપરતું નથી. દરેક વિડિયોનું પહેલું ફરી-render મફત છે. પછીના પેઇડ-પ્લાન મિનિટ વાપરે છે, અને મફત ખાતાઓને એક પ્લાન શરૂ કરવા કહેવાય છે. સમજૂતી પહેલેથી ready હોવી જોઈએ (નહીંતર 409).

વિનંતી બોડી 
{ "instruction": "Make the title scene shorter and warmer" }

એક આવૃત્તિ પર પાછું ફેરવો

POST https://sketchie.ai/api/v1/explainer/:id/revert

હેડને અગાઉની તૈયાર આવૃત્તિ પર ફરી નિર્દેશ કરે છે અને તેના ગ્રાફ અને વિડિયોને રેકોર્ડ પર પ્રતિબિંબિત કરે છે. લક્ષ્ય વિડિયો સાથેની ready આવૃત્તિ હોવી જોઈએ (નહીંતર 409).

વિનંતી બોડી 
{ "versionId": "..." }

લાઇવ સ્થિતિ સ્ટ્રીમ

GET https://sketchie.ai/api/v1/explainer/events

એક Server-Sent Events સ્ટ્રીમ (text/event-stream). એક કનેક્શન ખોલો અને તમારી કોઈપણ સમજૂતી પરની દરેક સ્થિતિ સંક્રમણ એક event: status ફ્રેમ તરીકે આવે છે, જેથી તમે poll કરવાને બદલે worker પૂરું થાય તે ક્ષણે "વિડિયો તૈયાર" સ્થિતિ અપડેટ કરી શકો. સ્ટ્રીમ તમારી કીના માલિક સુધી મર્યાદિત છે.

અવાજો

GET https://sketchie.ai/api/v1/voices

વર્ણન અવાજ કૅટલૉગ. વૈકલ્પિક ?language=<code> તે ભાષાના મૂળ અવાજો પર ફિલ્ટર કરે છે. voices પાછું આપે છે (દરેકમાં એક સરળ name, voice તરીકે મોકલવા id, language, isDefault, અને ચલાવી શકાય તેવું preview_url) વત્તા વૈશ્વિક default. અવાજો જુઓ.

ભાષાઓ

GET https://sketchie.ai/api/v1/languages

સમર્થિત વર્ણન ભાષાઓ, { code, label, native } તરીકે. દરેક code બનાવતી વખતે માન્ય language છે. ભાષાઓ જુઓ.

ખાતું સ્થિતિ

GET https://sketchie.ai/api/v1/account/state

videosGenerated (આજીવન), ખાતું image અને isAdmin પાછું આપે છે. પ્રમાણીકરણ જરૂરી.

બિલિંગ સ્થિતિ

GET https://sketchie.ai/api/v1/billing/status

પ્રમાણીકરણ જરૂરી અને મફત તથા પેઇડ બંને ખાતાઓ માટે 200 પાછું આપે છે. મફત ખાતું videoAllowance, videosUsed અને videosRemaining સાથે plan: "free" પાછું આપે છે. પેઇડ ખાતું planLabel, billingInterval, trialStatus, quotaMinutes, minutesUsedThisPeriod, minutesRemaining અને bonusMinutes પણ પાછું આપે છે.

રનટાઇમ કૉન્ફિગ અને હેલ્થ

GET https://sketchie.ai/api/config

સાર્વજનિક. { "authEnforced": true } પાછું આપે છે. એક લાઇવનેસ ચેક GET /health પર છે.