API রেফারেন্স

প্রতিটি এন্ডপয়েন্ট, তার অনুরোধ ও প্রতিক্রিয়ার আকার সহ। সব রুট https://sketchie.ai/api এর সাপেক্ষে।

রীতি

প্রতিটি /v1/* এন্ডপয়েন্টের Authorization: Bearer sk_... হেডার দরকার। ত্রুটি একটি error ফ্ল্যাগ ও একটি message সহ JSON হিসেবে ফিরে আসে:

ত্রুটি প্রতিক্রিয়া

{
  "error": true,
  "message": "length must be a positive multiple of 30 seconds, at most 360"
}

জেনারেশন এন্ডপয়েন্ট প্রতি মিনিটে 20 অনুরোধে সীমিত। অন্য সব এন্ডপয়েন্ট প্রতি মিনিটে 200 সীমা ভাগ করে।

একটি ব্যাখ্যা তৈরি করুন

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

একটি জেনারেশন শুরু করে এবং সারিবদ্ধ রেকর্ড সহ 202 Accepted ফেরত দেয়। ready না হওয়া পর্যন্ত একটি ব্যাখ্যা পান পোল করুন।

অনুরোধ বডি

{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}

ফিল্ড	ধরন	নোট
`input`	string	কী ব্যাখ্যা করতে হবে। একটি সংক্ষিপ্ত প্রম্পট বা পুরো নথির টেক্সট। `source` বা `sceneGraph` উপস্থিত না থাকলে আবশ্যক। উপনাম: `prompt`।
`length`	string or number	লক্ষ্য দৈর্ঘ্য `"M:SS"` (`"0:30"`, `"1:00"`) বা সেকেন্ডে। 30 এর ধনাত্মক গুণিতক, 360 পর্যন্ত। স্বয়ংক্রিয় দৈর্ঘ্যের জন্য বাদ দিন। উপনাম: `lengthSeconds` (সংখ্যা)।
`voice`	string	ঐচ্ছিক। একটি ভয়েস রেফ। ডিফল্ট মানক বর্ণনাকারী (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। ওয়ার্কার গ্রাফ জেনারেশন এড়িয়ে সরাসরি রেন্ডার করে, কিন্তু এই এন্ডপয়েন্ট এখনও একটি নতুন ব্যাখ্যা তৈরি করে এবং কলারের স্বাভাবিক ফ্রি বরাদ্দ বা পেইড-প্ল্যান কোটা খরচ করে। বিদ্যমান একটি ব্যাখ্যা সম্পাদনা করতে একটি ব্যাখ্যা সম্পাদনা করুন ব্যবহার করুন।

ব্যাখ্যা রেকর্ড ফেরত দেয়: 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

সম্পাদনযোগ্যতার কীলক। একটি সরল-ভাষার নির্দেশকে একটি লক্ষ্যযুক্ত পুনঃ-রেন্ডারে রূপান্তর করুন। শুধু প্রভাবিত দৃশ্য পুনরায় রেন্ডার হয়, একটি নতুন সংস্করণ তৈরি করে। সারিবদ্ধ সংস্করণ সহ 202 ফেরত দেয়। হেড সংস্করণ ready না হওয়া পর্যন্ত একটি ব্যাখ্যা পান পোল করুন। এটি বিদ্যমান ভিডিওতে যুক্ত হয়, তাই আরেকটি ফ্রি-ভিডিও তৈরির স্লট খরচ করে না। প্রতিটি ভিডিওর প্রথম পুনঃ-রেন্ডার ফ্রি। পরেরগুলো পেইড-প্ল্যান মিনিট ব্যবহার করে, এবং ফ্রি অ্যাকাউন্টগুলোকে একটি প্ল্যান শুরু করতে বলা হয়। ব্যাখ্যা ইতিমধ্যে 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 ফ্রেম হিসেবে আসে, তাই আপনি পোল করার বদলে ওয়ার্কার শেষ করার মুহূর্তে একটি "ভিডিও প্রস্তুত" অবস্থা আপডেট করতে পারেন। স্ট্রিম আপনার কী-এর মালিকের মধ্যে সীমাবদ্ধ।

ভয়েস

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 এ আছে।