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 ਤੇ ਹੈ।