مستندات API
کارهای ناهمگام، وبهوکهای امضاشده، اندپوینتهای سازگار با OpenAI. برای هر اجرا پرداخت میکنید و هزینه کارهای ناموفق برگردانده میشود.
https://api.fcaai.ai/v1شروع سریع
- 1ساخت کلیدحساب › کلیدهای توسعهدهنده. برای جدا نگه داشتن توسعه از محیط اصلی از کلید آزمایشی استفاده کنید؛ هزینه اجراها یکسان است:
fcaai_test_آن را درFCAAI_API_KEYبگذارید؛ SDKها و CLI آن را از همانجا میخوانند. - 2نصب SDK یا CLITypeScript برای Node 18+، Deno، Bun و محیطهای edge، Python 3.9+ یا ترمینال. curl نصب نمیخواهد.
npm i @fcaai/sdkpip install fcaainpm i -g @fcaai/cli - 3اولین تولید خود را اجرا کنیدفراخوانی بلافاصله 202 را همراه با شناسه کار و قیمتش برمیگرداند. با
{ wait: true }، SDK پس از تمام شدن کار پاسخ میدهد.
export FCAAI_API_KEY="fcaai_test_…"
# 1) queue a job → 202 { "id", "status": "queued", "price_usd", "eta_seconds" }
curl https://api.fcaai.ai/v1/generations \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"model":"fca/magic-pro","input":{"prompt":"glass villa on a pine ridge at blue hour","aspect_ratio":"16:9","resolution":"2k"}}'
# 2) long poll: holds up to 60 s, returns as soon as the job ends; repeat while queued/running
curl "https://api.fcaai.ai/v1/generations/$GEN_ID?wait=50" \
-H "Authorization: Bearer $FCAAI_API_KEY"
# → "status": "succeeded", "output": [{ "url": "https://…", "kind": "image", … }]احراز هویت
کلید خود را در هر درخواست بهصورت bearer token بفرستید.
- کلیدهایی که با
fcaai_live_شروع میشوند برای محیط اصلی و کلیدهایی که باfcaai_test_شروع میشوند برای توسعه هستند. هزینه هر دو یکسان است؛ کلیدهای آزمایشی فقط محیطها را از هم جدا نگه میدارند. - کلید فقط یک بار، هنگام ساخت، نمایش داده میشود و ما فقط اثر انگشت آن را نگه میداریم. آن را در یک متغیر محیطی مثل
FCAAI_API_KEYنگه دارید، هرگز در کدی که در مرورگر یا برنامه اجرا میشود. - کلید ناموجود، نادرست، باطلشده یا منقضی 401 برمیگرداند. کلیدی که دامنه درست را ندارد یا از IP خارج از فهرست مجازش استفاده شود، 403 برمیگرداند.
curl https://api.fcaai.ai/v1/models \
-H "Authorization: Bearer $FCAAI_API_KEY"نتیجهها چطور برمیگردند
هر تولید یک کار است: queued ← running ← succeeded، failed یا canceled. هزینه کارهای ناموفق و لغوشده برگردانده میشود.
- Long poll:
?wait=50درخواست را تا 60 ثانیه باز نگه میدارد و بهمحض پایان کار پاسخ میدهد. - وبهوک: یک رویداد امضاشده هنگام پایان کار.
- SDK:
{ wait: true }در TypeScript،wait=Trueدر Python.
{
"id": "cmvusmtm300234pbo7l6ecl3f",
"object": "generation",
"model": "fca/magic-pro",
"status": "queued",
"price_usd": 0.03,
"currency": "USD",
"eta_seconds": 14,
"output": null
}لغو یک تولید
تولیدی که در صف است قابل لغو است و مبلغ رزروشدهاش آزاد میشود. وقتی شروع شد معمولاً نمیشود: پاسخ 409 already_started میگیرید و کار مثل همیشه تمام و هزینهاش کم میشود.
- اول
cancellableرا روی تولید بخوانید: تا وقتی در صف است همیشه true است و پس از شروع معمولاً false. - لغو تولیدی که قبلاً تمام شده، آن را بدون تغییر برمیگرداند.
# can it still be cancelled?
curl https://api.fcaai.ai/v1/generations/$GEN_ID -H "Authorization: Bearer $FCAAI_API_KEY"
# → "status": "queued", "cancellable": true, …
curl -X POST https://api.fcaai.ai/v1/generations/$GEN_ID/cancel -H "Authorization: Bearer $FCAAI_API_KEY"
# → 200: the generation, "status": "canceled"
# → 409 "already_started": it finishes and is charged as usualمصرف و موجودی
GET /v1/account/usage تولیدها، خطاها و هزینه به دلار را به تفکیک روز و مدل برمیگرداند. اگر from و to را بهصورت YYYY-MM-DD نفرستید، 30 روز گذشته را پوشش میدهد.
GET /v1/account/balanceموجودی قابل استفاده شما را به دلار برمیگرداند.
# per day and model; the last 30 days unless you pass from and to
curl "https://api.fcaai.ai/v1/account/usage?from=2026-10-01&to=2026-10-31" -H "Authorization: Bearer $FCAAI_API_KEY"
curl https://api.fcaai.ai/v1/account/balance -H "Authorization: Bearer $FCAAI_API_KEY"راهنماها
دستورالعملهای قدمبهقدم برای رایجترین کارها. نمونهها از SDKهای رسمی استفاده میکنند؛ زبانه curl درخواست HTTP ساده را نشان میدهد.
ویرایش تصویر با تصاویر مرجع
عکسی را که میخواهید ویرایش شود و تصاویر مرجع را در یک فهرست images بفرستید، سپس تغییر را توضیح دهید. به تصاویر با ترتیبشان اشاره کنید (تصویر 1، تصویر 2…).
- 1فایلهای محلی را بارگذاری کنید یا از هر URL عمومی https استفاده کنید.
- 2تصویری را که باید ویرایش شود اول در
imagesبگذارید؛ بقیه مرجع هستند. - 3
constraints.max_input_imagesرا در جزئیات مدل بررسی کنید: نشان میدهد مدل چند تصویر میپذیرد.
شخصیتها، محصولات و مکانهای ذخیرهشده در کتابخانه را میتوانید با element_ids اضافه کنید (حداکثر 3)؛ تصاویر مرجعشان از سمت ما پیوست میشود.
curl https://api.fcaai.ai/v1/generations \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"google/nano-banana-pro","input":{"prompt":"Put the armchair from image 2 next to the window. Keep the room, light and camera unchanged.","images":["https://example.com/room.jpg","https://example.com/armchair.jpg"],"resolution":"2k"}}'
# how many images this model takes
curl https://api.fcaai.ai/v1/models/google/nano-banana-pro -H "Authorization: Bearer $FCAAI_API_KEY"
# → "constraints": { "max_input_images": …, … }تصویر به ویدیو با فریم شروع و پایان
مدلهای ویدیو فریم اول را در image و، اگر پشتیبانی کنند، فریم آخر را در end_image میگیرند. کلیپ از یکی به دیگری حرکت میکند.
- 1مدل را بررسی کنید:
constraints.features.end_frameباید true باشد و مدت باید باconstraints.durationجور باشد. - 2
image،end_image، پرامپت و مدت را بفرستید. حرکتهای دوربین همان متن ساده پرامپت هستند. - 3ویدیو چند دقیقه طول میکشد: با timeout طولانیتر منتظر بمانید یا از وبهوک استفاده کنید.
مدلهایی که features.reference دارند حالت مرجع هم دارند: بهجای فریمها reference_images را بفرستید و در پرامپت آنها را @Image1، @Image2 بنامید. این حالت با image یا end_image ترکیب نمیشود.
# price with an end frame
curl "https://api.fcaai.ai/v1/models/kling/3.0-pro?duration=5&end_image=1" -H "Authorization: Bearer $FCAAI_API_KEY"
curl https://api.fcaai.ai/v1/generations \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"kling/3.0-pro","input":{"prompt":"slow dolly in, morning light moves across the floor","image":"https://example.com/start.jpg","end_image":"https://example.com/end.jpg","duration":5}}'افزایش وضوح تصویر
ابزارهای افزایش وضوح یک image و یک مقیاس در tier میگیرند. fca/upscale دو حالت دارد: Standard برای عکسها (تا 16x) و Sharp برای رندرها، پلانها و متن (تا 4x).
- 1قیمت را برای اندازه تصویر مبدأ بگیرید:
?tier=4x&source_width=…&source_height=…. - 2تصویر و مقیاس را بفرستید.
"tier": "max"بزرگترین مقیاسی را که با تصویر جور است انتخاب میکند (خروجی تا 64 مگاپیکسل). - 3اندازه جدید در
width / heightخروجی آمده است.
بهبوددهندهها، نورپردازی دوباره، گسترش تصویر، حذف پسزمینه و افزایش وضوح ویدیو با GET /v1/models?type=upscale فهرست میشوند.
curl "https://api.fcaai.ai/v1/models/fca/upscale?tier=4x&source_width=1600&source_height=1000" -H "Authorization: Bearer $FCAAI_API_KEY"
curl https://api.fcaai.ai/v1/generations \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"fca/upscale","input":{"image":"https://example.com/render.jpg","tier":"4x","extra":{"look":"sharp"}}}'اجرای یک قالب
قالبها دستورالعملهای آمادهای با چند ورودی نامدار هستند. پرامپت سمت ما میماند: شما مقادیر را میفرستید و یک تولید معمولی پس میگیرید.
- 1قالب را بگیرید تا
inputs(کلید، نوع، الزامی، گزینهها) وpricingآن را ببینید. - 2آن را با
{ "values": { key: value } }اجرا کنید. ورودیهای تصویری یک URL https میگیرند. - 3مثل هر کار دیگری منتظرش بمانید. مقدار نادرست پاسخ 400
invalid_valuesرا همراه باfieldsبرمیگرداند.
قالبهای چندمرحلهای (package) یک اجرای قالب با چند مرحله شروع میکنند: از templates.runPackage / run_package استفاده کنید.
curl https://api.fcaai.ai/v1/templates -H "Authorization: Bearer $FCAAI_API_KEY"
curl https://api.fcaai.ai/v1/templates/$SLUG -H "Authorization: Bearer $FCAAI_API_KEY" # inputs, pricing, options (models[].id → run "model")
curl https://api.fcaai.ai/v1/templates/$SLUG/run \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: $(uuidgen)" \
-d '{"values":{"photo":"https://example.com/room.jpg"}}'
# → 202: a generation (poll GET /v1/generations/{id}?wait=50)
# multi-step templates return a template_run (GET /v1/templates/runs/{id})اول قیمت و گزینههای مدل را بگیرید
یک فراخوانی رایگان هر چیزی را که مدل میپذیرد و قیمت دقیق تنظیمات شما را برمیگرداند. از همان منطق قیمتگذاری POST /v1/generations استفاده میکند، پس قیمت اعلامشده همان مبلغی است که میپردازید.
- 1
GET /v1/models/{id}را با تنظیماتی که میفرستید فراخوانی کنید:duration · resolution · quality · tier · count · audio=1 · images=2 · end_image=1 · reference_images=3. - 2قیمت را در
estimate.price_usdبخوانید و پیش از اجراavailabilityرا بررسی کنید. - 3فرم خود را از روی
optionsوconstraintsبسازید: نسبتهای تصویر، وضوحها، مدت، حداکثر خروجی، حداکثر تصویر ورودی و قابلیتها.
مقداری که مدل اجازه نمیدهد در invalid_params برمیگردد، همراه با فیلد و مقادیر مجاز.
curl "https://api.fcaai.ai/v1/models/google/veo-3.1?duration=8&resolution=1080p&audio=1&end_image=1" -H "Authorization: Bearer $FCAAI_API_KEY"
# → { "availability": "available",
# "estimate": { "price_usd": …, "price_display": "$…", "currency": "USD" },
# "options": { … }, "constraints": { … }, "input_schema": { … } }
curl "https://api.fcaai.ai/v1/models?type=video" -H "Authorization: Bearer $FCAAI_API_KEY" # the whole catalog for your keyفایلهایتان را بارگذاری کنید
هر ورودی یک URL https است. URLهای عمومی همانطور کار میکنند؛ فایلهای محلی را اول بارگذاری کنید و از url برگشتی استفاده کنید.
- 1تا 50 مگابایت: یک درخواست به
POST /v1/uploads. - 2تا 2 گیگابایت: یک نشست باز کنید، تکههای 8 مگابایتی را با هر ترتیبی (حتی موازی) بفرستید، سپس آن را کامل کنید.
- 3هنگام باز کردن نشست
sha256را بفرستید تا بارگذاری قطعشده ادامه پیدا کند یا فایلی که قبلاً ذخیره شده رد شود.
SDKها و CLI فایل را تکه میکنند، هر بار 3 تکه میفرستند و با شناسه نشست ادامه میدهند.
# ≤ 50 MB
curl https://api.fcaai.ai/v1/uploads -H "Authorization: Bearer $FCAAI_API_KEY" -F "[email protected]"
# → 201 { "id": "…", "object": "upload", "url": "https://…", "mime": "image/jpeg", "bytes": … }
# up to 2 GB: 1) start a session
curl https://api.fcaai.ai/v1/uploads/sessions \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"walkthrough.mp4","mime":"video/mp4","bytes":104857600}'
# 2) PUT each 8 MB chunk (any order, in parallel)
split -b 8388608 -d -a 4 walkthrough.mp4 part_
curl -X PUT https://api.fcaai.ai/v1/uploads/sessions/$SESSION/chunks/0 -H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/octet-stream" --data-binary @part_0000
# 3) finish → { "upload": { "url": … } }
curl -X POST https://api.fcaai.ai/v1/uploads/sessions/$SESSION/complete -H "Authorization: Bearer $FCAAI_API_KEY"دریافت نتیجه با وبهوک
بهجای پرسوجوی مداوم، بگذارید وقتی کاری تمام شد سرورتان را صدا بزنیم. یک URL برای کل حساب ثبت کنید یا options.webhook_url را به یک درخواست اضافه کنید (رمز آن یک بار بهصورت webhook_secret برمیگردد).
- 1با
POST /v1/webhooksثبت کنید: URL https شما و رویدادهایی که میخواهید.secretفقط یک بار نمایش داده میشود، پس ذخیرهاش کنید. - 2هر ارسال را بررسی کنید:
X-FCAAI-Signature: t=…,v1=…یک HMAC-SHA256 ازt + "." + rawBodyبا رمز شماست. از بدنه خام استفاده کنید و مهرهای زمانی قدیمی را رد کنید. - 3سریع 2xx پاسخ دهید و کار را بعد انجام دهید. ارسال ناموفق در مجموع 5 بار تلاش میشود: بلافاصله، سپس پس از 30 ثانیه، 2 دقیقه، 10 دقیقه و 1 ساعت. همه تلاشها در
GET /v1/webhooks/{id}/deliveriesثبت میشوند.
یک رویداد ممکن است بیش از یک بار برسد؛ با id آن موارد تکراری را رد کنید.
فقط آدرسهای https عمومی پذیرفته میشوند و آدرس در هر ارسال دوباره بررسی میشود.
curl https://api.fcaai.ai/v1/webhooks \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/fcaai-hook","events":["generation.succeeded","generation.failed"]}'
# → 201 { "id": "…", "events": [ … ], "secret": "whsec_…" } (secret shown only here)
# or one event for one job: add to POST /v1/generations
# "options": { "webhook_url": "https://example.com/fcaai-hook" }
# → the 202 response carries "webhook_secret" (shown only there)
# delivery log: the latest 50 attempts
curl https://api.fcaai.ai/v1/webhooks/$WEBHOOK_ID/deliveries -H "Authorization: Bearer $FCAAI_API_KEY"مدیریت خطاها و تنظیمات نادیدهگرفتهشده
خطاها بهصورت JSON با یک error.code ثابت برمیگردند که میتوانید بر اساسش تصمیم بگیرید. تنظیمی که اعمال نشود کار را ناموفق نمیکند: در ignored_fields فهرست میشود.
- 1وضعیت HTTP و
error.codeرا بررسی کنید. وقتی مقداری نادرست است،allowedمقادیر معتبر را فهرست میکند. - 2خطاهای 429 و 5xx را پس از
Retry-Afterبا همانIdempotency-Keyدوباره امتحان کنید تا هیچ چیز دو بار حساب نشود. SDKها هر دو را برایتان انجام میدهند. - 3
ignored_fieldsرا در پاسخ 202 بخوانید؛ هر موردfield · reason · messageدارد.
هزینه کارهای ناموفق خودکار برگردانده میشود. اگر مسیر معمول یک مدل از کار افتاده باشد، کار خودبهخود به مسیر پشتیبان میرود؛ 503 model_unavailable یعنی الان هیچ مسیری آزاد نیست.
| وضعیت | کدها | چه باید کرد |
|---|---|---|
| 400 | invalid_bodyinvalid_durationinvalid_aspect_ratiomodel_not_allowed | یک فیلد جا افتاده یا برای این مدل مجاز نیست. درخواست را اصلاح کنید؛ ارسال دوباره بدون تغییر باز هم ناموفق میشود. |
| 401 | invalid_api_keyapi_key_revokedapi_key_expired | کلید وجود ندارد، نادرست است، باطل شده یا منقضی شده است. |
| 402 | insufficient_balancekey_spend_cap_reached | موجودی کافی نیست یا کلید به سقف ماهانهاش رسیده است. هزینهای کم نشده است. |
| 403 | insufficient_scopeip_not_allowed | کلید دامنه لازم را ندارد (required_scope را ببینید) یا IP درخواست در فهرست مجاز آن نیست. |
| 404 | model_not_found | چنین مدلی وجود ندارد یا برای کلید شما باز نیست. |
| 429 | rate_limited | درخواستها بیش از حد زیاد است. به اندازه زمان Retry-After صبر کنید. |
| 503 | model_unavailable | مدل مشغول یا آفلاین است. کمی بعد دوباره امتحان کنید یا مدل دیگری انتخاب کنید. |
ignored_fieldsunknown_field- فیلدی از این درخواست نیست؛ املای آن را بررسی کنید.
not_supported_by_model- فیلدی معتبر که این مدل نمیپذیرد.
nearest_supported- این نسبت تصویر ارائه نمیشود؛ نزدیکترین نسبت استفاده میشود.
follows_input_image- هنگام ویرایش، این مدل اندازه یا نسبت تصویر ورودی را نگه میدارد.
unpriced_extra- یک تنظیم اضافه که مدل تعریف نکرده بود حذف شد.
import { Fcaai, FcaaiError } from '@fcaai/sdk'
type Ignored = { field: string; reason: string; message: string }
const fcaai = new Fcaai({ maxRetries: 2 }) // 429 / 5xx / network errors: retried with backoff, honoring Retry-After
try {
const gen = await fcaai.generations.create({ model: 'google/veo-3.1', input: { prompt: 'waves at dusk, slow pan', duration: 6 } })
const { ignored_fields = [] } = gen as unknown as { ignored_fields?: Ignored[] }
for (const f of ignored_fields) console.warn(f.field + ' ignored (' + f.reason + '): ' + f.message)
} catch (e) {
if (!(e instanceof FcaaiError)) throw e
const allowed = (e.body as { error?: { allowed?: unknown[] } } | null)?.error?.allowed
if (e.status === 400) console.error(e.code, e.message, allowed) // fix the request; do not retry as is
else if (e.status === 402) console.error('Top up, or raise the key cap:', e.message)
else if (e.code === 'model_unavailable') console.error('Retry shortly or pick another model')
else throw e
}اندپوینتهای سازگار با OpenAI
کدی که از کلاینت OpenAI استفاده میکند با تغییر دو چیز کار میکند: URL پایه و کلید. چت و تولید تصویر پشتیبانی میشوند.
- 1URL پایه را روی
https://api.fcaai.ai/v1بگذارید و کلید fcaai خود را بهعنوان کلید API استفاده کنید. - 2چت:
POST /v1/chat/completionsبا مدلfca/chat. استریم، ابزارها و خروجی JSON مثل همیشه کار میکنند. - 3تصویر:
POST /v1/images/generationsتا 90 ثانیه منتظر میماند وdata[].urlرا برمیگرداند. اگر کار بیشتر طول بکشد، 202 همراه باfcaai.generation_idمیگیرید؛ باGET /v1/generations/{id}دنبالش کنید.
برای ویدیو، صدا، سهبعدی، افزایش وضوح و همه گزینههای مدل از POST /v1/generations استفاده کنید.
curl https://api.fcaai.ai/v1/chat/completions \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"fca/chat","messages":[{"role":"user","content":"Write a one-line caption for a walnut side table."}]}'
curl https://api.fcaai.ai/v1/images/generations \
-H "Authorization: Bearer $FCAAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"google/nano-banana-pro","prompt":"a paper plane on a wooden desk","size":"1536x1024"}'
# → { "created": …, "data": [{ "url": "https://…" }], "fcaai": { "generation_id": "…", "price_usd": … } }فروش دوباره به مشتریان خودتان
حسابهای نمایندگی میتوانند برای هر مشتری یک زیرحساب باز کنند، کلیدهای مخصوص به آن بدهند و مصرف هر مشتری را با قیمت عمده دنبال کنند.
- 1از یک کلید مدیریتی با دامنه
reseller:manageاستفاده کنید. کلیدهای مشتری هرگز این دامنه را نمیگیرند. - 2مشتری را با
POST /v1/reseller/subtenantsبسازید، سپس کلیدش را باPOST /v1/reseller/subtenants/{id}/keys. کلید کامل فقط یک بار نمایش داده میشود. - 3مصرف و حاشیه سود هر مشتری را با
GET /v1/reseller/usageدنبال کنید. برای برچسبگذاری کاربران نهایی خودتان روی تولیدها،external_user_idرا بفرستید.
کلیدهای بدون دامنه نمایندگی روی این اندپوینتها 403 میگیرند.
curl https://api.fcaai.ai/v1/reseller/subtenants \
-H "Authorization: Bearer $FCAAI_RESELLER_KEY" -H "Content-Type: application/json" \
-d '{"name":"Acme Studio","plan":"pro","retail_markup":1.5}'
curl https://api.fcaai.ai/v1/reseller/subtenants/$CUSTOMER_ID/keys \
-H "Authorization: Bearer $FCAAI_RESELLER_KEY" -H "Content-Type: application/json" \
-d '{"name":"production","mode":"live"}'
curl "https://api.fcaai.ai/v1/reseller/usage?from=2026-10-01" -H "Authorization: Bearer $FCAAI_RESELLER_KEY"چه چیزهایی میتوانید بسازید
69 اندپوینت. هر کدام با نمونههای curl، TypeScript و Python در مرجع کامل آمده است.
/v1/modelsفهرست مدلها/v1/models/{id}جزئیات مدل + برآورد قیمت/v1/voicesصداهای کلونشده شما/v1/style-kitsکیتهای سبک/v1/elementsالمانها/v1/voice-stylesسبکهای گفتار/v1/voices/cloneکلون کردن صدا (رضایت لازم است)/v1/voices/{id}تغییر نام صدای کلونشده/v1/voices/{id}حذف صدای کلونشده (دائمی)/v1/models/{id}/voicesصداهای یک مدل گفتار/v1/templatesفهرست قالبها/v1/templates/{slug}دریافت قالب و ورودیهایش/v1/templates/{slug}/runاجرای قالب (ناهمگام)/v1/templates/runs/{id}دریافت اجرای قالب چندمرحلهای/v1/templates/runs/{id}/planطرح اجرای قالب را تأیید یا بازنویسی کنید/v1/templates/runs/{id}/cancelلغو اجرای یک قالب چندمرحلهای/v1/flowsفهرست Flowها/v1/flows/{id}دریافت Flow و ورودیهایش/v1/flows/{id}/runاجرای Flow (ناهمگام)/v1/community/templatesفهرست قالبهای انجمن/v1/community/templates/{id}دریافت قالب انجمن/v1/flows/runs/{id}دریافت اجرای Flow/v1/timelinesساخت تایملاین صحنه/v1/timelines/{id}دریافت تایملاین/v1/timelines/{id}/{action}پیشنمایش، تأیید، کیفیت کامل، برش/v1/farm/jobsفهرست کارهای رندر فارم/v1/farm/jobs/{id}/pauseتوقف موقت کار رندر فارم/v1/farm/jobs/{id}/resumeادامه کار رندر فارم/v1/farm/jobs/{id}دریافت کار رندر فارم/v1/video-editsویرایش ویدیو: کوتاه کردن، اتصال، تصاویر، متن و لوگو، موسیقی متن (ناهمگام، رایگان)/v1/generationsفهرست تولیدها/v1/generationsساخت تولید (ناهمگام)/v1/generations/{id}دریافت تولید (long-poll با wait)/v1/generations/{id}/cancelلغو (موجودی رزروشده آزاد میشود)/v1/uploadsبارگذاری فایل ورودی (≤ 50 مگابایت)/v1/uploads/sessionsشروع بارگذاری تکهتکه (تا 2 گیگابایت)/v1/uploads/sessions/{id}وضعیت نشست (تکههای دریافتشده، بازههای جاافتاده)/v1/uploads/sessions/{id}لغو بارگذاری تکهتکه/v1/uploads/sessions/{id}/chunks/{index}بارگذاری یک تکه (بدنه خام)/v1/uploads/sessions/{id}/completeپایان بارگذاری تکهتکه/v1/accountحساب، کلید و موجودی/v1/account/balanceموجودی (دلار)/v1/account/usageمصرف به تفکیک روز و مدل/v1/webhooksفهرست وبهوکها/v1/webhooksساخت وبهوک (رمز یک بار برگردانده میشود)/v1/webhooks/{id}حذف وبهوک/v1/webhooks/{id}/deliveriesگزارش ارسالها/v1/reseller/subtenantsفهرست مشتریان شما (زیرمستأجرها)/v1/reseller/subtenantsساخت مشتری (زیرمستأجر)/v1/reseller/subtenants/{id}/keysساخت کلید API برای مشتری (رمز یک بار برگردانده میشود)/v1/reseller/usageمصرف و هزینه عمده هر مشتری/v1/chat/completionsتکمیل چت (طرحواره OpenAI)/v1/images/generationsتولید تصویر (طرحواره OpenAI، همزمان ≤ 90 ثانیه)/v1/boards/{board_id}/approvalsفهرست درخواستهای تأیید در یک بورد/v1/boards/{board_id}/approvals/{request_id}دریافت درخواست تأیید/v1/boards/{board_id}/approvals/{request_id}/decideتأیید یک گزینه یا درخواست تغییر/v1/plans/readخواندن پلان/v1/panoramas/finishتکمیل پانورامای 360°/v1/flows/runs/{id}/cancelلغو اجرای یک Flow/v1/architecture/projectsفهرست پروژههای Architecture Studio/v1/architecture/projectsساخت پروژه/v1/architecture/projects/{id}دریافت پروژه و موارد آن/v1/architecture/projects/{id}/itemsافزودن به پروژه/v1/architecture/projects/{id}/complianceفهرست برچسبهای «تصویر نمایشی»/v1/architecture/projects/{id}/complianceافزودن برچسب «تصویر نمایشی»/v1/architecture/projects/{id}/compliance/{stamp}پس گرفتن برچسب/v1/architecture/projects/{id}/productsفهرستهای محصول یک تصویر/v1/architecture/projects/{id}/productsساخت فهرست محصول از یک رندر/v1/architecture/products/{id}دریافت یا دانلود فهرست محصولقیمتها
دلار برای هر اجرا، از همان موجودی طرح شما. اینها قیمتهای لحظهای با تنظیمات پیشفرضاند؛ صفحه هر مدل همه قیمتها را بر اساس وضوح و مدت فهرست میکند.
| مدل | کار | API (دلار) |
|---|---|---|
| Nano Banana Pro | تصویر · تصویر · 2K | $0.13 |
| GPT Image 2.5 Flare | تصویر · تصویر · 2K | $0.055 |
| FCA Magic Pro | تصویر · تصویر · 2K | $0.03 |
| Kling 3.0 Pro | ویدیو · هر ثانیه · 1080p | $0.11 |
| FCA Magic V3 | ویدیو · هر ثانیه · 1080p | $0.017 |
| ElevenLabs v3 | صدا · کلیپ | $0.024 |
کلیدها و محدودیتها
هر کلید دامنه، نرخ و سقف هزینه خودش را دارد. هدرهای پاسخ نشان میدهند چقدر باقی مانده است.
X-RateLimit-*key_spend_cap_reachedSDKها و ابزارها
SDKهای رسمی TypeScript و Python و یک CLI. SDKها با کلیدهای idempotency با خیال راحت دوباره تلاش میکنند، منتظر نتیجه میمانند، فایلهای بزرگ را تکهتکه بارگذاری میکنند و امضای وبهوک را بررسی میکنند.
مرجع تعاملی: درخواستها را در مرورگر امتحان کنید و کد نمونه را کپی کنید.
