=== useapi.net — universal note === Generated: 2026-11-08 06:55 UTC Authentication (applies to every useapi.net API). Header: Authorization: Bearer user:- Use the COMPLETE token, including the `user:` prefix and the alphanumeric suffix. Do not truncate. Do not URL-encode. A single token authorizes every API under the user's subscription. Service-specific patterns. Identifier names (jobid / taskId / musicId / etc.), job lifecycle, response shapes, webhook semantics, and synchronous-vs-async behavior vary PER API. Use ONLY the service-specific documentation below to determine the correct request body, response shape, polling endpoint, and status values for THIS API. Do not assume conventions from another useapi.net API carry over. For cross-service context (e.g. which APIs expose the same underlying model, billing tiers, model availability matrix), see https://useapi.net/llms.txt === END universal note === useapi.net — third-party APIs for AI services that run on the accounts and plans you already have, since 2023. $15/month subscription gives full access to all APIs listed below. Subscribe: https://useapi.net/docs/subscription Support: https://discord.gg/w28uK3cnmF | https://t.me/use_api === URL: https://useapi.net/docs/account-management === Document URL: https://useapi.net/docs/account-management --- layout: default title: Account Management nav_icon: account description: "useapi.net account endpoints — check subscription and connected service accounts, set a default replyUrl webhook, query usage stats, reset your API token, and read the public daily stats." nav_order: 350 has_children: true has_toc: false permalink: /docs/account-management --- # Account Management These endpoints manage your useapi.net account itself rather than any one AI service. They work the same whichever services you use. Every endpoint except the public daily stats needs your API token, see [Setup useapi.net](/docs/start-here/setup-useapi). ### Endpoints | Endpoint | What it does | |:---|:---| | [GET account](/docs/account-management/get-account) | Returns your subscription status, how many subscriptions you have, the maximum accounts per service, and the total, active and error accounts configured for each AI service. | | [POST account](/docs/account-management/post-account) | Updates your account name and the default `replyUrl` webhook used by every API call that does not set its own. | | [GET account/stats](/docs/account-management/get-account-stats) | Returns your own generations, job ends and failed requests for one service (`bot`), by date or as the last N records, with an optional filter by service account. Data lags 5 to 15 minutes and is kept for 3 months. | | [POST account/token/reset](/docs/account-management/post-account-token-reset) | Emails a confirmation link, valid for 15 minutes, that replaces your API token with a new one. | | [GET stats/daily](/docs/account-management/get-stats-daily) | Returns the anonymized stats we publish every day for the previous UTC day, such as Google Flow captcha providers, Google Flow and PixVerse success rates by model, and Muse usage. No API token needed. | ### When to use them - Run `GET account` before adding service accounts to see how many slots your subscriptions leave, and to spot accounts in an error state. Error accounts still count toward the limit, so delete the ones you will not fix. - Set a default `replyUrl` with `POST account` once if all your jobs report to the same webhook, instead of passing `replyUrl` on every request. - Use `GET account/stats` to audit your own traffic. It breaks your requests down by service account, endpoint and HTTP status code, gives the success rate of your generations, and says for each failure whether it came from the request, the service account, the AI service or useapi.net. - Call `POST account/token/reset` as soon as you think your token was exposed. The old token stops working for almost every request right away. - Check `GET stats/daily` to compare your results with the anonymized results across all customers, for example to choose a captcha provider or a model. To add more accounts per service, buy another [subscription](/docs/subscription). === URL: https://useapi.net/docs/account-management/get-account-stats === Document URL: https://useapi.net/docs/account-management/get-account-stats --- layout: default title: GET account/stats description: "Query your useapi.net usage per service with GET account/stats: generations, job ends and failures, each row with its origin, outcome and error, plus success rate and per-account counts." parent: Account Management nav_order: 250 --- ## Query Usage Statistics January 31, 2026 (November 7, 2026) --- Returns your requests to one API, one row each, with totals and counts per account, model, endpoint and status code. Use it to see what failed, why, and on which account. - Rows show up 5 to 15 minutes after the request. - Rows are kept for 3 months. ##### What is recorded | Recorded | Not recorded | |:---------|:-------------| | Every generation you submit, whatever its outcome | Requests useapi.net answered itself without calling the AI service: validation errors, our limits, an account already marked broken, an unknown job id | | The end of every background job, see [Job ends](#job-ends) | Successful calls that are not generations: lookups, adding an account, cancelling a job | | Any other request the AI service failed or refused | Successful reads, such as polling a job | | A request that failed or crashed inside useapi.net | Reads with a wrong id, such as polling a deleted job | These rules apply since November 1, 2026. Older rows followed earlier rules and have empty `origin`, `outcome` and `error`. > **https://api.useapi.net/v2/account/stats** ##### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Query Parameters | Parameter | Required | Description | |:----------|:---------|:------------| | `bot` | **Yes** | Bot to query stats for.
Supported: `google-flow`, `dreamina`, `kling`, `runwayml`, `pixverse`, `minimax`, `mureka`, `flowmusic`, `tempolor`, `ltxstudio`, `luma`, `gemini-notebook`, `google-vids`, `muse` | | `date` | No | Date in `YYYY-MM-DD` format.
Defaults to today if `limit` is not specified. | | `limit` | No | Number of records to return (max: 50000).
If specified, `date` filter is ignored and returns last N records across all dates. | | `offset` | No | Page of a large day, see [Large days](#large-days): `0`, `20000`, `40000` and so on, as `page.next_offset` gives.
Only with a day (`date`, or today), not with `limit`. | | `config` | No | Filter by one service account, written exactly as it appears in the `config` field of the rows, for example an email.
Letters, digits and `_ . @ + : % -` only, URL-encoded (`+` as `%2B`). Anything else answers `400`. | ##### Responses **200** **200 OK** Returns usage statistics for the specified bot. ```json { "bot": "google-flow", "date": "2026-02-13", "total": 2402, "summary": { "from": "2026-02-13T00:00:03.000Z", "to": "2026-02-13T23:58:38.000Z", "time_span": "23 hours 58 minutes", "by_config": { "user1@gmail.com": 670, "user2@gmail.com": 547, "user3@gmail.com": 438, "user4@gmail.com": 321, "user5@gmail.com": 306, "user6@gmail.com": 120 }, "by_code": { "200": 548, "201": 796, "400": 130, "403": 684, "429": 239, "500": 3, "503": 2 }, "by_endpoint": { "post-images": 1334, "post-videos": 1046, "post-videos-upscale": 22 }, "by_status": { "Created": 796, "OK": 548, "Forbidden": 684, "Too Many Requests": 239, "Bad Request": 130, "Internal Server Error": 3, "Service Unavailable": 2 }, "success_rate": "56.0%", "model_refusals": 0, "account_refusals": 0, "avg_msec": 17759, "by_model": { "veo-3.1-lite-low-priority": 1032, "nano-banana-pro": 702, "imagen-4": 449, "nano-banana": 181, "veo-3.1-fast": 14 }, "by_captcha_provider": { "CapSolver": 4856 }, "avg_captcha_retry": 2, "by_tier": { "PAYGATE_TIER_TWO": 1684, "PAYGATE_TIER_ONE": 612, "PAYGATE_TIER_NOT_PAID": 106 }, "by_sku": { "WS_ULTRA": 1430, "G1_TIER2": 254, "G1_TIER1": 612, "G1_FREEMIUM": 106 }, "lookup": { "tiers": { "PAYGATE_TIER_TWO": "Ultra $199", "PAYGATE_TIER_ONE": "Pro", "PAYGATE_TIER_NOT_PAID": "Free" }, "skus": { "WS_ULTRA": "Workspace Ultra", "G1_TIER2": "Ultra $199", "G1_TIER1": "Pro", "G1_FREEMIUM": "Free" } } }, "data": [ { "timestamp": "2026-02-13T10:30:00.000Z", "jobid": "20260213103000-user:123-bot:google-flow", "config": "user1@gmail.com", "endpoint": "post-images", "status": "OK", "func": "v1-google-flow-images", "code": 200, "msec": 5432, "outcome": "ok", "error": "", "origin": "submit", "model": "imagen-4", "captchaProviders": "CapSolver", "captchaRetry": 1, "tier": "PAYGATE_TIER_TWO", "sku": "WS_ULTRA", "backend": "flow", "bytes": 0, "reason": "", "sampleInterval": 1 } ] } ``` The `summary` object is left out when there are no rows. **400** **400 Bad Request** Missing or invalid parameters, for example a `config` that is not a plain account name. ```json { "error": "" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` ##### Reading a row Three fields say what a row is. They are empty on rows written before November 1, 2026. | `origin` | Why the row exists | |:---------|:-------------------| | `submit` | A generation you submitted (for `google-flow`, also a file upload) | | `finished` | The end of a background job, see [Job ends](#job-ends) | | `refused` | Another request that failed | | `read` | A `GET` that failed | | `crash` | A request that crashed inside useapi.net | | `outcome` | What happened | Typical codes | |:----------|:--------------|:--------------| | `ok` | It worked | `2xx` | | `customer` | A problem with the request or its content | `400`, `404`, `422` (content refused) | | `account` | A problem with the service account | `401`, `402`, `403`, `429`, `596` | | `vendor` | The AI service failed | `5xx` after the service was called, or a failure inside a `2xx` answer | | `ours` | useapi.net failed | a crash, or a `5xx` before the service was called | `error` is the error text, written the same way every time so you can group by it: lowercase, with URLs, emails, ids and numbers masked (numbers become `N`), at most 120 characters. It is empty on success. ##### Totals - `total`, `success_rate` and `avg_msec` count submitted work only: rows with `origin` `submit`, plus older rows. - Other failed requests (`refused`, `read`, `crash`) are in `data` and the `by_` counts, but not in those three figures. - Job ends have their own figures in `summary.jobs`, see below. - An MCP tool call shows as the REST request the tool makes. Rows with endpoint `mcp`, written until October 31, 2026, repeated those requests and are left out of `total`. On busy days the stats store keeps a sample of the rows from the busiest API tokens rather than every row. Each row's `sampleInterval` says how many it stands for. It is `1` for almost every customer and higher only for the busiest ones at peak hours. `total` and every count, rate and average in `summary` already weight each row by its `sampleInterval`, so they reflect all of your . When you count rows in `data` yourself, add up `sampleInterval` rather than counting rows. `limit` counts stored rows, so `total` can be larger than `limit`. ##### Large days A day with more than 50,000 rows comes in pages of 20,000, newest first. `total` and `summary` always cover the whole day, on every page. The answer then has a `page` object: `offset` (the first row of this page), `size` (rows in `data`), `rows` (rows in the whole day) and `next_offset`. Ask for the next page with `offset` set to `next_offset`, and stop when it is missing. A day of 50,000 rows or fewer returns everything at once, with no `page`, unless you pass an `offset` above 0. For today, rows keep arriving while you page, so a later page can repeat a few rows of the one before. Past days page exactly. On a paged `google-flow` day before September 25, 2026, `summary.model_refusals` counts only the refusals recorded on the rows themselves, so `success_rate` can read slightly lower than on a smaller day. ##### Job ends When a background job ends, a second row is written next to the submit row: - `endpoint` is the submit endpoint plus `-finished`, for example `post-videos-finished` (`video-finished` and `image-finished` for `pixverse`) - `origin` is `finished`, and `status` is the final status - `code` is `200` for a finished result, otherwise the job's error code, for example `422` for a moderated `pixverse` job - `msec` is the time from submit to end (the submit row's `msec` covers only the submit call) Job ends stay out of `total`, `success_rate`, `avg_msec` and the `by_` counts. `summary.jobs` counts them instead: `finished`, `completed` (finished results), `completion_rate` and `avg_msec` (submit to result, completed jobs only). Written for `pixverse` since October 28, 2026 and for the other APIs since November 1, 2026. PixVerse Off-Peak videos have no end row. ##### Model names `model` and `by_model` are filled for `google-flow`, `dreamina`, `kling`, `minimax`, `pixverse`, `luma`, `gemini-notebook`, `google-vids` and `muse`. Usually it is the AI model, such as `veo-3.1-fast`. Some requests use their own names: | API | `model` | Rows | |:----|:--------|:-----| | `google-flow` | `agent` | [Agent](/docs/api-google-flow-v1/agent) turns, their end rows (`completed`, `waiting_approval` or `failed`), and agent requests that failed | | | `agent-approval` | An approval answered | | | `agent-stream` | A chat stream that failed | | | `mcp` | A crash inside the [MCP server](/docs/api-google-flow-v1/mcp) | | `gemini-notebook` | the Studio action, for example `video:cinematic` or `quiz` | Studio work. Empty on chat and sources | | `google-vids` | `video:text`, `video:image`, `video:ingredients`, `video:extend`, `video:upscale`, `video:edit`, `image`, `avatar:image`, `avatar:appearance` | What the request made. Empty on failed uploads | | `muse` | `muse-image`, `muse-video` | Generations and their end rows | | | `muse-chat` | Each chat message sent, and other chat requests that failed | | | `muse-chat-approval` | An approval Muse did not take | | | `muse-stream` | A chat stream that failed (status `failed` or `dropped`) | | | `muse-widget` | A widget the API can only pass through as `data` (status is the widget kind) | | | `muse-permissions` | A failed change to the agent's permissions | | | `muse-mcp` | A crash inside the [MCP server](/docs/api-muse-v1/mcp) | | | `sign-in` | A failed sign-in (status `refused` or `failed`), or Meta's security checkpoint on an added account (status `checkpoint`) | | | `quota` | A failed live account read | `muse` rows also carry `tier`: the account's Muse plan, for example `HATCH_FREE` (free) or `PRODUCT_TIER_1` (Power). Empty before October 13, 2026. ##### Google Flow fields | Field | Meaning | |:------|:--------| | `captchaProviders` / `by_captcha_provider` | Captcha providers used | | `captchaRetry` / `avg_captcha_retry` | Captcha retries | | `tier` / `by_tier` | Google plan family, for example `PAYGATE_TIER_TWO`. Since May 21, 2026 | | `sku` / `by_sku` | The exact subscription, for example `WS_ULTRA`. Since May 21, 2026 | | `summary.lookup` | Plan names for the `tier` and `sku` values present, for example `WS_ULTRA` → `Workspace Ultra`. Read names from here rather than hard-coding them | | `backend` | `flow` (flow.google.com) or `labs` (the older backend). Since September 14, 2026, empty when the request failed before one was chosen | | `reason` / `by_reason` | Google's reason for refusing, for example `PUBLIC_ERROR_USER_QUOTA_REACHED`. Since September 25, 2026 | | `model_refusals` | Requests refused because the account's plan does not offer the model (`PUBLIC_ERROR_MODEL_ACCESS_DENIED`). They say something about the account, so `success_rate` leaves them out | | `account_refusals` | Requests refused because Google treats the Google account as belonging to someone under 18 (`PUBLIC_ERROR_USER_MINOR`). Google Flow refuses such an account whatever the request, so `success_rate` leaves them out too. Image uploads count from November 7, 2026 | | `bytes` | Size of an uploaded file, `0` on every other row | Rows without a plan (uploads, and rows from before May 21, 2026) count under `"(empty)"` in `by_tier` and `by_sku`. Before September 25, 2026, `model_refusals` are recovered from a sampled log, so a few older ones may still count against `success_rate`. > Invited members of an Ultra $199 family plan cannot use `veo-3.1-lite-low-priority` since September 23, 2026, and those requests count as `model_refusals`. Known `tier` and `sku` values: | Field | Enum value | Label | Plan | |---|---|---|---| | `tier` | `PAYGATE_TIER_NOT_PAID` | Free | Free tier | | `tier` | `PAYGATE_TIER_ONE` | Pro | Google AI Pro | | `tier` | `PAYGATE_TIER_TIER1P5` | Ultra $99 | Google AI Ultra $99/mo | | `tier` | `PAYGATE_TIER_TWO` | Ultra $199 | Google AI Ultra $199/mo | | `sku` | `G1_FREEMIUM` | Free | Google AI consumer Free | | `sku` | `G1_TIER1` | Pro | Google AI consumer Pro | | `sku` | `G1_TIER1P5` | Ultra $99 | Google AI consumer Ultra $99 | | `sku` | `G1_TIER2` | Ultra $199 | Google AI consumer Ultra $199 | | `sku` | `WS_FREEMIUM` | Workspace Free | Google Workspace, no AI add-on | | `sku` | `WS_ULTRA` | Workspace Ultra | Google Workspace + AI Ultra add-on | ##### Google Flow uploads Every upload that reaches Google writes a `post-assets` row (since September 19, 2026). - Uploads can be an account's busiest call. With `limit` they can push generations out of the window, so ask for a `date` without `limit` and filter `data` by `endpoint`. - `bytes` is the size sent to Google, also on refused uploads. There is no summary field: add up `bytes × sampleInterval` over the `post-assets` rows. - Uploads refused before reaching Google (bad token, file too large, every account already upload-limited) write no row. Rows with `code` `200` are the uploads Google accepted. Google limits uploads per account separately from generation. An account at the limit refuses every upload but still generates. The limit clears, so far within about two weeks. Counting `post-assets` rows per `config` shows how much of the allowance an account has used. ##### Model ```typescript // Response structure { bot: string // Bot name date?: string // Date filter applied (YYYY-MM-DD) limit?: number // Limit filter applied config?: string // Config filter applied page?: { // Only for a day of more than 50,000 rows, or an offset above 0 (see Large days) offset: number // First row of this page size: number // Rows in data rows: number // Rows in the whole day next_offset?: number // offset of the next page, missing on the last one } total: number // Generations the returned rows stand for (sum of sampleInterval over rows with origin submit or empty), on a paged day the whole day's; job ends, refused / read / crash rows and mcp rows are left out summary?: { // Aggregated statistics (omitted if no data) from: string // Earliest timestamp (ISO 8601) to: string // Latest timestamp (ISO 8601) time_span: string // Human readable duration (e.g., "2 days 5 hours") by_config: Record // Count per config/account by_code: Record // Count per HTTP status code by_endpoint: Record // Count per endpoint/verb by_status: Record // Count per job status success_rate: string // Percentage of generations with a 2xx code (e.g., "86.7%"); google-flow leaves model_refusals and account_refusals out, and reports "n/a" when every row is one avg_msec: number // Average response time of generations in ms jobs?: { // the job-end rows (endpoint -finished), every API with background jobs finished: number completed: number // finished results completion_rate: string avg_msec: number // submit to finished result, completed jobs only } // the APIs listed under Model names: by_model?: Record // Count per AI model // google-flow only: by_captcha_provider?: Record // Count per captcha provider avg_captcha_retry?: number // Average captcha retries by_reason?: Record // Count per Google refusal reason (google-flow, since 2026-09-25) model_refusals?: number // Requests refused because the account's plan lacks the model; not in success_rate (google-flow) account_refusals?: number // Requests refused because Google treats the account as under 18; not in success_rate (google-flow) by_tier?: Record // Count per Google userPaygateTier (since 2026-05-21). Pre-existing rows bucket under "(empty)". by_sku?: Record // Count per Google sku (since 2026-05-21). Pre-existing rows bucket under "(empty)". lookup?: { // Canonical enum -> human-readable label map for the tier/sku values present here. tiers: Record // e.g. { PAYGATE_TIER_TWO: "Ultra $199" }. Unknown enums map to themselves. skus: Record // e.g. { WS_ULTRA: "Workspace Ultra" }. Unknown enums map to themselves. } } data: Array<{ timestamp: string // ISO 8601 timestamp jobid: string // Job/task identifier config: string // Account/config used (channel for MJ, email/account for others) endpoint: string // API endpoint called status: string // Job status func: string // Function name code: number // HTTP status code msec: number // Duration in milliseconds origin: string // submit | finished | refused | read | crash; '' on rows written before 2026-11-01 outcome: string // ok | customer | account | vendor | ours; '' on rows written before 2026-11-01 error: string // normalised error text, URLs / emails / ids / numbers masked, <= 120 chars; '' on success and older rows // the APIs listed under Model names: model?: string // AI model used for generation // google-flow only: captchaProviders?: string // Captcha providers tried (comma-separated) captchaRetry?: number // Number of captcha retries tier?: string // Google userPaygateTier (PAYGATE_TIER_*). Empty for rows pre-2026-05-21. Resolve to a label via summary.lookup.tiers. sku?: string // Google sku (G1_*/WS_*). Empty for rows pre-2026-05-21. Resolve to a label via summary.lookup.skus. backend?: string // "flow" | "labs" — which Google backend served it. Empty for rows pre-2026-09-14. reason?: string // Google's refusal reason, e.g. "PUBLIC_ERROR_MODEL_ACCESS_DENIED". Empty on success. Before 2026-09-25 only plan refusals are filled in. bytes?: number // Size of an uploaded file. 0 on every row that is not post-assets. sampleInterval: number // How many requests this row stands for, usually 1 (see Totals) }> } ``` ##### Examples **Curl** ``` bash # Today's stats for google-flow curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v2/account/stats?bot=google-flow" # Specific date curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v2/account/stats?bot=google-flow&date=2026-01-31" # Second page of a large day (page.next_offset of the first page) curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v2/account/stats?bot=google-flow&date=2026-01-31&offset=20000" # Last 1000 records curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v2/account/stats?bot=kling&limit=1000" # Filter by config curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v2/account/stats?bot=runwayml&config=user@email.com" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const bot = 'google-flow'; const date = '2026-01-31'; const response = await fetch( `https://api.useapi.net/v2/account/stats?bot=${bot}&date=${date}`, { headers: { 'Authorization': `Bearer ${token}` } } ); const stats = await response.json(); console.log(`Total requests: ${stats.total}`); console.log('Stats:', stats.data); ``` **Python** ``` python import requests token = 'YOUR_API_TOKEN' headers = {'Authorization': f'Bearer {token}'} # Today's stats for google-flow response = requests.get( 'https://api.useapi.net/v2/account/stats', params={'bot': 'google-flow'}, headers=headers ) stats = response.json() print(f"Total requests: {stats['total']}") print('Stats:', stats['data']) ``` === URL: https://useapi.net/docs/account-management/get-account === Document URL: https://useapi.net/docs/account-management/get-account --- layout: default title: GET account description: "Retrieve your useapi.net account details and settings — including configured service accounts and the default replyUrl — via GET account in the useapi.net account-management API." parent: Account Management nav_order: 100 --- ## Retrieve useapi.net account information December 2023 (October 17, 2026) --- Use this endpoint to retrieve the list of all configured AI services accounts and current subscription status. Response fields descriptions: * `subscriptionIsActive` indicates your subscription status. * `subscriptions` is the number of purchased useapi.net subscriptions, you can buy more at [Subscription](/docs/subscription). * `maxAccountsPerAPI` is the maximum allowed number of accounts per each AI service based on your current subscriptions. A single useapi.net subscription supports up to three accounts for each AI service. If you need more accounts, you'll need to purchase additional [subscriptions](/docs/subscription). * `sub` indicates the date when subscription was renewed, in YYMMDD format. * `accounts` provides the number of `total`, `active`, and `error` accounts for each configured AI service. If you do not plan on fixing and reusing error accounts, you should delete them, as they count towards the total number of accounts and will consume subscription allocations. * `error` indicates if there are any outstanding issues with an account. * `subscriptionsNeededTotal` appears when a service has more accounts than `maxAccountsPerAPI` allows, and is the number of subscriptions you need to cover them. ### Need more accounts? Each subscription adds 3 accounts on every service: `1 sub = $15 → 2 = $25 → 3 = $35 → 4 = $45` The service where you connect the most accounts sets how many subscriptions you need. For example, 5 Google Flow accounts and 2 Kling accounts need 2 subscriptions.
Subscriptions needed1
Accounts per service3
Monthly cost$15
Use "Subscriptions needed" as the quantity at checkout, or change it later in the [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo). --- > **https://api.useapi.net/v2/account** ##### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Responses **200** **200 OK** ```json { "id": 12345, "email": "your@email.com", "created": "2023-07-25T03:02:28.676Z", "name": "Your Name", "subscriptionIsActive": true, "subscriptions": 1, "maxAccountsPerAPI": 3, "accounts": { "MiniMax API": { "total": 3, "active": 3 }, "Runway API": { "total": 1, "active": 1 }, "Google Flow API": { "total": 3, "active": 3 }, "Dreamina API": { "total": 1, "active": 1 } }, "verified": "2023-07-25T03:02:53.252Z", "sub": "250405" } ``` **401** **401 Unauthorized** ```json { "error": "Unauthorized", "code": 401 } ``` ##### Model ```typescript { // TypeScript, all fields are optional id: number; email: string; created: Date; name?: string; subscriptions: number; maxAccountsPerAPI: number; accounts: Record; updated?: Date; verified?: Date; sub?: string; replyUrl?: string; subscriptionsNeededTotal?: number; subscriptionIsActive?: boolean; error?: string; } ``` ##### Examples **Curl** ``` bash curl https://api.useapi.net/v2/account \ -H "Accept: application/json" \ -H "Authorization: Bearer …" ``` **JavaScript** ``` javascript const token = "API token"; const apiUrl = "https://api.useapi.net/v2/account"; const response = await fetch(apiUrl, { headers: { "Authorization": `Bearer ${token}`, }, }); const result = await response.json(); console.log("response", {response, result}); ``` **Python** ``` python import requests token = "API token" apiUrl = "https://api.useapi.net/v2/account" headers = { "Content-Type": "application/json", "Authorization" : f"Bearer {token}" } response = requests.get(apiUrl, headers=headers) print(response, response.json()) ``` === URL: https://useapi.net/docs/account-management/get-stats-daily === Document URL: https://useapi.net/docs/account-management/get-stats-daily --- layout: default title: GET stats/daily description: "Browse the daily anonymized useapi.net stats — Google Flow captcha providers, Google Flow and PixVerse success rates by model, Muse best single account — via GET stats/daily, no API token needed." parent: Account Management nav_order: 400 --- ## Daily anonymized stats October 4, 2026 (October 28, 2026) --- Every day we publish anonymized stats for the previous full UTC day. They are also announced in the `#daily-stats` channel of our [Discord server](https://discord.gg/w28uK3cnmF). - [Google Flow](/docs/api-google-flow-v1) Captcha (after 00:03 UTC): each captcha provider's share of jobs, how often its token is accepted on the first try and overall, and how long it takes, for images, videos and audio. - [Google Flow](/docs/api-google-flow-v1) (after 00:18 UTC): success rate, median time and results by model, the best single account per model and Google plan, and results by Google plan, for images and videos. - [PixVerse](/docs/api-pixverse-v2) (after 00:33 UTC): by model, the share of requests PixVerse accepted, the share of jobs that ended with a finished video or image, the median time from submit to the finished file, the results, and the best single account per model, for images and videos. Completion and time start with October 28, 2026. - [Muse](/docs/api-muse-v1) (after 00:48 UTC): the most successful images, videos and chat messages a single account made, with that account's Muse plan, the success rate across all customers and the average job time for images and videos. The stats show shares, rates and times, plus the most successful requests a single anonymous account made per model (for Google Flow, per model and plan). They contain no user or account data. Rows from fewer than 3 customers, and then one more small row, are not shown (the Muse report shows every row). Reports are kept for 90 days. For the same numbers about your own requests, use [GET account/stats](/docs/account-management/get-account-stats) and, for Google Flow captchas, [GET accounts/captcha-stats](/docs/api-google-flow-v1/get-google-flow-accounts-captcha-stats). > **https://api.useapi.net/v1/stats/daily** ##### Request Headers No API token is needed. The stats are public. ##### Query Parameters - `list` optional. Set to `true` to get the available dates and report types instead of a report. - `type` optional, the report: `google-flow-captcha` (default), `google-flow`, `pixverse` or `muse`. - `date` optional, the UTC day in `YYYY-MM-DD` format. Defaults to the latest day available. ##### Responses **200** **200 OK** The report as Markdown (`Content-Type: text/markdown`). The `X-Report-Date` and `X-Report-Type` headers name the day and the report. With `list=true`, a JSON list of what is available, newest day first: ```json { "dates": ["2026-10-03", "2026-10-02"], "types": ["google-flow-captcha", "google-flow", "pixverse", "muse"] } ``` **400** **400 Bad Request** ```json { "error": "date must be YYYY-MM-DD", "code": 400 } ``` **404** **404 Not Found** There is no report of that type for that day, for example a day older than 90 days. ```json { "error": "No google-flow report for 2026-06-01", "code": 404 } ``` ##### Examples **Curl** ``` bash curl "https://api.useapi.net/v1/stats/daily?list=true" curl "https://api.useapi.net/v1/stats/daily?type=google-flow-captcha&date=2026-10-03" ``` **JavaScript** ``` javascript const res = await fetch("https://api.useapi.net/v1/stats/daily?type=google-flow"); console.log(res.headers.get("X-Report-Date"), await res.text()); ``` **Python** ``` python import requests res = requests.get("https://api.useapi.net/v1/stats/daily", params={"type": "pixverse"}) print(res.headers.get("X-Report-Date"), res.text) ``` ##### View the reports
=== URL: https://useapi.net/docs/account-management/post-account-token-reset === Document URL: https://useapi.net/docs/account-management/post-account-token-reset --- layout: default title: POST account/token/reset description: "Reset your useapi.net API token via POST account/token/reset — a 15-minute email confirmation link, then a new token in place of the old one." parent: Account Management nav_order: 300 --- ## Reset your useapi.net API token October 3, 2026 --- Use this when you think your API token was exposed, or simply want a new one. The reset takes two steps, so a stolen token or a stolen website sign-in alone can never change it: 1. This endpoint emails a confirmation link to your account email. Nothing changes yet. The link is good for 15 minutes. 2. You open the link and click **Reset token** on useapi.net. A new token is issued and we email you the same link as in your welcome email, which now shows the new token. After the reset, the old token is refused for almost every request right away. For a short while it may still: - use the MiniMax image and video endpoints (start, check, cancel or delete generations), for up to 10 minutes - read the status and results of your Mureka and Google Flow jobs, including ones started with the new token, for up to 30 minutes - repeat a read-only request it just made, for up to 1 minute Everything else, including other services, adding accounts and changing settings, is refused right away. You are also signed out of the useapi.net website in every browser, with the same short windows as the old token. Sign in again at [useapi.net/login](/login). Both emails show when and from where the request was made (time, IP address, approximate location and browser or client), so you can tell whether it was you. > **https://api.useapi.net/v2/account/token/reset** ##### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. It works for lapsed subscriptions too, so you can reset the token before you renew. ##### Responses **200** **200 OK** The confirmation link was emailed. Your token has not changed yet. If you ask again within 2 minutes you get the same answer, usually without a second email. Use the link you already have. ```json { "message": "We emailed a confirmation link to you@example.com. Your API token changes only after you open that link and confirm. The link is good for 15 minutes." } ``` **401** **401 Unauthorized** ```json { "error": "useapi.net ⁝ Unauthorized", "code": 401 } ``` **502** **502 Bad Gateway** The confirmation email could not be sent. Nothing changed, try again. ```json { "error": "Could not send the confirmation email, please try again", "code": 502 } ``` ##### Model ```typescript { // TypeScript, all fields are optional message: string error: string code: number } ``` ##### Examples **Curl** ``` bash curl -H "Authorization: Bearer …" \ -X POST https://api.useapi.net/v2/account/token/reset ``` **JavaScript** ``` javascript const token = "API token"; const response = await fetch("https://api.useapi.net/v2/account/token/reset", { method: "POST", headers: { "Authorization": `Bearer ${token}` } }); const result = await response.json(); console.log("response", { response, result }); ``` **Python** ``` python import requests token = "API token" response = requests.post("https://api.useapi.net/v2/account/token/reset", headers={"Authorization": f"Bearer {token}"}) print(response, response.json()) ``` === URL: https://useapi.net/docs/account-management/post-account === Document URL: https://useapi.net/docs/account-management/post-account --- layout: default title: POST account description: "Update your useapi.net account settings, such as the default replyUrl webhook, via POST account in the useapi.net account-management API." parent: Account Management nav_order: 200 --- ## Update useapi.net account information December 2023 (April 7, 2025) --- > **https://api.useapi.net/v2/account** ##### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Request Body ```json { "name": "User name", "replyUrl": "Default callback URL to be used for all API endpoints, API will call the provided replyUrl once job completed or failed" } ``` - `name` optional, account user name. - `replyUrl` optional, provided value will be used as default value for all API calls unless you choose to override them for individual calls. Place here your callback URL. API will call the provided `replyUrl` once job completed or failed. Maximum length 1024 characters. We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality. ##### Responses **204** **204 No Content** Account was successfully updated. Use [GET account](/docs/account-management/get-account) to retrieve updated account information. **400** **400 Bad Request** ```json { "error": "replyUrl is too long", "code": 400 } ``` **401** **401 Unauthorized** ```json { "error": "Unauthorized", "code": 401 } ``` ##### Examples **Curl** ``` bash curl -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer …" \ -X POST https://api.useapi.net/v2/account \ -d '{"name": "…", "replyUrl": "…"}' ``` **JavaScript** ``` javascript const apiUrl = "https://api.useapi.net/v2/account"; const token = "API token"; const user = "User name"; const replyUrl = "Callback URL"; const data = { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' } }; data.body = JSON.stringify({ user, replyUrl }); const response = await fetch(apiUrl, data); const result = await response.json(); console.log("response", {response, result}); ``` **Python** ``` python import requests apiUrl = "https://api.useapi.net/v2/account" token = "API token" user = "User name" replyUrl = "Callback URL" headers = { "Content-Type": "application/json", "Authorization" : f"Bearer {token}" } body = { "user": f"{user}", "replyUrl": f"{replyUrl}" } response = requests.post(apiUrl, headers=headers, json=body) print(response, response.json()) ``` === URL: https://useapi.net/docs/start-here/setup-dreamina === Document URL: https://useapi.net/docs/start-here/setup-dreamina --- layout: default title: Setup Dreamina description: "How to set up Dreamina for the useapi.net API — connect your account and start generating via the API." parent: Start Here nav_order: 206 --- # Dreamina February 23, 2026 (November 1, 2026) ## Table of contents Approximately 10 minutes to complete setup steps. --- > This is the setup guide for [Dreamina API](/docs/api-dreamina-v1). An active [Dreamina](https://dreamina.capcut.com/) subscription and a [useapi.net subscription](/docs/subscription) are required for the API to work. [Dreamina](https://dreamina.capcut.com/) creates AI-generated videos and images using models from [ByteDance's Seed](https://seed.bytedance.com/) family. The API supports two regions: **US** and **CA** (Canada). Both expose `seedance-2.5`, `seedance-2.0`, `seedance-2.0-fast`, and `seedance-2.0-mini` at the same resolutions, up to 1080p on `seedance-2.5` and 4K on the Seedance 2.0 models. The image models differ — `seedream-5.0-pro`, `seedream-4.7` and `nano-banana` are CA-only. See the [Cost calculator](#cost-calculator) below for per-region pricing. CA is the only region offering `happyhorse-1.1`, `wan-3.0`, the Seedance 1.0 Pro and Fast models, and 1080p on `seedance-1.5-pro`. `seedance-1.0-mini` is US only. ### VPN setup A VPN with a US or Canadian IP address is required to create a Dreamina account. The VPN is only needed for browser-based account creation — the API handles all requests through its own proxy infrastructure. **For US region accounts:** [Opera](https://www.opera.com/) browser has a built-in free VPN. 1. Download and install [Opera](https://www.opera.com/) if you don't have it already 2. Enable the built-in VPN by clicking the **VPN** badge in the address bar 3. Set the VPN region to **Americas** 4. Verify the VPN is active — you should see "Protected" and an Americas IP address ![](/assets/images/setup-dreamina-1.jpg) **For CA region accounts:** Opera's free VPN does not support the Canadian region. You will need a commercial VPN service that offers Canadian server locations (e.g., NordVPN, ExpressVPN, Surfshark, or similar). Set your VPN to a **Canada** server before creating the account. ### Create a Dreamina account **Use a dedicated email account for this API — do NOT use your personal email.** 1. Navigate to [https://dreamina.capcut.com/](https://dreamina.capcut.com/) with your VPN active and set to the desired region (Americas for US, Canada for CA) 2. Verify your region by checking the URL — US accounts will see `dreamina.capcut.com`, CA accounts may see a Canadian IP in the VPN indicator 3. Click **Sign in** in the bottom-left corner 4. Select **Continue with email** from the login options ![](/assets/images/setup-dreamina-2.jpg) 5. Click **Sign up** to create a new account 6. Enter your **email address** and choose a **password** 7. Click **Continue** to complete registration ![](/assets/images/setup-dreamina-3.jpg) You may need to verify your email address by entering a code sent to your inbox. ### Verify available models Before adding your account to the API, confirm that the desired Seedance models are available: 1. Navigate to [https://dreamina.capcut.com/ai-tool/generate](https://dreamina.capcut.com/ai-tool/generate) 2. Select **AI Video** from the mode selector at the bottom 3. Click the model name to open the model dropdown and verify that your desired models (e.g., Seedance 2.0 Fast, Seedance 2.0) are listed ![](/assets/images/setup-dreamina-5.jpg) If you don't see Seedance 2.0 models, your account may have been created in the wrong region. Create a new account with the correct VPN region. We recommend starting with the **Basic plan** to verify that subscription and generation work end-to-end before upgrading to the **Advanced plan**. The model dropdown is only an advertisement — Dreamina sometimes lists models that fail at execution for a given region or account. Running one successful generation on the Basic plan confirms the model actually works for your account before you commit to a larger plan. ### Verify and add account Use the form below to verify your credentials and add your Dreamina account. Select **Add Account** to complete setup, or **Verify** to test your credentials first. You should receive response `200` if successful. You can also use [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts) directly.
### Cost calculator Billed seconds are the output duration plus every input video attached, rounded down to a whole second. On an edit that includes the source video itself, which is counted once as the input and once as the output. Two live CA generations on 2026-09-07 landed on the predicted figure exactly: a 21.3-second edit billed 42 seconds (756 credits) and a 35-second long video built from a 21.3-second reference billed 56 (1,680). Dollars per second on the Advanced subscription billed monthly: US $79 for 8,645 credits, Canada C$109.99 for 11,997 credits, converted at CAD/USD 0.7112 (as of October 21, 2026). | Model | US $/sec | CA $/sec | |-------|---------:|---------:| | Seedance 2.5 @480p, with a video reference | $0.128 | $0.117 | | Seedance 2.5 @480p | $0.155 | $0.143 | | Seedance 2.5 @720p | $0.338 | $0.313 | | Seedance 2.5 @1080p | $0.832 | $0.763 | | Seedance 2.5 long video @480p | $0.210 | $0.196 | | Seedance 2.5 long video @720p | $0.411 | $0.378 | | Seedance 2.5 long video @1080p | $0.923 | $0.848 | | Seedance 2.0 @720p | $0.155 | $0.150 | | Seedance 2.0 @1080p | $0.375 | $0.372 | | Seedance 2.0 @4K | $0.896 | $0.822 | | Seedance 2.0 Fast @720p | $0.073 | $0.065 | | Seedance 2.0 Fast @1080p | $0.128 | $0.098 | | Seedance 2.0 Fast @2K | $0.155 | $0.117 | | Seedance 2.0 Fast @4K | $0.201 | $0.150 | | Seedance 2.0 Mini @720p | $0.046 | $0.046 | | Seedance 2.0 Mini @1080p | $0.101 | $0.085 | | Seedance 2.0 Mini @2K | $0.128 | $0.098 | | Seedance 2.0 Mini @4K | $0.174 | $0.130 | | Seedance 1.5 Pro @720p | $0.146 | $0.143 | | HappyHorse 1.1 @720p | — | $0.111 | | HappyHorse 1.1 @1080p | — | $0.150 | | Wan 3.0 @720p | — | $0.111 | | Wan 3.0 @1080p | — | $0.274 | Seedance 2.5 bills a reference video's duration on top of the output, so a 4-second video from a 5-second reference bills 9 seconds, at the lower with-reference rate, which now applies at 480p only. Canada costs up to 25% less per second (on Seedance 2.0 Fast and Mini above 720p, and the same on Mini at 720p), because its subscription buys 153 credits per US dollar against 109 in the US, even though each video uses more credits. Canada also has HappyHorse 1.1, Wan 3.0, Seedance 1.0 Pro and Fast, and 1080p on Seedance 1.5 Pro. Credits per image at 1K / 2K / 4K: | Model | US | CA | |-------|----|----| | GPT Image 2.5 Flare and Sunburst | 8 / 11 / 13 (launch price, normally 10 / 14 / 17) | 9 / 13 / 16 (launch price, normally 13 / 18 / 22) | | Nano Banana Pro | 42 / 42 / 75 | 53 / 53 / 95 | | GPT Image 2 | 21 / 38 / 48 | 27 / 48 / 61 | Yearly billing lowers the US Advanced subscription to $900 a year ($75 a month), and Canada's to C$1,299.99 a year. [Setup Dreamina](/docs/start-here/setup-dreamina#cost-calculator) has the credits behind each rate. Credits per second behind those rates, from each region's own price metadata (read October 21, 2026, and October 23 for the US Seedance 2.0 rows above 720p and the Fast and Mini rows above 720p): | Model | US cr/sec | CA cr/sec | |-------|----------:|----------:| | Seedance 2.5 @480p, with a video reference | 14 | 18 | | Seedance 2.5 @480p | 17 | 22 | | Seedance 2.5 @720p | 37 | 48 | | Seedance 2.5 @1080p | 91 | 117 | | Seedance 2.5 long video @480p | 23 | 30 | | Seedance 2.5 long video @720p | 45 | 58 | | Seedance 2.5 long video @1080p | 101 | 130 | | Seedance 2.0 @720p | 17 | 23 | | Seedance 2.0 @1080p | 41 | 57 | | Seedance 2.0 @4K | 98 | 126 | | Seedance 2.0 Fast @720p | 8 | 10 | | Seedance 2.0 Fast @1080p | 14 | 15 | | Seedance 2.0 Fast @2K | 17 | 18 | | Seedance 2.0 Fast @4K | 22 | 23 | | Seedance 2.0 Mini @720p | 5 | 7 | | Seedance 2.0 Mini @1080p | 11 | 13 | | Seedance 2.0 Mini @2K | 14 | 15 | | Seedance 2.0 Mini @4K | 19 | 20 | | Seedance 1.5 Pro @720p | 16 | 22 | | HappyHorse 1.1 @720p | — | 17 | | HappyHorse 1.1 @1080p | — | 23 | | Wan 3.0 @720p | — | 17 | | Wan 3.0 @1080p | — | 42 | Rates move: on August 14, 2026 a US Seedance 2.5 video at 720p with a video reference used 27 credits a second, and it now uses 37, the same as without one. Treat the tables as a snapshot. Long video, any `duration` from 31 to 180 seconds, is priced on its own higher scale — on CA 30 credits a second at 480p against 22 for an ordinary generation without a reference, and 58 against 48 at 720p — and gets no reference discount at all.
Show the math Dollars per credit, from the Advanced subscription billed monthly: | Region | Plan | Credits/month | Per credit | Credits per USD | |--------|------|--------------:|-----------:|----------------:| | US | $79/mo | 8,645 | $0.009138 | 109.4 | | CA | C$109.99/mo = $78.23 | 11,997 | $0.006520 | 153.4 | Both were read on 2026-10-21, US on dreamina.capcut.com and CA from Dreamina's Canadian price list, with CA converted at CAD/USD 0.711213. Billed yearly, US is $900 a year ($75 a month, $0.008676 a credit) and CA is C$1,299.99 a year (about C$108.33 a month, $0.006422 a credit). First-month and first-year prices are promotional and not used here. Failed generations are not charged.
### Important notes - **First generation via browser** — after setting up your account, generate at least one video using the Dreamina website (e.g., a short Seedance 2.0 Fast clip in Omni Reference mode) to ensure the service is working and to accept the Terms of Service. This is a one-time step before using the API. - **VPN not required for API usage** — the VPN is only needed for creating the Dreamina account in the browser. The API handles all requests through its own proxy infrastructure. - **Region is permanent** — use the same region for the account as the VPN used during creation. US accounts must use `region: "US"`, Canadian accounts must use `region: "CA"`. - **Session management** — the API automatically manages your Dreamina session, including refreshing expired sessions. If you see `596` errors, check [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts) first: an account with `signedOutPauseUntil` is paused for 30 minutes after Dreamina signed it out right after a fresh sign-in, and comes back by itself. Otherwise re-add your account via [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts). - **Avoid using the same account** simultaneously through both the API and the Dreamina website — it should work, but to play safe it's better to avoid potential session conflicts. - **Avoid logging in from other regions** — do not log in to your Dreamina account from any region other than the one used during creation, as it may change the account's default region. - **Free credits** — new Dreamina accounts receive free credits. Check your balance via [GET /accounts/`account`](/docs/api-dreamina-v1/get-dreamina-accounts-account). === URL: https://useapi.net/docs/api-dreamina-v1/delete-dreamina-accounts-account === Document URL: https://useapi.net/docs/api-dreamina-v1/delete-dreamina-accounts-account --- layout: default title: DELETE accounts/`account` description: "Delete a configured Dreamina account via DELETE accounts/account in the useapi.net Dreamina API v1, removing it from configuration and cleaning up active jobs." parent: Dreamina API nav_order: 400 --- ## Delete Account Configuration February 23, 2026 --- Delete a configured Dreamina account. This removes the account from your configuration and cleans up any executing job entries. **Warning:** This action cannot be undone. You will need to reconfigure the account using [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts) if you want to use it again. > **https://api.useapi.net/v1/dreamina/accounts/`account`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `account` is **required**. ### Responses **200** **200 OK** Account deleted successfully. ```json { "account": "US:user@example.com", "deleted": true, "remaining": 0 } ``` - `remaining` - Number of other accounts still configured. **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Account not found or not configured. ```json { "error": "Unable to find configuration for account US:user@example.com" } ``` ### Examples **Curl** ``` bash curl -X DELETE \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/accounts/US:user@example.com" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const account = 'US:user@example.com'; const response = await fetch( `https://api.useapi.net/v1/dreamina/accounts/${encodeURIComponent(account)}`, { method: 'DELETE', headers: { 'Authorization': `Bearer ${token}` } } ); const result = await response.json(); console.log('Delete result:', result); ``` **Python** ``` python import requests from urllib.parse import quote token = 'YOUR_API_TOKEN' account = 'US:user@example.com' headers = {'Authorization': f'Bearer {token}'} response = requests.delete( f'https://api.useapi.net/v1/dreamina/accounts/{quote(account, safe="")}', headers=headers ) print('Delete result:', response.json()) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/delete-dreamina-assets-assetid === Document URL: https://useapi.net/docs/api-dreamina-v1/delete-dreamina-assets-assetid --- layout: default title: DELETE assets/`assetId` description: "Delete an image or video asset from Dreamina generation history by assetId via DELETE assets/assetId in the useapi.net Dreamina API v1." parent: Dreamina API nav_order: 520 --- ## Delete Asset March 2, 2026 --- Delete a specific asset (image or video) from generation history. The `assetId` is obtained from [GET /assets/`account`](/docs/api-dreamina-v1/get-dreamina-assets-account), completed [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid), or [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) results. > **https://api.useapi.net/v1/dreamina/assets/`assetId`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `assetId` is **required**. ### Responses **200** **200 OK** Asset deleted successfully. ```json { "deleted": true, "assetId": "US:user@example.com-306191111942:7612453183683579150", "account": "US:user@example.com" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Account not found or not configured. ```json { "error": "Unable to find configuration for account US:user@example.com" } ``` ### Examples **Curl** ``` bash curl -X DELETE \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/assets/US:user@example.com-306191111942:7612453183683579150" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const assetId = 'US:user@example.com-306191111942:7612453183683579150'; const response = await fetch( `https://api.useapi.net/v1/dreamina/assets/${encodeURIComponent(assetId)}`, { method: 'DELETE', headers: { 'Authorization': `Bearer ${token}` } } ); const result = await response.json(); console.log('Delete result:', result); ``` **Python** ``` python import requests from urllib.parse import quote token = 'YOUR_API_TOKEN' asset_id = 'US:user@example.com-306191111942:7612453183683579150' response = requests.delete( f'https://api.useapi.net/v1/dreamina/assets/{quote(asset_id, safe="")}', headers={'Authorization': f'Bearer {token}'} ) print('Delete result:', response.json()) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/delete-dreamina-scheduler-jobid === Document URL: https://useapi.net/docs/api-dreamina-v1/delete-dreamina-scheduler-jobid --- layout: default title: DELETE scheduler/`jobid` description: "Remove a Dreamina generation job from the executing tracker via DELETE scheduler/jobid in the useapi.net Dreamina API v1 — cancels it and marks in-progress entries as failed." parent: Dreamina API nav_order: 810 --- ## Cancel Executing Job February 23, 2026 --- Remove a job from the executing tracker and cancel it. If the job is still in `created` status, it will be marked as failed with the reason "Cancelled by user". > **https://api.useapi.net/v1/dreamina/scheduler/`jobid`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `jobid` is **required**. The job ID to remove from the scheduler. ### Responses **200** **200 OK** Job removed from scheduler. ```json { "jobid": "j0223140530123456789v-u12345-US:user@example.com-bot:dreamina", "removed": true } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Job belongs to a different user. ### Examples **Curl** ``` bash curl -X DELETE \ -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/scheduler/j0223140530123456789v-u12345-US:user@example.com-bot:dreamina" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const jobid = 'j0223140530123456789v-u12345-US:user@example.com-bot:dreamina'; const response = await fetch( `https://api.useapi.net/v1/dreamina/scheduler/${jobid}`, { method: 'DELETE', headers: { 'Authorization': `Bearer ${token}` } } ); const result = await response.json(); console.log('Cancel result:', result); ``` **Python** ``` python import requests token = 'YOUR_API_TOKEN' jobid = 'j0223140530123456789v-u12345-US:user@example.com-bot:dreamina' headers = {'Authorization': f'Bearer {token}'} response = requests.delete( f'https://api.useapi.net/v1/dreamina/scheduler/{jobid}', headers=headers ) print('Cancel result:', response.json()) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-accounts-account === Document URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-accounts-account --- layout: default title: GET accounts/`account` description: "Retrieve a Dreamina account's session status, available models, and credit balance via GET accounts/account in the useapi.net Dreamina API v1." parent: Dreamina API nav_order: 350 --- ## Get Account Configuration February 23, 2026 (November 1, 2026) --- Get configuration details for a specific Dreamina account, including session status, available models, and credit balance. Can also be called once a day to claim free daily credits. > **https://api.useapi.net/v1/dreamina/accounts/`account`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `account` is **required**. ### Responses **200** **200 OK** Account details retrieved with live data from upstream. ```json { "account": "US:user@example.com", "email": "user@example.com", "region": "US", "maxJobs": 10, "sessionExpires": "2026-04-24T12:00:00.000Z", "session": { "expires": "2026-04-24T12:00:00.000Z", "lastRefreshed": "2026-02-23T12:00:00.000Z", "daysUntilExpiry": 60 }, "models": { "video": ["seedance-2.0", "seedance-1.5-pro", "seedance-1.0-mini"], "image": ["seedream-5.0-lite", "seedream-4.6", "seedream-4.5", "seedream-4.1", "seedream-4.0", "seedream-3.0"] }, "credits": { "total": 24065, "vip": 12000, "gift": 10065, "purchase": 2000, "dailyClaimed": true } } ``` **Note:** The `models`, `credits`, and `session` fields are fetched live from upstream. If upstream queries fail, a summary without these fields is returned. An account in its sign-out pause also carries `signedOutPauseUntil`. When Dreamina signs an account out again right after a fresh sign-in, the account is paused for 30 minutes. While the pause runs, [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts) shows `signedOutPauseUntil` (an ISO 8601 time) on that account, requests that name it answer `596`, and automatic account selection uses your other accounts. When every account is paused, requests answer `596`. After the pause the account is used again. If Dreamina signs it out right after a fresh sign-in again, after the pause and within 24 hours, the account is marked with an `error` and answers `596` until you re-add it with [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts). Re-adding an account also ends its pause. A sign-in that fails for a temporary reason, not because Dreamina refused the account, answers `503` with a `Retry-After: 30` header. The account is fine: retry in about 30 seconds. **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Account not found or not configured. ```json { "error": "Unable to find configuration for account US:user@example.com" } ``` ### Model ```typescript { account: string // "US:user@example.com" email: string region: string // "US" maxJobs: number // 1-50 sessionExpires: string // ISO 8601 timestamp session?: { expires: string // ISO 8601 timestamp lastRefreshed: string // ISO 8601 timestamp daysUntilExpiry: number } models?: { video: string[] // Available video model names image: string[] // Available image model names } credits?: { total: number vip: number gift: number purchase: number dailyClaimed: boolean } error?: string // Error message; the account answers 596 until re-added signedOutPauseUntil?: string // ISO 8601 timestamp, only while the account's sign-out pause runs } ``` ### Examples **Curl** ``` bash curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/accounts/US:user@example.com" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const account = 'US:user@example.com'; const response = await fetch( `https://api.useapi.net/v1/dreamina/accounts/${encodeURIComponent(account)}`, { headers: { 'Authorization': `Bearer ${token}` } } ); const accountConfig = await response.json(); console.log('Account:', accountConfig); console.log('Credits:', accountConfig.credits); console.log('Models:', accountConfig.models); ``` **Python** ``` python import requests from urllib.parse import quote token = 'YOUR_API_TOKEN' account = 'US:user@example.com' headers = {'Authorization': f'Bearer {token}'} response = requests.get( f'https://api.useapi.net/v1/dreamina/accounts/{quote(account, safe="")}', headers=headers ) account_config = response.json() print('Account:', account_config) print('Credits:', account_config.get('credits')) print('Models:', account_config.get('models')) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-accounts === Document URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-accounts --- layout: default title: GET accounts description: "List all configured Dreamina accounts via GET accounts in the useapi.net Dreamina API v1 — quick overview without live session details." parent: Dreamina API nav_order: 300 --- ## List All Configured Accounts February 23, 2026 (November 1, 2026) --- List all configured Dreamina accounts. To get a specific account with live details use [GET /accounts/`account`](/docs/api-dreamina-v1/get-dreamina-accounts-account). > **https://api.useapi.net/v1/dreamina/accounts** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Responses **200** **200 OK** Returns a map of all configured accounts, keyed by account identifier. ```json { "US:user@example.com": { "account": "US:user@example.com", "email": "user@example.com", "region": "US", "maxJobs": 10, "sessionExpires": "2026-04-24T12:00:00.000Z" } } ``` If no accounts are configured, returns an empty object `{}`. An account in its sign-out pause also carries `signedOutPauseUntil`, and a marked account carries `error`: ```json { "US:user@example.com": { "account": "US:user@example.com", "email": "user@example.com", "region": "US", "maxJobs": 10, "sessionExpires": "2026-04-24T12:00:00.000Z", "signedOutPauseUntil": "2026-11-01T18:30:00.000Z" } } ``` When Dreamina signs an account out again right after a fresh sign-in, the account is paused for 30 minutes. While the pause runs, [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts) shows `signedOutPauseUntil` (an ISO 8601 time) on that account, requests that name it answer `596`, and automatic account selection uses your other accounts. When every account is paused, requests answer `596`. After the pause the account is used again. If Dreamina signs it out right after a fresh sign-in again, after the pause and within 24 hours, the account is marked with an `error` and answers `596` until you re-add it with [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts). Re-adding an account also ends its pause. A sign-in that fails for a temporary reason, not because Dreamina refused the account, answers `503` with a `Retry-After: 30` header. The account is fine: retry in about 30 seconds. **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` ### Model ```typescript // Map of account identifier to account summary { [account: string]: { account: string // "US:user@example.com" email: string region: string // "US" maxJobs: number sessionExpires: string // ISO 8601 timestamp error?: string // Error message if account has issues; the account answers 596 until re-added signedOutPauseUntil?: string // ISO 8601 timestamp, only while the account's sign-out pause runs } } ``` ### Examples **Curl** ``` bash curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/accounts" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const response = await fetch('https://api.useapi.net/v1/dreamina/accounts', { headers: { 'Authorization': `Bearer ${token}` } }); const accounts = await response.json(); console.log('Configured accounts:', accounts); ``` **Python** ``` python import requests token = 'YOUR_API_TOKEN' headers = {'Authorization': f'Bearer {token}'} response = requests.get('https://api.useapi.net/v1/dreamina/accounts', headers=headers) print('All accounts:', response.json()) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-assets-account === Document URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-assets-account --- layout: default title: GET assets/`account` description: "Retrieve Dreamina generation history for an account via GET assets/account in the useapi.net Dreamina API v1 — asset URLs, dimensions, and assetRef for images (videos return a videoUrl)." parent: Dreamina API nav_order: 510 --- ## List Generation History March 2, 2026 --- List generation history (images and videos) for a specific account. Returns assets with their URLs, dimensions, and reusable `assetRef` values for [POST /images](/docs/api-dreamina-v1/post-dreamina-images) or as in [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos). > **https://api.useapi.net/v1/dreamina/assets/`account`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `account` is **required**. ### Query Parameters - `count` is optional. Number of assets to return (1-100, default: `20`). - `offset` is optional. Pagination cursor from a previous response's `nextOffset`. ### Responses **200** **200 OK** Returns generation history with asset details. ```json { "assets": [ { "assetId": "US:user@example.com-306191111942:7612453183683579150", "historyRecordId": "306191111942", "itemId": "7612453183683579150", "type": "image", "coverUrl": "https://p9-sign.douyinpic.com/...", "description": "A stunning aurora borealis over a frozen lake", "assetRef": "US:user@example.com-image:w2560:h1440:s905000-uri:tos-useast5-i-wopfjsm1ax-tx/abc123", "imageUrl": "https://p9-sign.douyinpic.com/...", "width": 2560, "height": 1440, "format": "webp", "createdAt": "2026-03-02T14:06:06.000Z" }, { "assetId": "US:user@example.com-306191137798:7612453244173880589", "historyRecordId": "306191137798", "itemId": "7612453244173880589", "type": "video", "coverUrl": "https://p9-sign.douyinpic.com/...", "description": "A cinematic drone shot", "videoUrl": "https://v16m-default.akamaized.net/...", "width": 1280, "height": 720, "createdAt": "2026-03-02T14:08:07.000Z" } ], "hasMore": true, "nextOffset": 20, "account": "US:user@example.com" } ``` - `assetRef` on image assets can be used directly as `imageRef_N` in [POST /images](/docs/api-dreamina-v1/post-dreamina-images) or as `firstFrameRef` in [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos). - `assetId` can be used with [DELETE /assets/`assetId`](/docs/api-dreamina-v1/delete-dreamina-assets-assetid) to remove an asset. - Videos do not have `assetRef` — only a `videoUrl` for download. **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Account not found or not configured. ```json { "error": "Unable to find configuration for account US:user@example.com" } ``` ### Model ```typescript { assets: Array<{ assetId: string // ID for DELETE /assets/ historyRecordId: string itemId: string type: 'image' | 'video' coverUrl?: string // Thumbnail URL description?: string // Generation prompt assetRef?: string // Reusable ref (images only) imageUrl?: string // Full image URL (images only) videoUrl?: string // Video URL (videos only) width?: number height?: number format?: string // Image format (images only) createdAt?: string // ISO 8601 timestamp }> hasMore: boolean // More pages available nextOffset: number // Pass as offset for next page account: string } ``` ### Examples **Curl** ``` bash curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/assets/US:user@example.com?count=10" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const account = 'US:user@example.com'; const response = await fetch( `https://api.useapi.net/v1/dreamina/assets/${encodeURIComponent(account)}?count=20`, { headers: { 'Authorization': `Bearer ${token}` } } ); const result = await response.json(); console.log(`Assets: ${result.assets.length}, hasMore: ${result.hasMore}`); result.assets.forEach(a => { console.log(` ${a.type} ${a.assetId} ${a.width}x${a.height}`); if (a.assetRef) console.log(` assetRef: ${a.assetRef}`); }); ``` **Python** ``` python import requests from urllib.parse import quote token = 'YOUR_API_TOKEN' account = 'US:user@example.com' response = requests.get( f'https://api.useapi.net/v1/dreamina/assets/{quote(account, safe="")}', headers={'Authorization': f'Bearer {token}'}, params={'count': 20} ) result = response.json() print(f"Assets: {len(result['assets'])}, hasMore: {result['hasMore']}") for a in result['assets']: print(f" {a['type']} {a['assetId']} {a.get('width')}x{a.get('height')}") ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-images-jobid === Document URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-images-jobid --- layout: default title: GET images/`jobid` description: "Poll a Dreamina image generation or upscale job for status and results by job ID via GET images/jobid in the useapi.net Dreamina API v1 — jobs retained 30 days." parent: Dreamina API nav_order: 720 --- ## Retrieve Image Job Status March 2, 2026 (October 23, 2026) --- Retrieve the status and result of an image generation or upscale job by its job ID. Use this endpoint to poll for completion after submitting an image via [POST /images](/docs/api-dreamina-v1/post-dreamina-images) or [POST /images/upscale](/docs/api-dreamina-v1/post-dreamina-images-upscale). Jobs are retained for 30 days. > **https://api.useapi.net/v1/dreamina/images/`jobid`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `jobid` is **required**, the unique job identifier returned from [POST /images](/docs/api-dreamina-v1/post-dreamina-images) or [POST /images/upscale](/docs/api-dreamina-v1/post-dreamina-images-upscale). ### Responses **200** **200 OK** Returns the job record with current status and details. **Processing (status: created):** ```json { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "type": "image", "status": "created", "model": "seedream-4.0", "created": "2026-03-02T14:05:30.123Z", "request": { "prompt": "A stunning aurora borealis over a frozen lake", "model": "seedream-4.0", "ratio": "16:9", "resolution": "2k", "inputMode": "generate" }, "response": { "forecastCost": 0 }, "code": 200 } ``` **Completed (image generation):** ```json { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "type": "image", "status": "completed", "model": "seedream-4.0", "created": "2026-03-02T14:05:30.123Z", "updated": "2026-03-02T14:06:06.789Z", "request": { "prompt": "A stunning aurora borealis over a frozen lake", "model": "seedream-4.0", "ratio": "16:9", "resolution": "2k", "inputMode": "generate" }, "response": { "images": [ { "imageUrl": "https://p9-sign.douyinpic.com/...", "imageUri": "tos-useast5-i-wopfjsm1ax-tx/abc123", "width": 2560, "height": 1440, "format": "jpeg", "assetId": "US:user@example.com-306191111942:7612453183683579150", "assetRef": "US:user@example.com-image:w2560:h1440:s905000-uri:tos-useast5-i-wopfjsm1ax-tx/abc123", "itemId": "7612453183683579150" }, { "imageUrl": "https://p9-sign.douyinpic.com/...", "imageUri": "tos-useast5-i-wopfjsm1ax-tx/def456", "width": 2560, "height": 1440, "format": "jpeg", "assetId": "US:user@example.com-306191111942:7612453183683595534", "assetRef": "US:user@example.com-image:w2560:h1440:s911000-uri:tos-useast5-i-wopfjsm1ax-tx/def456", "itemId": "7612453183683595534" } ], "forecastCost": 0, "historyRecordId": "306191111942", "finishTime": 1709391966 }, "code": 200 } ``` **Completed (upscale):** ```json { "jobid": "j0302140630123456789I-u12345-US:user@example.com-bot:dreamina", "type": "upscale", "status": "completed", "model": "seedream-4.0", "created": "2026-03-02T14:06:30.123Z", "updated": "2026-03-02T14:08:07.456Z", "request": { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "imageIndex": 0, "resolution": "4k" }, "response": { "images": [ { "imageUrl": "https://p9-sign.douyinpic.com/...", "imageUri": "tos-useast5-i-wopfjsm1ax-tx/upscaled123", "width": 4096, "height": 4096, "format": "jpeg", "assetId": "US:user@example.com-306191137798:7612453244173880589", "assetRef": "US:user@example.com-image:w4096:h4096:s1482000-uri:tos-useast5-i-wopfjsm1ax-tx/upscaled123", "itemId": "7612453244173880589" } ], "forecastCost": 0, "historyRecordId": "306191137798", "finishTime": 1709392087 }, "code": 200 } ``` **Note:** The `assetRef` on each image can be used directly as `imageRef_N` in [POST /images](/docs/api-dreamina-v1/post-dreamina-images) for further generations, without needing to re-upload. **Failed:** ```json { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "type": "image", "status": "failed", "model": "seedream-4.0", "created": "2026-03-02T14:05:30.123Z", "updated": "2026-03-02T14:07:15.456Z", "request": { "prompt": "A test prompt", "model": "seedream-4.0", "ratio": "16:9", "resolution": "2k", "inputMode": "generate" }, "error": "fail_code: 2038", "errorDetails": "ContentFiltered", "code": 2038 } ``` **Note:** Jobs older than 1 hour that are still `created` are auto-marked as failed with `"Generation timed out"` (code `408`). **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Job not found, belongs to a different user, or has expired (>30 days). ```json { "error": "Job not found" } ``` ### Model **Completed** Image generation completed. Includes image URLs and metadata. ```typescript { jobid: string // Unique job identifier type: 'image' | 'upscale' // Job type status: 'completed' model: string // Model used created: string // ISO 8601 timestamp updated: string // ISO 8601 timestamp request: { prompt?: string model?: string ratio?: string resolution?: string inputMode?: string // Auto-detected from params imageRef_1?: string // Reference image assetRef (when provided) imageRef_2?: string imageRef_3?: string jobid?: string // Source job (upscale only) imageIndex?: number // Source image index (upscale only) replyUrl?: string replyRef?: string } response: { images: Array<{ imageUrl: string // Direct image URL (JPEG) imageUri: string // Native URI width: number // Image width in pixels height: number // Image height in pixels format: string // "jpeg" assetId: string // Asset identifier assetRef: string // Can be used as imageRef_N in POST /images itemId: string // Upstream item ID coverUrl?: string // Small preview of the image, can carry the AI badge, see Watermark }> forecastCost: number // Estimated generation time in seconds, NOT a price historyRecordId: string // Upstream history record finishTime: number // Unix timestamp of completion } code: number // 200 } ``` **Failed** Image generation failed. Includes error details. ```typescript { jobid: string type: 'image' | 'upscale' status: 'failed' model: string created: string updated: string request: { prompt?: string model?: string ratio?: string resolution?: string inputMode?: string replyUrl?: string replyRef?: string } error: string // Error summary errorDetails?: string // Additional details code: number // Error code } ``` **Common error codes:** | Code | Meaning | |------|---------| | 408 | Generation timed out (>1 hour) | | 596 | Account session expired | | 2038 | Content filtered | | 2057 | Upstream processing error | #### Watermark Dreamina adds an "AI" badge to the top-left corner of generated images unless the account's "close watermark" setting is on. We switch that setting on when you add or re-add an account with [POST accounts](/docs/api-dreamina-v1/post-dreamina-accounts). - On a paid Dreamina plan, `imageUrl` is the clean image. On some paid accounts Dreamina keeps the badge on its preview even with the setting on. For those, `imageUrl` is the clean copy that Dreamina's own Download button saves, at no extra cost. - `coverUrl` is a small preview of the image and can still carry the badge, so use `imageUrl` for the picture you keep or show. - Dreamina doesn't allow the setting on free accounts, so their images keep the badge, in `imageUrl` too. - The URLs are signed, so editing one to remove the badge does not work. ### Examples **Curl** ```bash curl "https://api.useapi.net/v1/dreamina/images/j0302140530123456789i-u12345-US:user@example.com-bot:dreamina" \ -H "Authorization: Bearer YOUR_API_TOKEN" ``` **JavaScript** ```javascript const apiToken = 'YOUR_API_TOKEN' const jobId = 'j0302140530123456789i-u12345-US:user@example.com-bot:dreamina' async function waitForImages(jobId, intervalMs = 10000) { while (true) { const response = await fetch(`https://api.useapi.net/v1/dreamina/images/${jobId}`, { headers: { 'Authorization': `Bearer ${apiToken}` } }) const job = await response.json() console.log(`Status: ${job.status}`) if (job.status === 'completed') { job.response.images.forEach((img, i) => console.log(` [${i}] ${img.width}x${img.height} ${img.format}`) ) return job } if (job.status === 'failed') throw new Error(job.error) await new Promise(resolve => setTimeout(resolve, intervalMs)) } } const job = await waitForImages(jobId) ``` **Python** ```python import requests import time api_token = 'YOUR_API_TOKEN' job_id = 'j0302140530123456789i-u12345-US:user@example.com-bot:dreamina' def wait_for_images(job_id: str, interval_sec: int = 10) -> dict: while True: job = requests.get( f'https://api.useapi.net/v1/dreamina/images/{job_id}', headers={'Authorization': f'Bearer {api_token}'} ).json() print(f"Status: {job['status']}") if job['status'] == 'completed': for i, img in enumerate(job['response']['images']): print(f" [{i}] {img['width']}x{img['height']} {img['format']}") # Download image img_response = requests.get(img['imageUrl']) with open(f'image_{i}.jpeg', 'wb') as f: f.write(img_response.content) return job if job['status'] == 'failed': raise Exception(f"Job failed: {job.get('error')}") time.sleep(interval_sec) job = wait_for_images(job_id) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-scheduler === Document URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-scheduler --- layout: default title: GET scheduler description: "List all currently in-progress Dreamina video and image generation jobs via GET scheduler in the useapi.net Dreamina API v1, grouped by account." parent: Dreamina API nav_order: 800 --- ## List Executing Jobs February 23, 2026 (March 2, 2026) --- List all currently executing (in-progress) video and image generation jobs, grouped by account. > **https://api.useapi.net/v1/dreamina/scheduler** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Responses **200** **200 OK** Returns executing jobs grouped by account. ```json { "executing": { "US:user@example.com": [ { "jobid": "j0223140530123456789v-u12345-US:user@example.com-bot:dreamina", "submitId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "model": "seedance-2.0", "elapsedSeconds": 45, "replyUrl": "https://your-domain.com/webhook" } ] }, "total": 1 } ``` When no jobs are executing: ```json { "executing": {}, "total": 0 } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` ### Model ```typescript { executing: { [account: string]: Array<{ jobid: string // Job identifier submitId: string // Upstream submission ID model: string // Model used elapsedSeconds: number // Seconds since job was submitted replyUrl?: string // Webhook URL if configured }> } total: number // Total number of executing jobs } ``` ### Examples **Curl** ``` bash curl -H "Authorization: Bearer YOUR_API_TOKEN" \ "https://api.useapi.net/v1/dreamina/scheduler" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const response = await fetch('https://api.useapi.net/v1/dreamina/scheduler', { headers: { 'Authorization': `Bearer ${token}` } }); const scheduler = await response.json(); console.log('Executing jobs:', scheduler.total); for (const [account, jobs] of Object.entries(scheduler.executing)) { console.log(` ${account}: ${jobs.length} jobs`); } ``` **Python** ``` python import requests token = 'YOUR_API_TOKEN' headers = {'Authorization': f'Bearer {token}'} response = requests.get('https://api.useapi.net/v1/dreamina/scheduler', headers=headers) scheduler = response.json() print(f"Executing jobs: {scheduler['total']}") for account, jobs in scheduler['executing'].items(): print(f" {account}: {len(jobs)} jobs") ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-videos-jobid === Document URL: https://useapi.net/docs/api-dreamina-v1/get-dreamina-videos-jobid --- layout: default title: GET videos/`jobid` description: "Poll a Dreamina video generation, upscale, or interpolation job for status and results by job ID via GET videos/jobid in the useapi.net Dreamina API v1." parent: Dreamina API nav_order: 700 --- ## Retrieve Job Status March 2, 2026 (October 23, 2026) --- Retrieve the status and result of a video generation, upscale, or interpolation job by its job ID. Use this endpoint to poll for completion after submitting a video via [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos), [POST /videos/upscale](/docs/api-dreamina-v1/post-dreamina-videos-upscale), or [POST /videos/interpolate](/docs/api-dreamina-v1/post-dreamina-videos-interpolate). Jobs are retained for 30 days. > **https://api.useapi.net/v1/dreamina/videos/`jobid`** ### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Path Parameters - `jobid` is **required**, the unique job identifier returned from [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos), [POST /videos/upscale](/docs/api-dreamina-v1/post-dreamina-videos-upscale), or [POST /videos/interpolate](/docs/api-dreamina-v1/post-dreamina-videos-interpolate). ### Responses **200** **200 OK** Returns the job record with current status and details. **Processing (status: created):** ```json { "jobid": "j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina", "type": "video", "status": "created", "model": "seedance-2.0", "created": "2026-02-23T14:05:30.123Z", "request": { "prompt": "A serene mountain landscape at sunset", "model": "seedance-2.0", "ratio": "16:9", "duration": 5, "inputMode": "prompt" }, "response": { "forecastCost": 125 }, "code": 200 } ``` **Completed:** ```json { "jobid": "j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina", "type": "video", "status": "completed", "model": "seedance-2.0", "created": "2026-02-23T14:05:30.123Z", "updated": "2026-02-23T14:07:15.456Z", "request": { "prompt": "A serene mountain landscape at sunset", "model": "seedance-2.0", "ratio": "16:9", "duration": 5, "inputMode": "prompt" }, "response": { "assetId": "CA:user@example.com-306191137798:7341234567890123456", "videoUrl": "https://v16m-default.tiktokcdn.com/...", "videoUrlBackup": "https://v16m.byteicdn.com/...", "videoUrlWatermarked": "https://v16-cc.capcut.com/...", "watermarked": false, "videoId": "7341234567890123456", "coverUrl": "https://p9-sign.douyinpic.com/...", "width": 1280, "height": 720, "durationMs": 5042, "hasAudio": false, "forecastCost": 125, "finishTime": 1708700835 }, "code": 200 } ``` **Failed:** ```json { "jobid": "j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina", "type": "video", "status": "failed", "model": "seedance-2.0", "created": "2026-02-23T14:05:30.123Z", "updated": "2026-02-23T14:07:15.456Z", "request": { "prompt": "A test prompt", "model": "seedance-2.0", "ratio": "16:9", "duration": 5, "inputMode": "prompt" }, "error": "fail_code: 2043", "errorDetails": "OutputVideoRisk", "code": 2043 } ``` **Note:** Jobs older than 1 hour that are still `created` are auto-marked as failed with `"Generation timed out"` (code `408`). Common `fail_code` values, all raised during generation rather than at submission — a job that fails this way is not charged: | Code | Meaning | |---|---| | `2043` | `OutputVideoRisk` — the generated video failed content moderation | | `2045` | `OutputAudioRisk` — the generated audio failed content moderation | | `2048` | `InputImageCopyright` — a supplied reference image was rejected | | `2053` | The video may contain third-party content. Seen on `seedance-2.5`. Judged against the finished video, so a prompt naming no person or property can still trigger it by describing something recognisable — a costumed character, a trademarked location, or a figure written as an unmistakable celebrity. Real human faces and stylised violence do **not** trigger it | **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Job not found, belongs to a different user, or has expired (>30 days). ```json { "error": "Job not found" } ``` ### Model **Completed** Video generation completed. Includes video URL and metadata. ```typescript { jobid: string // Unique job identifier type: 'video' | 'video-upscale' | 'video-interpolate' // Job type status: 'completed' model: string // Model used created: string // ISO 8601 timestamp updated: string // ISO 8601 timestamp request: { prompt?: string model: string ratio?: string duration?: number inputMode: string // "prompt" | "first_frame" | "end_frame" | "multi_frame" | "unified_edit" | "long_video" | "edit" resolution?: string // "720p" or "1080p" firstFrameRef?: string endFrameRef?: string editVideoRef?: string frame_1_imageRef?: string // Keyframe refs (multi_frame mode) frame_1_prompt?: string frame_1_duration?: number frame_2_imageRef?: string frame_2_prompt?: string frame_2_duration?: number replyUrl?: string replyRef?: string } response: { assetId: string // For DELETE /assets/ videoUrl: string // Direct MP4 URL — clean (non-watermarked) master when available; falls back to the watermarked variant for models that don't expose a master videoUrlBackup?: string // Alternate CDN host for the same master (use if primary fails) videoUrlBackups?: string[] // Full list of alternate master URLs when more than one is provided videoUrlWatermarked?: string // Watermarked variant, preserved as a fallback and for compliance/traceability of AI-generated content watermarked?: boolean // true when the returned videoUrl carries Dreamina's AIGC transparency badge videoId: string // Dreamina video ID coverUrl: string // Video cover/thumbnail URL width: number // Video width in pixels height: number // Video height in pixels durationMs: number // Video duration in milliseconds hasAudio: boolean // Whether video has audio forecastCost: number // Estimated generation time in seconds, NOT a price finishTime: number // Unix timestamp of completion upscaleJobid?: string // Set after POST /videos/upscale } code: number // 200 } ``` #### Watermark handling Dreamina's backend renders every generated video twice: - A **clean master** served from `v16m-default.tiktokcdn.com` / `v16m.byteicdn.com`. - A **watermarked transcode** served from `v16-cc.capcut.com` with a baked-in top-left "AI" transparency badge and (on non-premium accounts) a bottom-right Dreamina brand mark. `GET /videos/` returns the clean master as `videoUrl` whenever the upstream response exposes one, and keeps the watermarked URL in `videoUrlWatermarked` as a fallback. The `watermarked` flag reflects which variant `videoUrl` is currently pointing at. For models that don't expose a master, `videoUrl` falls back to the watermarked variant and `watermarked` becomes `true`. The watermark is baked into the MP4 at render time — there is no URL parameter that strips it from the watermarked variant, and attempting to edit the URL invalidates its signature. All video URLs are signed and expire ~7 days after generation. Download promptly. **Failed** Video generation failed. Includes error details. ```typescript { jobid: string // Unique job identifier type: 'video' | 'video-upscale' | 'video-interpolate' status: 'failed' model: string created: string // ISO 8601 timestamp updated: string // ISO 8601 timestamp request: { prompt?: string model: string ratio?: string duration?: number inputMode: string firstFrameRef?: string endFrameRef?: string editVideoRef?: string replyUrl?: string replyRef?: string } error: string // Error summary (e.g., "fail_code: 2043") errorDetails?: string // Additional details (e.g., "OutputVideoRisk") code: number // Error code (e.g., 2043, 408, 596) } ``` **Common error codes:** | Code | Meaning | |------|---------| | 408 | Generation timed out (>1 hour) | | 596 | Account session expired | | 2038 | Content filtered | | 2043 | Output video moderation risk | ### Examples **Curl** ```bash # Get job status curl "https://api.useapi.net/v1/dreamina/videos/j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina" \ -H "Authorization: Bearer YOUR_API_TOKEN" # Poll for completion (check every 10 seconds) while true; do RESULT=$(curl -s "https://api.useapi.net/v1/dreamina/videos/$JOBID" \ -H "Authorization: Bearer YOUR_API_TOKEN") STATUS=$(echo "$RESULT" | jq -r '.status') echo "Status: $STATUS" if [[ "$STATUS" == "completed" ]]; then echo "$RESULT" | jq -r '.response.videoUrl' break fi if [[ "$STATUS" == "failed" ]]; then echo "$RESULT" | jq -r '.error' break fi sleep 10 done ``` **JavaScript** ```javascript const apiToken = 'YOUR_API_TOKEN' const jobId = 'j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina' async function getJobStatus(jobId) { const response = await fetch(`https://api.useapi.net/v1/dreamina/videos/${jobId}`, { headers: { 'Authorization': `Bearer ${apiToken}` } }) return await response.json() } // Poll until completion async function waitForCompletion(jobId, intervalMs = 10000) { while (true) { const job = await getJobStatus(jobId) console.log(`Status: ${job.status}`) if (job.status === 'completed') { console.log('Video URL:', job.response.videoUrl) console.log('Dimensions:', `${job.response.width}x${job.response.height}`) console.log('Duration:', `${job.response.durationMs}ms`) return job } if (job.status === 'failed') { console.error('Job failed:', job.error) throw new Error(job.error) } await new Promise(resolve => setTimeout(resolve, intervalMs)) } } const job = await waitForCompletion(jobId) ``` **Python** ```python import requests import time api_token = 'YOUR_API_TOKEN' job_id = 'j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina' def get_job_status(job_id: str) -> dict: response = requests.get( f'https://api.useapi.net/v1/dreamina/videos/{job_id}', headers={'Authorization': f'Bearer {api_token}'} ) response.raise_for_status() return response.json() def wait_for_completion(job_id: str, interval_sec: int = 10) -> dict: while True: job = get_job_status(job_id) print(f"Status: {job['status']}") if job['status'] == 'completed': print(f"Video URL: {job['response']['videoUrl']}") print(f"Dimensions: {job['response']['width']}x{job['response']['height']}") # Download video video_response = requests.get(job['response']['videoUrl']) with open('output.mp4', 'wb') as f: f.write(video_response.content) print('Video saved to output.mp4') return job if job['status'] == 'failed': raise Exception(f"Job failed: {job.get('error')}") time.sleep(interval_sec) job = wait_for_completion(job_id) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1 === Document URL: https://useapi.net/docs/api-dreamina-v1 --- layout: default title: Dreamina API nav_logo: /assets/images/dreamina-logo.png nav_title: Dreamina API seo_title: "Dreamina API: Seedance 2.5 and 2.0 Video, Seedream, GPT Image" description: "Dreamina has no developer API: the third-party useapi.net Dreamina API runs Seedance 2.5 and 2.0 video, Seedream and GPT Image on your own Dreamina plan, no BytePlus account needed." nav_order: 2100 has_children: true permalink: /docs/api-dreamina-v1 repo: https://github.com/useapi/dreamina-api --- # Dreamina API February 23, 2026 (October 23, 2026) This is a [third-party](/docs/legal#affiliation--third-party-services) API for [Dreamina](https://dreamina.capcut.com/) by [ByteDance](https://www.bytedance.com/). It uses your [Dreamina subscription](https://dreamina.capcut.com/pricing/dreamina-price): Free, Basic $15, Standard $36, Advanced $79 to $320 or Ultra $520 a month in the US (as of October 2026). It makes video with ByteDance's [Seed](https://seed.bytedance.com/) models Seedance 2.5, 2.0, 2.0 Fast and 2.0 Mini, with HappyHorse 1.1 and Wan 3.0 on Canada accounts, and images with Seedream, GPT Image 2.5 and Nano Banana Pro, through a REST API. Seedance 2.5 here accepts real faces and makes videos up to 3 minutes long. On Standard, a 5-second 720p Seedance 2.0 Fast video uses $0.37 of the plan's monthly credits, against $0.60 a video on ByteDance's own API. ## Models | Model | What it makes | Notes | |---|---|---| | Seedance 2.5
`seedance-2.5` | [Video](/docs/api-dreamina-v1/post-dreamina-videos) from text, a start and an end frame, or up to 50 references (30 images, 10 videos, 10 audio clips), plus [long videos and edits](/docs/api-dreamina-v1/post-dreamina-videos#what-is-new-in-seedance-25) | 4 to 30 seconds, or 31 to 180 in long video mode, 480p, 720p or 1080p, accepts real faces | | Seedance 2.0
`seedance-2.0` | Video from text, a start and an end frame, or up to 12 references (9 images, 3 videos, 3 audio clips) | 4 to 15 seconds, 720p, 1080p or 4K | | Seedance 2.0 Fast
`seedance-2.0-fast` | Video from text, a start and an end frame, or up to 12 references | 4 to 15 seconds, 720p, or 1080p, 2K and 4K upscaled from 720p | | Seedance 2.0 Mini
`seedance-2.0-mini` | Video from text, a start and an end frame, or up to 12 references | 4 to 15 seconds, 720p, or 1080p, 2K and 4K upscaled from 720p, the cheapest Seedance 2.0 | | Seedance 1.5 Pro
`seedance-1.5-pro` | Video from text, or a start and an end frame | 5, 10 or 12 seconds, 720p, 1080p on CA | | Seedance 1.0 Pro
`seedance-1.0-pro` | Video from text or a start frame | 5 or 10 seconds, 1080p, CA only | | Seedance 1.0 Mini
`seedance-1.0-mini` | Video from text, a start frame, or 2 to 10 keyframes with a prompt each | 5 or 10 seconds, 720p, US only | | Seedance 1.0 Fast
`seedance-1.0-fast` | Video from text, a start frame, or 2 to 10 keyframes | 5 or 10 seconds, 720p or 1080p, CA only | | HappyHorse 1.1
`happyhorse-1.1` | Video with sound from text, a start frame, or up to 9 reference images, by [Alibaba](https://www.alibabagroup.com/) | 4 to 15 seconds, 720p or 1080p, CA only | | Wan 3.0
`wan-3.0` | Video with sound from text, a start and an end frame, or up to 20 references (10 images, 5 videos, 5 audio clips), by Tongyi Lab | 4 to 15 seconds, 720p or 1080p, CA only | | GPT Image 2.5 Flare
`gpt-image-2.5-flare` | [Images](/docs/api-dreamina-v1/post-dreamina-images) from text and up to 6 reference images | 1K, 2K or 4K, [OpenAI](https://openai.com/)'s faster model for everyday images and edits | | GPT Image 2.5 Sunburst
`gpt-image-2.5-sunburst` | Images from text and up to 6 reference images | 1K, 2K or 4K, sharper details and more precise edits | | Nano Banana Pro
`nano-banana-pro` | Images from text and up to 6 reference images | 1K, 2K or 4K, Gemini 3 Pro Image | | GPT Image 2
`gpt-image-2` | Images from text and up to 6 reference images | 1K, 2K or 4K, square, 2:3 or 3:2 | | Seedream 5.0 Pro
`seedream-5.0-pro` | Up to 4 images from text and up to 6 reference images | 1.5K, 2K or 4K, cinematic and text-rich images, CA only | | Seedream 5.0 Lite
`seedream-5.0-lite` | Up to 4 images from text and up to 6 reference images | 2K or 4K, the newest Seedream on both regions | | Seedream 4.7
`seedream-4.7` | Up to 4 images from text and up to 6 reference images | 2K or 4K, CA only | | Seedream 4.6
`seedream-4.6` | Up to 4 images from text and up to 6 reference images | 2K or 4K, the default image model | | Seedream 4.5
`seedream-4.5` | Up to 4 images from text and up to 6 reference images | 2K or 4K, high quality | | Seedream 4.1
`seedream-4.1` | Up to 4 images from text and up to 6 reference images | 2K or 4K | | Seedream 4.0
`seedream-4.0` | Up to 4 images from text and up to 6 reference images | 2K or 4K, balances quality and speed | | Nano Banana
`nano-banana` | Images from text and up to 3 reference images | 1K, fast, CA only | | Seedream 3.0
`seedream-3.0` | Up to 4 images from text and 1 reference image | 1K or 2K | | More | [Video upscale](/docs/api-dreamina-v1/post-dreamina-videos-upscale), [smoother video](/docs/api-dreamina-v1/post-dreamina-videos-interpolate) and [image upscale](/docs/api-dreamina-v1/post-dreamina-images-upscale) | Video 2x (720p to 1440p, 1080p to 4K), 30 or 60 FPS on original or upscaled videos, images to 2K, 4K or 8K | US and Canada (CA) accounts run the same resolutions on Seedance 2.5, up to 1080p, and on the Seedance 2.0 models, up to 4K. The models marked CA only and 1080p on the older Seedance models need a Canada-region account, and Seedream picks the aspect ratio for you when you don't set one. References are images, videos and audio you [upload](/docs/api-dreamina-v1/post-dreamina-assets-account) to the account. ## Pricing What one 5-second video costs on ByteDance's [BytePlus ModelArk](https://docs.byteplus.com/en/docs/ModelArk/1544106) API and on each US Dreamina subscription billed monthly (as of October 2026). Each subscription comes with a monthly number of credits, and each video uses a set number of them, so a video costs its share of the subscription. | Model | [Official API](https://docs.byteplus.com/en/docs/ModelArk/1544106) | Ultra $520/m (59,000 cr/mo) | Advanced $79/m (8,645 cr/mo) | Standard $36/m (3,885 cr/mo) | Basic $15/m (1,575 cr/mo) | |---|---|---|---|---|---| | Seedance 2.0 Mini (720p, 5 s) | $0.38 ($0.076 a second) | $0.22 / 25 cr (2,360 videos/mo) | $0.23 / 25 cr (345 videos/mo) | $0.23 / 25 cr (155 videos/mo) | $0.24 / 25 cr (63 videos/mo) | | Seedance 2.0 Fast (720p, 5 s) | $0.60 ($0.12 a second) | $0.35 / 40 cr (1,475 videos/mo) | $0.37 / 40 cr (216 videos/mo) | $0.37 / 40 cr (97 videos/mo) | $0.38 / 40 cr (39 videos/mo) | | Seedance 2.0 Mini (1080p upscaled from 720p, 5 s) | not sold (Seedance 2.0 at 1080p: $1.87) | $0.48 / 55 cr (1,072 videos/mo) | $0.50 / 55 cr (157 videos/mo) | $0.51 / 55 cr (70 videos/mo) | $0.52 / 55 cr (28 videos/mo) | | Seedance 2.0 Fast (1080p upscaled from 720p, 5 s) | not sold (Seedance 2.0 at 1080p: $1.87) | $0.62 / 70 cr (842 videos/mo) | $0.64 / 70 cr (123 videos/mo) | $0.65 / 70 cr (55 videos/mo) | $0.67 / 70 cr (22 videos/mo) | | Seedance 2.5 long video (480p, 60 s) | not sold (stops at 30 s) | $12.16 / 1,380 cr (42 videos/mo) | $12.61 / 1,380 cr (6 videos/mo) | $12.79 / 1,380 cr (2 videos/mo) | $13.14 / 1,380 cr (1 video/mo) | - A free Dreamina account works too: it makes Seedream 4.6 images on Dreamina's free daily credits, which [GET accounts/`account`](/docs/api-dreamina-v1/get-dreamina-accounts-account) collects once a day. Seedance video needs a paid subscription, and only paid subscriptions remove Dreamina's AI badge from images. - Dreamina's paid subscriptions also include video upscaling and 60 FPS. - BytePlus runs Seedance only after you buy a prepaid [resource pack](https://docs.byteplus.com/en/docs/ModelArk/2191775), from about $30, which expires after 90 days. - Canada-region subscriptions cost Basic C$20.49, Standard C$50, Advanced from C$109.99 or Ultra C$725 a month. A 5-second Seedance 2.0 video at 1080p costs about $1.86 on Canada's Advanced and $1.87 on the US Advanced, against $1.87 on BytePlus. - Larger Advanced subscriptions give 17,600 to 35,500 credits a month for $159 to $320. Yearly billing and the price per second of every model are in the cost calculator below.
Cost calculator for every model, US and Canada Dollars per second on the Advanced subscription billed monthly: US $79 for 8,645 credits, Canada C$109.99 for 11,997 credits, converted at CAD/USD 0.7112 (as of October 21, 2026). | Model | US $/sec | CA $/sec | |-------|---------:|---------:| | Seedance 2.5 @480p, with a video reference | $0.128 | $0.117 | | Seedance 2.5 @480p | $0.155 | $0.143 | | Seedance 2.5 @720p | $0.338 | $0.313 | | Seedance 2.5 @1080p | $0.832 | $0.763 | | Seedance 2.5 long video @480p | $0.210 | $0.196 | | Seedance 2.5 long video @720p | $0.411 | $0.378 | | Seedance 2.5 long video @1080p | $0.923 | $0.848 | | Seedance 2.0 @720p | $0.155 | $0.150 | | Seedance 2.0 @1080p | $0.375 | $0.372 | | Seedance 2.0 @4K | $0.896 | $0.822 | | Seedance 2.0 Fast @720p | $0.073 | $0.065 | | Seedance 2.0 Fast @1080p | $0.128 | $0.098 | | Seedance 2.0 Fast @2K | $0.155 | $0.117 | | Seedance 2.0 Fast @4K | $0.201 | $0.150 | | Seedance 2.0 Mini @720p | $0.046 | $0.046 | | Seedance 2.0 Mini @1080p | $0.101 | $0.085 | | Seedance 2.0 Mini @2K | $0.128 | $0.098 | | Seedance 2.0 Mini @4K | $0.174 | $0.130 | | Seedance 1.5 Pro @720p | $0.146 | $0.143 | | HappyHorse 1.1 @720p | — | $0.111 | | HappyHorse 1.1 @1080p | — | $0.150 | | Wan 3.0 @720p | — | $0.111 | | Wan 3.0 @1080p | — | $0.274 | Seedance 2.5 bills a reference video's duration on top of the output, so a 4-second video from a 5-second reference bills 9 seconds, at the lower with-reference rate, which now applies at 480p only. Canada costs up to 25% less per second (on Seedance 2.0 Fast and Mini above 720p, and the same on Mini at 720p), because its subscription buys 153 credits per US dollar against 109 in the US, even though each video uses more credits. Canada also has HappyHorse 1.1, Wan 3.0, Seedance 1.0 Pro and Fast, and 1080p on Seedance 1.5 Pro. Credits per image at 1K / 2K / 4K: | Model | US | CA | |-------|----|----| | GPT Image 2.5 Flare and Sunburst | 8 / 11 / 13 (launch price, normally 10 / 14 / 17) | 9 / 13 / 16 (launch price, normally 13 / 18 / 22) | | Nano Banana Pro | 42 / 42 / 75 | 53 / 53 / 95 | | GPT Image 2 | 21 / 38 / 48 | 27 / 48 / 61 | Yearly billing lowers the US Advanced subscription to $900 a year ($75 a month), and Canada's to C$1,299.99 a year. [Setup Dreamina](/docs/start-here/setup-dreamina#cost-calculator) has the credits behind each rate.
### 开始使用 每月 15 美元的订阅即可使用 useapi.net 上的所有 API:一个 Token,所有服务。每个服务最多绑定 3 个你自己的账号,useapi.net 负责 REST 接口、负载均衡和轮询。需要更多账号?每增加一个订阅每月 10 美元,每个服务再多 3 个账号。 [订阅 — 每月 15 美元](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [用加密货币支付](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) 没有国际信用卡?可以[用加密货币订阅](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK)(加密货币付款不退款)。价格与批量方案见[订阅页面](/docs/subscription)。用 Stripe 付款,首次购买 14 天内、且成功生成少于 50 次可全额退款。已经订阅?请在 [Stripe 客户门户](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) 修改数量,无需重新购买。 ### API を使い始める 月額15ドルのサブスクリプション1つで、useapi.net のすべての API を使えます。トークン1つで、すべてのサービスに対応します。各サービスにご自身のアカウントを最大3つまで接続でき、REST API、負荷分散、ポーリングは useapi.net が担当します。アカウントを増やしたい場合は、サブスクリプションを1つ追加するごとに月額10ドルで、各サービスのアカウントが3つずつ増えます。 [登録する — 月額15ドル](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [暗号資産で支払う](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) 海外で使えるクレジットカードがない場合は、[暗号資産で登録](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK)することもできます(暗号資産での支払いは返金できません)。料金とボリュームプランは[サブスクリプションのページ](/docs/subscription)をご覧ください。Stripe でお支払いの場合、初回購入から14日以内で、成功した生成が50回未満であれば全額返金されます。すでに登録済みの場合は、新たに購入せず [Stripe カスタマーポータル](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo)で数量を変更してください。 ### Comece a usar a API Uma assinatura de US$ 15 por mês dá acesso a todas as APIs da useapi.net: um token, todos os serviços. Você conecta até 3 contas suas por serviço, e a useapi.net cuida da API REST, do balanceamento de carga e do polling. Precisa de mais contas? Cada assinatura extra custa US$ 10 por mês e acrescenta mais 3 contas por serviço. [Assinar — US$ 15/mês](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Pagar com cripto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) Não tem cartão de crédito internacional? Você também pode [assinar com criptomoedas](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) (pagamentos em cripto não são reembolsáveis). Preços e planos de volume estão na [página de assinatura](/docs/subscription). Pagando pelo Stripe, você recebe reembolso integral em até 14 dias após a primeira compra, se tiver menos de 50 gerações bem-sucedidas. Já é assinante? Altere a quantidade no [portal do cliente Stripe](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) em vez de comprar de novo. ### Bắt đầu dùng API Một gói đăng ký $15/tháng dùng được mọi API trên useapi.net: một token cho tất cả dịch vụ. Mỗi dịch vụ bạn kết nối tối đa 3 tài khoản của riêng mình, còn useapi.net lo REST API, cân bằng tải và polling. Cần thêm tài khoản? Mỗi gói đăng ký thêm giá $10/tháng và cho thêm 3 tài khoản ở mỗi dịch vụ. [Đăng ký — $15/tháng](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Thanh toán bằng tiền mã hóa](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) Không có thẻ thanh toán quốc tế? Bạn có thể [đăng ký bằng tiền mã hóa](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) (thanh toán bằng tiền mã hóa không được hoàn tiền). Giá và các gói số lượng lớn có trên [trang đăng ký](/docs/subscription). Nếu thanh toán qua Stripe, bạn được hoàn tiền toàn bộ trong 14 ngày kể từ lần mua đầu tiên khi có dưới 50 lượt tạo thành công. Đã đăng ký rồi? Hãy đổi số lượng trong [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) thay vì mua lại. ### Mulai memakai API Satu langganan US$15/bulan mencakup semua API di useapi.net: satu token untuk semua layanan. Di setiap layanan Anda bisa menghubungkan hingga 3 akun milik Anda sendiri, dan useapi.net menangani REST API, load balancing, dan polling. Butuh lebih banyak akun? Setiap langganan tambahan US$10/bulan dan menambah 3 akun lagi per layanan. [Berlangganan — US$15/bulan](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Bayar dengan kripto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) Tidak punya kartu kredit internasional? Anda bisa [berlangganan dengan kripto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) (pembayaran kripto tidak bisa di-refund). Harga dan paket volume ada di [halaman langganan](/docs/subscription). Jika membayar lewat Stripe, Anda mendapat refund penuh dalam 14 hari sejak pembelian pertama, selama jumlah generasi yang berhasil kurang dari 50. Sudah berlangganan? Ubah jumlahnya di [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo), tidak perlu membeli lagi. ### เริ่มใช้งาน API การสมัครสมาชิกเดือนละ $15 ใช้ได้กับทุก API บน useapi.net ใช้ Token เดียวกับทุกบริการ เชื่อมบัญชีของคุณเองได้สูงสุด 3 บัญชีต่อบริการ แต่ละบัญชีใช้แพ็กเกจของเว็บไซต์นั้นเอง ส่วน useapi.net ดูแล REST API การกระจายโหลด และการ polling ให้ ต้องการบัญชีมากกว่านี้? สมัครเพิ่มแต่ละครั้งเดือนละ $10 และได้เพิ่มอีก 3 บัญชีต่อบริการ [สมัครสมาชิก — $15/เดือน](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [ชำระด้วยคริปโต](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) ไม่มีบัตรเครดิตที่ใช้จ่ายต่างประเทศได้? [สมัครด้วยคริปโต](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK)ก็ได้ (การชำระด้วยคริปโตขอคืนเงินไม่ได้) ดูราคาและแพ็กเกจสำหรับปริมาณมากได้ที่[หน้าการสมัครสมาชิก](/docs/subscription) ถ้าชำระผ่าน Stripe ขอคืนเงินเต็มจำนวนได้ภายใน 14 วันหลังซื้อครั้งแรก หากสร้างงานสำเร็จไม่ถึง 50 ครั้ง สมัครไว้แล้ว? เปลี่ยนจำนวนได้ที่ [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) โดยไม่ต้องซื้อใหม่ ### Start using the API A single $15/month subscription covers every API on useapi.net — one token, all services. You connect up to 3 accounts per service, each with its own website subscription, and useapi.net handles the REST API, load balancing, and polling. Need more accounts? Each extra subscription is $10/month and adds 3 more accounts per service. [Subscribe — $15/month](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Pay with crypto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) [Pricing and volume options](/docs/subscription) — full refund within the first 14 days if you have fewer than 50 successful generations. Already subscribed? Change the quantity in the [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) instead of buying again. ## Run several Dreamina accounts Video and image requests don't need `account`: each job goes to one of your Dreamina accounts that has a free job slot, within the `maxJobs` limit (1 to 50, 10 by default) you set for each account with [POST accounts](/docs/api-dreamina-v1/post-dreamina-accounts). When every account is busy you get `429`, so wait and send it again. Pass `account`, such as `CA:user@example.com`, to run a job on a specific account. A job that uses an uploaded image, video or audio runs on the account that holds it, and [GET scheduler](/docs/api-dreamina-v1/get-dreamina-scheduler) lists the jobs running on each account. Every generation request can also send its result to your webhook with `replyUrl`, so you don't have to poll. Most videos take 60 to 180 seconds, while Seedance 2.5 long videos and edits took 13 to 17 minutes in our tests. [How useapi.net works](/docs/how-it-works) has tips for keeping your accounts healthy. ## Questions ### Does Dreamina have an API? Through useapi.net, yes. The useapi.net Dreamina API runs Seedance 2.5, 2.0, 2.0 Fast and 2.0 Mini, and Seedream, GPT Image 2.5 and Nano Banana Pro images over REST on your Dreamina subscription. Dreamina itself is a website with no developer API (as of October 2026). A runnable Node.js example is on GitHub at [useapi/dreamina-api](https://github.com/useapi/dreamina-api), and the [Dreamina tutorial](/docs/articles/dreamina-bash) walks through it. ### How much does the Dreamina API cost? Through useapi.net, a 5-second Seedance 2.0 Fast video at 720p costs $0.37 on Dreamina Advanced, against $0.60 on ByteDance's [BytePlus ModelArk](https://docs.byteplus.com/en/docs/ModelArk/1544106), and Seedance 2.0 Mini costs $0.23 against $0.38 (as of October 2026). BytePlus also needs a prepaid resource pack before Seedance runs. The [price table](#pricing) shows each model on each subscription, and the [Seedance pricing comparison](/docs/articles/seedance-2-api-pricing) prices every route. ### Is there a Dreamina API key? Through useapi.net, you use our [API token](/docs/start-here/setup-useapi), since Dreamina issues no API key, and connect your Dreamina account once with its email and password through [Setup Dreamina](/docs/start-here/setup-dreamina), with no BytePlus account and no prepaid pack. Both regions run Seedance 2.5 and the Seedance 2.0 models at the same resolutions, up to 4K. Pick a Canada-region account for Seedance 1.0 Pro and 1.0 Fast and 1080p on Seedance 1.5 Pro. ### Is there a Seedance 2.5 API that accepts real faces? Through useapi.net, yes: the Dreamina route accepts photographic portraits on Seedance 2.5 and makes long videos of 31 to 180 seconds in one job. ByteDance's own [Seedance 2.5 guide](https://docs.byteplus.com/en/docs/modelark/seedance-2-5) says it "does not support directly uploading reference images or videos containing real human faces" and makes up to 30 seconds per request (as of October 2026). Send `seedance-2.5` to [POST videos](/docs/api-dreamina-v1/post-dreamina-videos). [Setup Dreamina](/docs/start-here/setup-dreamina) [LLM-friendly API spec](https://useapi.net/assets/aibot/api-dreamina-v1.txt) Feed this to your LLM to build integrations [Claude Code skill](/llm-tools) A drop-in useapi.net skill for Claude Code, and a rule for Cursor [Postman collection](https://www.postman.com/useapinet/useapi-net/collection/29112081-347618e4-ef47-4ca4-bdee-72d321dcb4f2) (October 19, 2026) [GitHub examples](https://github.com/useapi/dreamina-api) Node.js and Python: Seedance video and Dreamina image generation [Seedance 2.0 four ways](https://github.com/useapi/seedance-2-api) The same Seedance 2.0 job through Dreamina, PixVerse, Runway and MiniMax, plus a cross-vendor price dataset Articles: * [How to Generate AI Video with Seedance 2.5 and 2.0 via the Dreamina API](/docs/articles/dreamina-bash) * [Seedance 2.0 and 2.5 API Pricing: Every Route, Compared](/docs/articles/seedance-2-api-pricing) Examples: * [Seedance 2.5 — long video and video edit](/blog/260907) * [Seedance 2.5](/blog/260807) * [Seedance 2.0 Mini — omni video from three image references](/blog/260626) * [Seedance 2.0 — real-face tutorial (Runway & Dreamina)](/blog/260415) * [Seedance 2.0, Video Upscale](/blog/260402) * [17 AI Image Models: The Showdown](/blog/260309i) * [Seedream 4.5 and Seedance 2.0](/blog/260302) * [Seedance 2.0](/blog/260223) Videos on YouTube: * [Selfie Situation, Seedance 2.0](https://www.youtube.com/shorts/TYlg9cVyNy4) * [Seedance 2.0 Omni: photo, reference video and audio into one clip](https://www.youtube.com/shorts/apUc3lXrY_4) Developer Community: * Discord Server * Telegram Channel === URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-accounts === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-accounts --- layout: default title: POST accounts description: "Configure a Dreamina account for API access via POST accounts in the useapi.net Dreamina API v1 — provide email and password to enable image and video generation." parent: Dreamina API nav_order: 200 --- ## Configure Dreamina Account February 23, 2026 (October 23, 2026) --- Configure your Dreamina account for API access using email and password credentials. See [Setup Dreamina](/docs/start-here/setup-dreamina) for details. When the account is saved, we also switch on its Dreamina "close watermark" setting, so generated images come back without the "AI" badge. Dreamina allows this on paid plans only — on a free account the images keep the badge. We also accept Dreamina's one-time "Before you continue" confirmation, which the web app shows before the first generation with a model that asks for it (currently Seedance 2.x). It is an account setting, so it covers every such model at once: "You confirm you own all necessary rights to uploaded content and will not infringe third-party rights, nor upload sensitive personal data or inappropriate content." Without it, Dreamina refuses those generations. Accounts added earlier get it on their first Seedance 2.x request. > **https://api.useapi.net/v1/dreamina/accounts** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json # Alternatively you can use multipart/form-data # Content-Type: multipart/form-data ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Request Body ```json { "email": "user@example.com", "password": "your-password", "region": "CA", "maxJobs": 10 } ``` - `email` is **required**. Dreamina account email address. - `password` is **required**. Dreamina account password. - `region` is **required**. Region code. Supported values: `US`, `CA`. Both regions support the Seedance 2.0 and 2.5 models at the same resolutions, up to 4K. The available image models also differ by region. See [Setup Dreamina](/docs/start-here/setup-dreamina) for region-specific setup. - `maxJobs` is optional. Maximum concurrent jobs for this account (1-50, default: `10`). ### Responses **200** **200 OK** Account configured successfully. ```json { "account": "CA:user@example.com", "email": "user@example.com", "region": "CA", "maxJobs": 10, "sessionExpires": "2026-04-24T12:00:00.000Z", "session": { "expires": "2026-04-24T12:00:00.000Z", "lastRefreshed": "2026-02-23T12:00:00.000Z", "daysUntilExpiry": 60 }, "models": { "video": ["seedance-2.5", "seedance-2.0-mini", "seedance-2.0-fast", "seedance-2.0", "seedance-1.5-pro", "seedance-1.0-pro", "seedance-1.0-fast"], "image": ["gpt-image-2", "gpt-image-2.5-flare", "gpt-image-2.5-sunburst", "nano-banana-pro", "seedream-5.0-pro", "seedream-5.0-lite", "seedream-4.7", "seedream-4.6", "seedream-4.5", "seedream-4.1", "seedream-4.0", "nano-banana", "seedream-3.0"] }, "credits": { "total": 500, "vip": 200, "gift": 200, "purchase": 100, "dailyClaimed": false } } ``` **400** **400 Bad Request** Validation error (missing/invalid parameters). ```json { "error": "Parameter email is required" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **402** **402 Payment Required** Subscription expired or insufficient credits. ```json { "error": "Account has no subscription or subscription expired" } ``` **500** **500 Internal Server Error** Login failed (bad credentials, upstream error). ```json { "error": "Login failed: invalid credentials" } ``` ### Model - `account` - Account identifier - `email` - Dreamina account email - `region` - Region code - `maxJobs` - Maximum concurrent jobs - `sessionExpires` - ISO 8601 timestamp when session expires - `session` - Session details including refresh timing - `models` - Available video and image generation models - `credits` - Credit balance breakdown ```typescript { // TypeScript, all fields are optional account: string // "CA:user@example.com" email: string region: string // "US" or "CA" maxJobs: number // 1-50 sessionExpires: string // ISO 8601 timestamp session: { expires: string // ISO 8601 timestamp lastRefreshed: string // ISO 8601 timestamp daysUntilExpiry: number } models: { video: string[] // Available video model names image: string[] // Available image model names } credits: { total: number vip: number gift: number purchase: number dailyClaimed: boolean } error?: string // Error message } ``` ### Examples **Curl** ``` bash curl -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -X POST "https://api.useapi.net/v1/dreamina/accounts" \ -d '{ "email": "user@example.com", "password": "your-password", "region": "CA" }' ``` **JavaScript** ``` javascript const apiUrl = 'https://api.useapi.net/v1/dreamina/accounts'; const token = 'YOUR_API_TOKEN'; const response = await fetch(apiUrl, { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ email: 'user@example.com', password: 'your-password', region: 'CA' }) }); const result = await response.json(); console.log('Account configured:', result); ``` **Python** ``` python import requests apiUrl = 'https://api.useapi.net/v1/dreamina/accounts' token = 'YOUR_API_TOKEN' headers = { 'Content-Type': 'application/json', 'Authorization': f'Bearer {token}' } body = { 'email': 'user@example.com', 'password': 'your-password', 'region': 'CA' } response = requests.post(apiUrl, headers=headers, json=body) print(response.status_code, response.json()) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-assets-account === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-assets-account --- layout: default title: POST assets/`account` description: "Upload images, videos, or audio to Dreamina via POST assets/account in the useapi.net Dreamina API v1 for use as reference inputs in video and image generation." parent: Dreamina API nav_order: 500 --- ## Upload Assets February 23, 2026 (November 1, 2026) --- Upload images, videos, and audio files to Dreamina for use in video and image generation. **Images** (max 10 MB): | Content-Type | File Extension | | ------------ | -------------- | | image/jpeg | jpeg, jpg | | image/png | png | | image/webp | webp | **Videos** (max 50 MB, 1.8-30.2 seconds, 300-6000px): | Content-Type | File Extension | | ------------ | -------------- | | video/mp4 | mp4 | | video/quicktime | mov | | video/webm | webm | **Audio** (max 15 MB, 1.8-30.2 seconds): | Content-Type | File Extension | | ------------ | -------------- | | audio/mpeg | mp3 | | audio/mp3 | mp3 | | audio/wav | wav | | audio/mp4 | m4a | | audio/aac | aac | The returned `assetRef` is used as: - **Images:** `firstFrameRef`, `endFrameRef`, `frame_N_imageRef`, or `omni_N_imageRef` in [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos), and `imageRef_N` in [POST /images](/docs/api-dreamina-v1/post-dreamina-images). - **Videos:** `omni_N_videoRef` in [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos) Omni Reference mode, or `editVideoRef` there to re-cut the video in Edit mode. - **Audio:** `omni_N_audioRef` in [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos) Omni Reference mode. The duration and dimension limits above are the loosest any model accepts, so one upload can be reused across models. Each model applies its own tighter caps when you submit the generation — `seedance-2.5` takes 10 videos and 10 audio clips per request, the Seedance 2.0 family takes 3 of each with videos up to 15.4s and audio up to 15s. See the reference-limit table on [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos). > **https://api.useapi.net/v1/dreamina/assets/`account`** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: select from the table above ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. - `Content-Type` is **required**, see table above. ### Path Parameters - `account` is **required**. ### Request Body Binary image content (raw bytes). ### Responses **200** **200 OK** Asset uploaded successfully. Returns the `assetRef` for use in video and image generation. **Image response:** ```json { "assetRef": "CA:user@example.com-image:w2560:h1440:s580914-uri:tos-alisg-i-wopfjsm1ax-sg/abc123", "account": "CA:user@example.com", "width": 2560, "height": 1440, "size": 580914 } ``` **Video response:** ```json { "assetRef": "CA:user@example.com-video:w1070:h1904:s1656759:d5880-vid:v10762g50003d77lv1nog65ie0vi8oh0", "account": "CA:user@example.com", "type": "video", "width": 1070, "height": 1904, "duration": 5880, "size": 1656759 } ``` **Audio response:** ```json { "assetRef": "CA:user@example.com-audio:w480:h360:s562605:d14040-vid:v10762g50003d77l5uvog65nl4esjs2g", "account": "CA:user@example.com", "type": "audio", "duration": 14040, "size": 562605 } ``` - `assetRef` - Reference ID for use in generation endpoints. - `type` - Asset type: `image`, `video`, or `audio` (omitted for images for backward compatibility). - `width` - Width in pixels (images and videos). - `height` - Height in pixels (images and videos). - `duration` - Duration in milliseconds (videos and audio). - `size` - File size in bytes. - `account` - Account used for the upload. **assetRef formats:** - Image: `-image:w:h:s-uri:` - Video: `-video:w:h:s:d-vid:` - Audio: `-audio:w:h:s:d-vid:` **400** **400 Bad Request** Invalid request (empty content, unsupported content type, file too large, or duration out of range). ```json { "error": "Content-Type (image/bmp) not supported. Valid values: image/jpeg, image/png, image/webp, video/mp4, video/quicktime, video/webm, audio/mpeg, audio/mp3, audio/wav, audio/x-wav, audio/mp4, audio/aac" } ``` ```json { "error": "video exceeds 50MB limit (52.1MB)" } ``` ```json { "error": "Audio duration 31.4s exceeds 30.2s limit" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Account not found or not configured. ```json { "error": "Unable to find configuration for account US:user@example.com" } ``` **596** **596 Session Error** The account's session expired or Dreamina locked it, or the account is in its sign-out pause. Check [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts): an account with `signedOutPauseUntil` comes back by itself after the pause, any other account needs to be re-added using [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts) with correct credentials. ```json { "error": "Dreamina account session expired or locked. Please re-add account via POST /v1/dreamina/accounts", "code": 596 } ``` When Dreamina signs an account out again right after a fresh sign-in, the account is paused for 30 minutes. While the pause runs, [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts) shows `signedOutPauseUntil` (an ISO 8601 time) on that account, requests that name it answer `596`, and automatic account selection uses your other accounts. When every account is paused, requests answer `596`. After the pause the account is used again. If Dreamina signs it out right after a fresh sign-in again, after the pause and within 24 hours, the account is marked with an `error` and answers `596` until you re-add it with [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts). Re-adding an account also ends its pause. A sign-in that fails for a temporary reason, not because Dreamina refused the account, answers `503` with a `Retry-After: 30` header. The account is fine: retry in about 30 seconds. ### Model ```typescript { assetRef: string // Reference ID for POST /videos and POST /images account: string // "CA:user@example.com" type?: string // "image", "video", or "audio" (omitted for images) width?: number // Width in pixels (images and videos) height?: number // Height in pixels (images and videos) duration?: number // Duration in milliseconds (videos and audio) size?: number // File size in bytes imageRef?: string // Legacy alias for assetRef (backward compatibility, images only) error?: string // Error message } ``` ### Examples **Curl** ``` bash curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: image/jpeg" \ --data-binary @/path/to/your/image.jpeg \ "https://api.useapi.net/v1/dreamina/assets/US:user@example.com" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const account = 'US:user@example.com'; const apiUrl = `https://api.useapi.net/v1/dreamina/assets/${encodeURIComponent(account)}`; // Load image - Example 1: From local file (Node.js) const fsp = require('fs').promises; const blob = new Blob([await fsp.readFile('./image.jpeg')]); // Load image - Example 2: From file input element // const imageFile = document.getElementById('image-file'); // const blob = imageFile.files[0]; const response = await fetch(apiUrl, { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': blob.type || 'image/jpeg' }, body: blob }); const result = await response.json(); console.log('Upload result:', result); console.log('assetRef:', result.assetRef); ``` **Python** ``` python import requests from urllib.parse import quote token = 'YOUR_API_TOKEN' account = 'US:user@example.com' api_url = f'https://api.useapi.net/v1/dreamina/assets/{quote(account, safe="")}' with open('./image.jpeg', 'rb') as image_file: file_content = image_file.read() headers = { 'Authorization': f'Bearer {token}', 'Content-Type': 'image/jpeg' } response = requests.post(api_url, headers=headers, data=file_content) result = response.json() print('Upload result:', result) print('assetRef:', result.get('assetRef')) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-images-upscale === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-images-upscale --- layout: default title: POST images/upscale description: "Upscale a Dreamina-generated image to 2K, 4K, or 8K via POST images/upscale in the useapi.net Dreamina API v1 — asynchronous; poll GET images/jobid for the result." parent: Dreamina API nav_order: 730 --- ## Upscale Image March 2, 2026 --- Upscale a generated image to higher resolution (2K, 4K, or 8K). Requires a completed image generation job from [POST /images](/docs/api-dreamina-v1/post-dreamina-images). Upscale is asynchronous — poll [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid) for the result. > **https://api.useapi.net/v1/dreamina/images/upscale** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Request Body ```json { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "imageIndex": 0, "upscaleResolution": "4k" } ``` - `jobid` is **required**. The job ID of a completed image generation job from [POST /images](/docs/api-dreamina-v1/post-dreamina-images). - `imageIndex` is optional. Index of the image to upscale from the source job (0-3, default: `0`). Each generation produces up to 4 images. - `upscaleResolution` is optional. Target resolution (default: `4k`). Supported values: `2k`, `4k`, `8k`. - `originalImageStrength` is optional. How much of the original image to preserve (0-1, default: `0.65`). - `detailStrength` is optional. Detail enhancement level (0-1, default: `0.5`). - `replyUrl` is optional, webhook URL for job status callbacks. Callback body has the same JSON shape as [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid) response. - `replyRef` is optional, custom reference string passed back in webhook callbacks. - `maxJobs` is optional, override max concurrent jobs for this request (1-50). ### Responses **200** **200 OK** Upscale job created. Poll [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid) for the result. ```json { "jobid": "j0302140630123456789I-u12345-US:user@example.com-bot:dreamina", "type": "upscale", "status": "created", "model": "seedream-4.0", "created": "2026-03-02T14:06:30.123Z", "request": { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "imageIndex": 0, "resolution": "4k" }, "response": { "forecastCost": 0 }, "code": 200 } ``` **400** **400 Bad Request** Validation error. ```json { "error": "Parameter jobid is required" } ``` ```json { "error": "Source image job is created, must be completed" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Source image job not found. ```json { "error": "Source image job not found" } ``` ### Examples **Curl** ``` bash curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "imageIndex": 0, "upscaleResolution": "4k" }' \ "https://api.useapi.net/v1/dreamina/images/upscale" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const response = await fetch('https://api.useapi.net/v1/dreamina/images/upscale', { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ jobid: 'j0302140530123456789i-u12345-US:user@example.com-bot:dreamina', imageIndex: 0, upscaleResolution: '4k' }) }); const result = await response.json(); console.log('Upscale job:', result.jobid); // Poll for completion const poll = async (jobid) => { while (true) { const res = await fetch(`https://api.useapi.net/v1/dreamina/images/${jobid}`, { headers: { 'Authorization': `Bearer ${token}` } }); const job = await res.json(); if (job.status === 'completed') { console.log('Upscaled:', job.response.images[0].width, 'x', job.response.images[0].height); return job; } if (job.status === 'failed') throw new Error(job.error); await new Promise(r => setTimeout(r, 10000)); } }; await poll(result.jobid); ``` **Python** ``` python import requests import time token = 'YOUR_API_TOKEN' response = requests.post( 'https://api.useapi.net/v1/dreamina/images/upscale', headers={ 'Authorization': f'Bearer {token}', 'Content-Type': 'application/json' }, json={ 'jobid': 'j0302140530123456789i-u12345-US:user@example.com-bot:dreamina', 'imageIndex': 0, 'upscaleResolution': '4k' } ) result = response.json() print(f"Upscale job: {result['jobid']}") # Poll for completion jobid = result['jobid'] while True: job = requests.get( f'https://api.useapi.net/v1/dreamina/images/{jobid}', headers={'Authorization': f'Bearer {token}'} ).json() if job['status'] == 'completed': img = job['response']['images'][0] print(f"Upscaled: {img['width']}x{img['height']}") break if job['status'] == 'failed': raise Exception(job.get('error')) time.sleep(10) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-images === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-images --- layout: default title: POST images description: "Submit a Dreamina image prompt via POST images in the useapi.net Dreamina API v1 — generates up to 4 images per job; poll GET images/jobid or use a replyUrl webhook." parent: Dreamina API nav_order: 710 --- ## Generate Images March 4, 2026 (October 23, 2026) --- Generate images using Dreamina AI models from text prompts with optional reference images. All image generation is asynchronous — this endpoint returns immediately with a job ID. Poll [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid) for completion, or use `replyUrl` webhook for automatic callbacks. Each Seedream generation produces up to 4 images. `gpt-image-2`, `gpt-image-2.5-flare`, `gpt-image-2.5-sunburst` and `nano-banana-pro` produce 1 image per request. Generation typically completes within 15-120 seconds depending on the model and resolution. ### Models | Model | Region | Resolutions | Max Refs | Prompt Required | Auto Ratio | |-------|--------|-------------|----------|-----------------|------------| | `gpt-image-2.5-flare` | US, CA | 1k (default), 2k, 4k | 6 | No (imageRef_x only) | No | | `gpt-image-2.5-sunburst` | US, CA | 1k (default), 2k, 4k | 6 | No (imageRef_x only) | No | | `nano-banana-pro` | US, CA | 1k (default), 2k, 4k | 6 | No (imageRef_x only) | No | | `gpt-image-2` | US, CA | 1k (default), 2k, 4k | 6 | No (imageRef_x only) | No | | `seedream-5.0-pro` | CA | 1.5k, 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `seedream-5.0-lite` | US, CA | 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `seedream-4.7` | CA | 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `seedream-4.6` (default model, runs on a free account's daily credits) | US, CA | 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `seedream-4.5` | US, CA | 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `seedream-4.1` | US, CA | 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `seedream-4.0` | US, CA | 2k (default), 4k | 6 | No (imageRef_x only) | Yes | | `nano-banana` | CA | 1k | 3 | Yes | Yes | | `seedream-3.0` | US, CA | 1k (default), 2k | 1 | Yes | No | > **https://api.useapi.net/v1/dreamina/images** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json # Alternatively you can use multipart/form-data # Content-Type: multipart/form-data ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Request Body ```json { "prompt": "A stunning aurora borealis over a frozen lake at midnight", "model": "seedream-4.6", "ratio": "16:9", "resolution": "2k" } ``` - `account` is optional. Specific account to use. If omitted, a random account with free capacity is picked among those whose region offers `model`. Not needed when `imageRef_N` provided — account is derived from the reference. - `prompt` is **required**, optional when model supports `imageRef_N`. Maximum 5000 characters. - `model` is optional, see [Models](#models) above. - `ratio` is optional, image aspect ratio (default: `auto` for models that support it, `1:1` otherwise). Supported values: `auto`, `1:1`, `3:4`, `16:9`, `4:3`, `9:16`, `2:3`, `3:2`, `21:9`. Per-model restrictions apply — `gpt-image-2` only accepts `1:1`, `2:3`, `3:2`. - `resolution` is optional, output resolution tier (default depends on model — see Model Capabilities). Supported values: `1k`, `1.5k`, `2k`, `4k`. `1.5k` is offered by `seedream-5.0-pro` only. - `imageRef_1`…`imageRef_6` are optional. Reference images from [POST /assets/`account`](/docs/api-dreamina-v1/post-dreamina-assets-account) or completed image job `assetRef`. Must be contiguous, max per model see [Models](#models). - `imageStrength` is optional, reference image influence strength (0-1, default: `0.5`). - `replyUrl` is optional, webhook URL for job status callbacks. Callback body has the same JSON shape as [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid) response. - `replyRef` is optional, custom reference string passed back in webhook callbacks. - `maxJobs` is optional, override max concurrent jobs for this request (1-50). ### Responses **200** **200 OK** Job created successfully. Images are generating in the background. ```json { "jobid": "j0302140530123456789i-u12345-US:user@example.com-bot:dreamina", "type": "image", "status": "created", "model": "seedream-4.6", "created": "2026-03-02T14:05:30.123Z", "request": { "prompt": "A stunning aurora borealis over a frozen lake at midnight", "model": "seedream-4.6", "ratio": "16:9", "resolution": "2k", "inputMode": "generate", "replyUrl": "https://your-domain.com/webhook", "replyRef": "my-ref-123" }, "response": { "forecastCost": 0 }, "code": 200 } ``` Poll [GET /images/`jobid`](/docs/api-dreamina-v1/get-dreamina-images-jobid) for completion status, or use `replyUrl` for webhook callbacks. **400** **400 Bad Request** Validation error. ```json { "error": "Parameter model (invalid-model) valid values: seedream-5.0-pro, seedream-5.0-lite, seedream-4.7, seedream-4.6, seedream-4.5, seedream-4.1, seedream-4.0, nano-banana, seedream-3.0, gpt-image-2, gpt-image-2.5-flare, gpt-image-2.5-sunburst, nano-banana-pro" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **429** **429 Too Many Requests** All accounts at maximum capacity. ```json { "error": "All accounts at capacity" } ``` ### Model ```typescript { jobid: string // Unique job identifier type: 'image' // Job type status: 'created' // Initial status model: string // Model used created: string // ISO 8601 timestamp request: { prompt?: string model: string ratio?: string resolution?: string inputMode: string // Auto-detected from params imageRef_1?: string // Reference image assetRef (when provided) imageRef_2?: string imageRef_3?: string replyUrl?: string replyRef?: string } response: { forecastCost: number // Estimated generation time in seconds, NOT a price } code: number // HTTP status code error?: string } ``` ### Examples **Curl** ``` bash # Text-to-image curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "prompt": "A stunning aurora borealis over a frozen lake", "model": "seedream-4.6", "ratio": "16:9", "resolution": "2k" }' \ "https://api.useapi.net/v1/dreamina/images" # With reference image curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "prompt": "A dreamy reinterpretation with soft pastel colors", "model": "seedream-4.1", "imageRef_1": "US:user@example.com-image:w685:h900:s86866-uri:tos-useast5-i-wopfjsm1ax-tx/abc123", "imageStrength": 0.5 }' \ "https://api.useapi.net/v1/dreamina/images" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const apiUrl = 'https://api.useapi.net/v1/dreamina/images'; // Text-to-image const response = await fetch(apiUrl, { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ prompt: 'A stunning aurora borealis over a frozen lake', model: 'seedream-4.6', ratio: '16:9', resolution: '2k' }) }); const result = await response.json(); console.log('Job created:', result.jobid); // Poll for completion const poll = async (jobid) => { while (true) { const res = await fetch(`https://api.useapi.net/v1/dreamina/images/${jobid}`, { headers: { 'Authorization': `Bearer ${token}` } }); const job = await res.json(); console.log('Status:', job.status); if (job.status === 'completed') { console.log('Images:', job.response.images.length); job.response.images.forEach((img, i) => console.log(` [${i}] ${img.width}x${img.height} ${img.imageUrl}`) ); return job; } if (job.status === 'failed') throw new Error(job.error); await new Promise(r => setTimeout(r, 10000)); } }; const completed = await poll(result.jobid); ``` **Python** ``` python import requests import time token = 'YOUR_API_TOKEN' api_url = 'https://api.useapi.net/v1/dreamina/images' headers = { 'Authorization': f'Bearer {token}', 'Content-Type': 'application/json' } # Text-to-image data = { 'prompt': 'A stunning aurora borealis over a frozen lake', 'model': 'seedream-4.6', 'ratio': '16:9', 'resolution': '2k' } response = requests.post(api_url, headers=headers, json=data) result = response.json() print(f"Job created: {result['jobid']}") # Poll for completion jobid = result['jobid'] while True: job = requests.get( f'https://api.useapi.net/v1/dreamina/images/{jobid}', headers={'Authorization': f'Bearer {token}'} ).json() print(f"Status: {job['status']}") if job['status'] == 'completed': for i, img in enumerate(job['response']['images']): print(f" [{i}] {img['width']}x{img['height']} {img['imageUrl']}") break if job['status'] == 'failed': raise Exception(job.get('error')) time.sleep(10) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-videos-interpolate === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-videos-interpolate --- layout: default title: POST videos/interpolate description: "Interpolate a Dreamina video to 30 or 60 FPS via POST videos/interpolate in the useapi.net Dreamina API v1 — adds intermediate frames for smoother motion." parent: Dreamina API nav_order: 706 --- ## Interpolate Video April 2, 2026 --- Interpolate a generated video to higher frame rate (30 or 60 FPS from the original 24 FPS). Creates smoother motion by generating intermediate frames. Requires a completed video generation or video upscale job. Each video can only be interpolated once. You can interpolate both original and upscaled videos. Interpolation is asynchronous — poll [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) for the result. > **https://api.useapi.net/v1/dreamina/videos/interpolate** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Request Body ```json { "jobid": "j0302140530123456789v-u12345-CA:user@example.com-bot:dreamina", "fps": 60 } ``` - `jobid` is **required**. The job ID of a completed video generation job from [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos) or a completed video upscale job from [POST /videos/upscale](/docs/api-dreamina-v1/post-dreamina-videos-upscale). - `fps` is **required**. Target frame rate. Supported values: `30`, `60`. - `replyUrl` is optional, webhook URL for job status callbacks. Callback body has the same JSON shape as [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) response. - `replyRef` is optional, custom reference string passed back in webhook callbacks. - `maxJobs` is optional, override max concurrent jobs for this request (1-50). ### Responses **200** **200 OK** Interpolation job created. Poll [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) for the result. ```json { "jobid": "j0302140630123456789F-u12345-CA:user@example.com-bot:dreamina", "type": "video-interpolate", "status": "created", "model": "seedance-2.0-fast", "created": "2026-04-02T10:06:30.123Z", "request": { "jobid": "j0302140530123456789v-u12345-CA:user@example.com-bot:dreamina", "fps": 60 }, "response": { "forecastCost": 66 }, "code": 200 } ``` **400** **400 Bad Request** Validation error. ```json { "error": "Source video job is created, must be completed" } ``` ```json { "error": "Source video already interpolated: j0302140630123456789F-u12345-CA:user@example.com-bot:dreamina" } ``` ```json { "error": "Parameter fps (24) valid values: 30, 60" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Source video job not found. ```json { "error": "Source video job not found" } ``` ### Examples **Curl** ``` bash # Interpolate a generated video to 60 FPS curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "jobid": "YOUR_COMPLETED_VIDEO_JOBID", "fps": 60 }' \ "https://api.useapi.net/v1/dreamina/videos/interpolate" # Interpolate an upscaled video to 30 FPS curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "jobid": "YOUR_COMPLETED_UPSCALE_JOBID", "fps": 30 }' \ "https://api.useapi.net/v1/dreamina/videos/interpolate" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const response = await fetch('https://api.useapi.net/v1/dreamina/videos/interpolate', { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ jobid: 'YOUR_COMPLETED_VIDEO_JOBID', fps: 60 }) }); const result = await response.json(); console.log('Interpolate job:', result.jobid); // Poll for completion const poll = async (jobid) => { while (true) { const res = await fetch(`https://api.useapi.net/v1/dreamina/videos/${jobid}`, { headers: { 'Authorization': `Bearer ${token}` } }); const job = await res.json(); if (job.status === 'completed') { console.log('Video URL:', job.response.videoUrl); return job; } if (job.status === 'failed') throw new Error(job.error); await new Promise(r => setTimeout(r, 10000)); } }; await poll(result.jobid); ``` **Python** ``` python import requests import time token = 'YOUR_API_TOKEN' response = requests.post( 'https://api.useapi.net/v1/dreamina/videos/interpolate', headers={ 'Authorization': f'Bearer {token}', 'Content-Type': 'application/json' }, json={ 'jobid': 'YOUR_COMPLETED_VIDEO_JOBID', 'fps': 60 } ) result = response.json() print(f"Interpolate job: {result['jobid']}") # Poll for completion jobid = result['jobid'] while True: job = requests.get( f'https://api.useapi.net/v1/dreamina/videos/{jobid}', headers={'Authorization': f'Bearer {token}'} ).json() if job['status'] == 'completed': print(f"Video URL: {job['response']['videoUrl']}") break if job['status'] == 'failed': raise Exception(job.get('error')) time.sleep(10) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-videos-upscale === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-videos-upscale --- layout: default title: POST videos/upscale description: "Apply 2x super-resolution to a Dreamina video via POST videos/upscale in the useapi.net Dreamina API v1 — doubles dimensions (720p to 1440p, 1080p to 4K)." parent: Dreamina API nav_order: 705 --- ## Upscale Video April 2, 2026 (October 23, 2026) --- Upscale a generated video to 2x resolution (super resolution). Doubles both width and height — for example, 720p (1280x720) becomes 1440p (2560x1440), and 1080p (1920x1080) becomes 4K (3840x2160). Requires a completed video generation job from [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos). Each video can only be upscaled once. Upscale is asynchronous — poll [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) for the result. > **https://api.useapi.net/v1/dreamina/videos/upscale** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Request Body ```json { "jobid": "j0302140530123456789v-u12345-CA:user@example.com-bot:dreamina" } ``` - `jobid` is **required**. The job ID of a completed video generation job from [POST /videos](/docs/api-dreamina-v1/post-dreamina-videos). Must be a video generation job (not an upscale job) at 480p, 720p or 1080p. Upscale doubles the size, so a `2k` or `4k` source is refused with `400`. - `replyUrl` is optional, webhook URL for job status callbacks. Callback body has the same JSON shape as [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) response. - `replyRef` is optional, custom reference string passed back in webhook callbacks. - `maxJobs` is optional, override max concurrent jobs for this request (1-50). ### Responses **200** **200 OK** Upscale job created. Poll [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) for the result. ```json { "jobid": "j0302140630123456789V-u12345-CA:user@example.com-bot:dreamina", "type": "video-upscale", "status": "created", "model": "seedance-2.0-fast", "created": "2026-04-02T00:24:24.535Z", "request": { "jobid": "j0302140530123456789v-u12345-CA:user@example.com-bot:dreamina" }, "response": { "forecastCost": 30 }, "code": 200 } ``` **400** **400 Bad Request** Validation error. ```json { "error": "Source video job is created, must be completed" } ``` ```json { "error": "Source video already upscaled: j0302140630123456789V-u12345-CA:user@example.com-bot:dreamina" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **404** **404 Not Found** Source video job not found. ```json { "error": "Source video job not found" } ``` ### Examples **Curl** ``` bash curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "jobid": "YOUR_COMPLETED_VIDEO_JOBID" }' \ "https://api.useapi.net/v1/dreamina/videos/upscale" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const response = await fetch('https://api.useapi.net/v1/dreamina/videos/upscale', { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ jobid: 'YOUR_COMPLETED_VIDEO_JOBID' }) }); const result = await response.json(); console.log('Upscale job:', result.jobid); // Poll for completion const poll = async (jobid) => { while (true) { const res = await fetch(`https://api.useapi.net/v1/dreamina/videos/${jobid}`, { headers: { 'Authorization': `Bearer ${token}` } }); const job = await res.json(); if (job.status === 'completed') { console.log('Upscaled:', job.response.width, 'x', job.response.height); console.log('Video URL:', job.response.videoUrl); return job; } if (job.status === 'failed') throw new Error(job.error); await new Promise(r => setTimeout(r, 10000)); } }; await poll(result.jobid); ``` **Python** ``` python import requests import time token = 'YOUR_API_TOKEN' response = requests.post( 'https://api.useapi.net/v1/dreamina/videos/upscale', headers={ 'Authorization': f'Bearer {token}', 'Content-Type': 'application/json' }, json={ 'jobid': 'YOUR_COMPLETED_VIDEO_JOBID' } ) result = response.json() print(f"Upscale job: {result['jobid']}") # Poll for completion jobid = result['jobid'] while True: job = requests.get( f'https://api.useapi.net/v1/dreamina/videos/{jobid}', headers={'Authorization': f'Bearer {token}'} ).json() if job['status'] == 'completed': r = job['response'] print(f"Upscaled: {r['width']}x{r['height']}") print(f"Video URL: {r['videoUrl']}") break if job['status'] == 'failed': raise Exception(job.get('error')) time.sleep(10) ``` ### Try It
=== URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-videos === Document URL: https://useapi.net/docs/api-dreamina-v1/post-dreamina-videos --- layout: default title: POST videos description: "Submit a Dreamina video prompt via POST videos in the useapi.net Dreamina API v1 — Seedance models; text-to-video, image-guided, multi-frame, and Omni Reference modes." parent: Dreamina API nav_order: 600 --- ## Generate Videos February 23, 2026 (November 1, 2026) --- Generate videos using Dreamina AI models from text prompts with optional image frames. All video generation is asynchronous — this endpoint returns immediately with a job ID. Poll [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) for completion, or use `replyUrl` webhook for automatic callbacks. Video generation typically completes within 60-180 seconds depending on the model and duration. The `long_video` and `edit` modes on `seedance-2.5` take considerably longer — a 21-second edit measured 13 minutes and a 35-second long video 17, so use `replyUrl` rather than polling for those. ### Input Modes The input mode is automatically determined from the provided parameters: | Mode | API Value | Trigger | Description | |------|-----------|---------|-------------| | Prompt | `prompt` | No image refs | Text-to-video generation | | First Frame | `first_frame` | `firstFrameRef` provided | Video starts from uploaded image | | First/Last Frame | `end_frame` | `firstFrameRef` + `endFrameRef` | Video transitions between two images | | Multi-Frame | `multi_frame` | `frame_N_imageRef` params | 2-10 keyframe images with per-frame prompts | | Omni Reference | `unified_edit` | `omni_N_imageRef`/`omni_N_videoRef`/`omni_N_audioRef` in prompt | Interleaved text, image, video, and audio references (Seedance 2.5, 2.0, 2.0 Fast, 2.0 Mini, Wan 3.0; HappyHorse 1.1 images only) | | Long Video | `long_video` | `duration` above 30 | 31-180 second generation (`seedance-2.5` only) | | Edit | `edit` | `editVideoRef` provided | Re-cut an existing video (`seedance-2.5` only) | #### Aspect ratio auto-detection In `first_frame` and `end_frame` modes the aspect ratio is taken from the uploaded image, and the closest standard ratio (21:9, 16:9, 4:3, 1:1, 3:4, 9:16) is used. The `ratio` parameter cannot be supplied alongside image refs. When using `firstFrameRef` together with `endFrameRef`, both images must share the same aspect ratio. ### Model Capabilities | Model | Region | Durations | Resolution | Input Modes | |-------|--------|-----------|------------|-------------| | `seedance-2.5` | US, CA | 4-30s, or 31-180s in long video mode | 480p (default), 720p, 1080p | Prompt, First/Last Frame, Omni Reference, Long Video, Edit | | `seedance-2.0` | US, CA | 4-15s | 720p, 1080p, 4k | Prompt, First/Last Frame, Omni Reference | | `seedance-2.0-fast` | US, CA | 4-15s | 720p, 1080p, 2k, 4k (above 720p, upscaled from 720p) | Prompt, First/Last Frame, Omni Reference | | `seedance-2.0-mini` | US, CA | 4-15s | 720p, 1080p, 2k, 4k (above 720p, upscaled from 720p) | Prompt, First/Last Frame, Omni Reference | | `seedance-1.5-pro` | US, CA | 5, 10, 12s | 720p, 1080p (1080p is CA only) | Prompt, First/Last Frame | | `seedance-1.0-pro` | CA | 5, 10s | 1080p | Prompt, First Frame | | `seedance-1.0-mini` | US | 5, 10s | 720p | Prompt, First Frame, Multi-Frame | | `seedance-1.0-fast` | CA | 5, 10s | 720p, 1080p | Prompt, First Frame, Multi-Frame | | `happyhorse-1.1` | CA | 4-15s | 720p (default), 1080p | Prompt, First Frame, Omni Reference (images only) | | `wan-3.0` | CA | 4-15s | 720p (default), 1080p | Prompt, First/Last Frame, Omni Reference | Both regions run the same resolutions on the Seedance 2.0 and 2.5 models. `seedance-2.5` runs 1080p on CA since August 14, 2026 and on US since October 23, 2026. `seedance-2.0-fast` and `seedance-2.0-mini` render at 720p, and Dreamina upscales 1080p, 2k and 4k from that 720p video (as of October 23, 2026). 480p arrived with `seedance-2.5` on August 7, 2026. On `seedance-1.5-pro`, 1080p is CA only. See [Setup Dreamina](/docs/start-here/setup-dreamina) for per-region setup and pricing. `happyhorse-1.1` (by Alibaba) and `wan-3.0` (by Tongyi Lab) run on CA accounts as of October 23, 2026. Both make 4 to 15-second videos with sound at 720p or 1080p. HappyHorse takes up to 9 reference images, and Wan up to 10 images, 5 videos and 5 audio clips. #### What is new in `seedance-2.5` * Up to **30 seconds** in one call, twice the 15-second ceiling of the 2.0 family. * Up to **50 omni references** — 30 images, 10 videos, 10 audio clips — against the 2.0 family's 12. * Defaults to `480p`, which costs roughly half of `720p`. * `1080p`, added on CA August 14, 2026 and on US October 23, 2026. * **Long video** — pass a `duration` of 31 to 180 and the generation switches to long video mode, six times the ordinary 30-second ceiling. Works from a plain prompt or with omni references. Priced on its own, higher, per-second rate. * **Edit** — pass `editVideoRef` and Seedance re-cuts an existing 4-30 second video instead of generating a new one, keeping its motion and framing while applying whatever the prompt asks for. Combine it with `omni_N_imageRef` references to bring new elements in. * Attaching an omni video reference makes a generation cheaper per second at `480p` on both regions (as of October 21, 2026, US `720p` no longer has the lower rate). Reference videos may be up to 30.2 seconds each and are billed on top of the output duration. #### Content on `seedance-2.5` Markedly more permissive than the 2.0 family: * **Real human faces are accepted.** A photographic portrait works directly as `omni_N_imageRef` or `firstFrameRef`, and the identity carries through the clip. The 2.0 family rejects them, so the face-grid workaround in the [Seedance 2.0 real-faces tutorial](/blog/260415) is not needed here. * **Cinematic violence renders.** Stylised action — fight scenes, impacts, blood spray — is generated rather than refused. * **Recognisable third-party content is refused**, as `fail_code 2053`. It is judged against the finished video two to four minutes into generation, not against your prompt text — so a prompt naming no person and no property can still fail if it *describes* one, such as a costumed superhero, a trademarked landmark, or a character written as an unmistakable celebrity. Failed generations are not charged. > **https://api.useapi.net/v1/dreamina/videos** ### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json # Alternatively you can use multipart/form-data # Content-Type: multipart/form-data ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ### Request Body ```json { "prompt": "A serene mountain landscape at sunset with camera slowly panning right", "model": "seedance-2.0", "ratio": "16:9", "duration": 5 } ``` - `account` is optional. Specific account to use. Auto-inferred from image refs if provided. If omitted, a random account with free capacity is picked among those whose region offers `model`. - `prompt` is **required** for `prompt` mode. Optional for `first_frame` and `end_frame`. Cannot be used with `multi_frame` mode (use `frame_N_prompt` instead). Maximum 20000 characters on `wan-3.0`, 15000 on `seedance-2.5`, 2500 on `happyhorse-1.1`, 5000 on every other model. - `model` is optional, the AI model to use (default: `seedance-2.0`). Available models depend on account region — see Model Capabilities table. - `ratio` is optional, video aspect ratio (default: `16:9`). One of `21:9`, `16:9`, `4:3`, `1:1`, `3:4`, `9:16`, plus `4:5`, `5:4` and `9:21` on `happyhorse-1.1`. `wan-3.0` takes `16:9`, `4:3`, `1:1`, `3:4` and `9:16`. Cannot be specified when image refs are provided (image aspect ratio is used). - `duration` is optional, video duration in seconds (default: `5`). Valid values depend on model — see Model Capabilities table. On `seedance-2.5` any value from 31 to 180 switches the request to long video mode, which is priced separately. Cannot be used with `editVideoRef`, where the output always matches the source video. - `resolution` is optional, one of `480p`, `720p`, `1080p`, `2k` or `4k`. Each model accepts only some of these — see the Resolution column in Model Capabilities above. Defaults to `720p`, except `seedance-2.5` which defaults to `480p`. - `firstFrameRef` is optional, `imageRef` from [POST /assets/`account`](/docs/api-dreamina-v1/post-dreamina-assets-account) for the starting frame. Triggers `first_frame` mode. - `endFrameRef` is optional, `imageRef` for the ending frame. Triggers `end_frame` mode. Requires `firstFrameRef`. - `editVideoRef` is optional, `videoRef` from [POST /assets/`account`](/docs/api-dreamina-v1/post-dreamina-assets-account) for the video to re-cut. Triggers `edit` mode, `seedance-2.5` only. The source must be 4-30 seconds. The output inherits the source's length and aspect ratio, so `duration` and `ratio` cannot be supplied alongside it. May be combined with `omni_N_imageRef`/`omni_N_videoRef` references, mentioned in the prompt as usual. - `frame_N_imageRef` is optional (N=1-10), `imageRef` for keyframe N. Triggers `multi_frame` mode when at least 2 frames are provided. - `frame_N_prompt` is optional, per-frame prompt for multi_frame mode. Maximum 5000 characters. - `frame_N_duration` is optional, per-frame duration in seconds for multi_frame mode (1-6, default: `5`). - `replyUrl` is optional, webhook URL for job status callbacks. Receives POST requests with the job record on submission and on completion/failure. Callback body has the same JSON shape as [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) response. - `replyRef` is optional, custom reference string passed back in webhook callbacks. - `omni_N_imageRef`, `omni_N_videoRef` and `omni_N_audioRef` are optional `assetRef` values from [POST /assets/`account`](/docs/api-dreamina-v1/post-dreamina-assets-account), and trigger Omni Reference mode. Mention each one in the prompt as `@imageN`, `@videoN` or `@audioN` — for example `"Make @image1 dance like @video1 while @audio1 plays"`. Supported by `seedance-2.5`, `seedance-2.0`, `seedance-2.0-fast`, `seedance-2.0-mini`, `wan-3.0`, and `happyhorse-1.1` (images only); per-model counts are in the reference-limit table below. - `maxJobs` is optional, override max concurrent jobs for this request (1-50). **Omni Reference constraints:** - Only supported by `seedance-2.5`, `seedance-2.0`, `seedance-2.0-fast`, `seedance-2.0-mini`, `wan-3.0`, and `happyhorse-1.1` (images only) - Prompt must contain `@imageN`, `@videoN`, and/or `@audioN` placeholders matching the provided `omni_N_*Ref` params - A reference that is uploaded but never mentioned in the prompt is ignored, and is not billed - The Seedance 2.0 models and `wan-3.0` need at least one image or video reference. Audio references alone are refused with `400`. `seedance-2.5` accepts audio alone - Cannot be combined with `firstFrameRef`, `endFrameRef`, or `frame_N_imageRef` Reference limits differ by model: | Limit | `seedance-2.5` | Seedance 2.0 family | `wan-3.0` | `happyhorse-1.1` | |---|---|---|---|---| | Image references | 30 | 9 | 10 | 9 | | Video references | 10 | 3 | 5 | — | | Audio references | 10 | 3 | 5 | — | | Total materials combined | 50 | 12 | 20 | 9 | | Total video duration across all refs | 30.2s | 15.4s | 15s | — | | Total audio duration across all refs | 30.2s | 15s | 15s | — | | Individual video | 1.8-30.2s, 300-6000px | 2-15.4s, 200-2160px | 1-15s, 240-4096px | — | | Individual audio | 1.8-30.2s | 2-15s | 1-15s | — | Uploads via [POST /assets/`account`](/docs/api-dreamina-v1/post-dreamina-assets-account) are accepted up to the loosest of these limits (video 1.8-30.2s, audio 1.8-30.2s, video max 50 MB, audio max 15 MB), so one asset can be reused across models. The per-model limits above are checked when you submit the generation. **Multi-frame constraints:** - Minimum 2 frames, maximum 10 frames - No gaps allowed (frame_1 through frame_N must be contiguous) - All frame images must have the same aspect ratio - Top-level `prompt` cannot be used (use `frame_N_prompt` instead) - `firstFrameRef`/`endFrameRef` cannot be combined with multi_frame - Total duration of non-last frames must equal a valid model duration ### Responses **200** **200 OK** Job created successfully. Video is generating in the background. ```json { "jobid": "j0223140530123456789v-u12345-CA:user@example.com-bot:dreamina", "type": "video", "status": "created", "model": "seedance-2.0", "created": "2026-02-23T14:05:30.123Z", "request": { "prompt": "A serene mountain landscape at sunset with camera slowly panning right", "model": "seedance-2.0", "ratio": "16:9", "duration": 5, "inputMode": "prompt" }, "response": { "forecastCost": 125 }, "code": 200 } ``` Poll [GET /videos/`jobid`](/docs/api-dreamina-v1/get-dreamina-videos-jobid) for completion status, or use `replyUrl` for webhook callbacks. **400** **400 Bad Request** Validation error. ```json { "error": "Parameter model (invalid-model) valid values: seedance-2.5, seedance-2.0, seedance-2.0-fast, seedance-2.0-mini, seedance-1.5-pro, seedance-1.0-mini, seedance-1.0-pro, seedance-1.0-fast, happyhorse-1.1, wan-3.0" } ``` **401** **401 Unauthorized** Invalid API token. ```json { "error": "Unauthorized" } ``` **402** **402 Payment Required** Subscription expired or insufficient credits. ```json { "error": "Account has no subscription or subscription expired" } ``` **403** **403 Forbidden** One of two reasons, and `ret` says which. `ret` `5006`: the account has no Dreamina subscription that includes this model. Dreamina runs it only on a paid plan, and credits bought separately don't count. Subscribe the account, or use one that has a plan. ```json { "error": "Account US:user@example.com needs a paid Dreamina subscription for seedance-2.5: Dreamina refused the job because the account has no plan that includes it (credits bought separately don't count). Subscribe at https://dreamina.capcut.com/pricing/dreamina-price, or use an account that has one. Dreamina: credit miss role", "ret": "5006", "errmsg": "credit miss role", "account": "US:user@example.com", "model": "seedance-2.5" } ``` `ret` `4010`: Dreamina asks for its one-time "Before you continue" confirmation on this account (currently Seedance 2.x). We accept it automatically and resubmit, so you only get this response when that did not clear it. Retry once. If it persists, sign in at [dreamina.capcut.com](https://dreamina.capcut.com) with the account, start a generation with the same model, click Agree, then retry. ```json { "error": "Dreamina asks for a one-time confirmation on account US:user@example.com and our automatic confirmation did not clear it. Retry once. If it persists, sign in at https://dreamina.capcut.com with this account, start a seedance-2.0 generation, click Agree on \"Before you continue\", then retry. Dreamina: Couldn't generate. Refresh and agree to the confirmation before you continue.", "ret": "4010", "errmsg": "Couldn't generate. Refresh and agree to the confirmation before you continue.", "failCode": "4010", "account": "US:user@example.com", "model": "seedance-2.0" } ``` **429** **429 Too Many Requests** All accounts at maximum capacity. Wait for current jobs to complete or increase `maxJobs`. ```json { "error": "All accounts at capacity" } ``` **503** **503 Service Unavailable** Dreamina signed the account out and signing it in again failed for a temporary reason. The response carries a `Retry-After: 30` header. Retry in about 30 seconds. ```json { "error": "Dreamina signed this account out and signing it in again failed temporarily. Retry in about 30 seconds.", "code": 503, "retryAfterSec": 30 } ``` **596** **596 Session Error** The account's session expired or Dreamina locked it, or the account is in its sign-out pause. Check [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts): an account with `signedOutPauseUntil` comes back by itself after the pause, any other account needs to be re-added using [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts) with correct credentials. ```json { "error": "Dreamina account session expired or locked. Please re-add account via POST /v1/dreamina/accounts", "code": 596 } ``` When Dreamina signs an account out again right after a fresh sign-in, the account is paused for 30 minutes. While the pause runs, [GET /accounts](/docs/api-dreamina-v1/get-dreamina-accounts) shows `signedOutPauseUntil` (an ISO 8601 time) on that account, requests that name it answer `596`, and automatic account selection uses your other accounts. When every account is paused, requests answer `596`. After the pause the account is used again. If Dreamina signs it out right after a fresh sign-in again, after the pause and within 24 hours, the account is marked with an `error` and answers `596` until you re-add it with [POST /accounts](/docs/api-dreamina-v1/post-dreamina-accounts). Re-adding an account also ends its pause. A sign-in that fails for a temporary reason, not because Dreamina refused the account, answers `503` with a `Retry-After: 30` header. The account is fine: retry in about 30 seconds. ### Model ```typescript { jobid: string // Unique job identifier type: 'video' // Job type status: 'created' // Initial status model: string // Model used created: string // ISO 8601 timestamp request: { prompt?: string model: string ratio?: string // "16:9", "9:16", etc. duration?: number // Seconds inputMode: string // "prompt" | "first_frame" | "end_frame" | "multi_frame" | "unified_edit" | "long_video" | "edit" resolution?: string // "480p", "720p", "1080p", "2k" or "4k" firstFrameRef?: string // assetRef (image) for first frame endFrameRef?: string // assetRef (image) for end frame frame_1_imageRef?: string // Keyframe refs (multi_frame mode) frame_1_prompt?: string frame_1_duration?: number frame_2_imageRef?: string frame_2_prompt?: string frame_2_duration?: number omni_1_imageRef?: string // Omni image refs (use @image1 in prompt) omni_2_imageRef?: string omni_1_videoRef?: string // Omni video refs (use @video1 in prompt) omni_1_audioRef?: string // Omni audio refs (use @audio1 in prompt) replyUrl?: string // Webhook URL replyRef?: string // Custom reference } response: { forecastCost: number // Estimated generation time in seconds, NOT a price } code: number // HTTP status code error?: string // Error message } ``` ### Examples **Curl** ``` bash # Text-to-video curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "prompt": "A serene mountain landscape at sunset", "model": "seedance-2.0", "ratio": "16:9", "duration": 5 }' \ "https://api.useapi.net/v1/dreamina/videos" # Image-to-video (first frame — ratio auto-detected from image) curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "prompt": "Camera slowly pans across the scene", "model": "seedance-2.0", "firstFrameRef": "CA:user@example.com-image:w685:h900:s86866-uri:tos-useast5-i-wopfjsm1ax-tx/abc123", "duration": 5 }' \ "https://api.useapi.net/v1/dreamina/videos" # Omni Reference (image + audio) curl -X POST \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "prompt": "@image1 slowly moving forward while @audio1 plays in background", "model": "seedance-2.0", "ratio": "16:9", "duration": 4, "omni_1_imageRef": "CA:user@example.com-image:w2560:h1440:s580914-uri:tos-alisg-i-wopfjsm1ax-sg/abc123", "omni_1_audioRef": "CA:user@example.com-audio:d14040-vid:v10762g50003d77l5uvog65nl4esjs2g" }' \ "https://api.useapi.net/v1/dreamina/videos" ``` **JavaScript** ``` javascript const token = 'YOUR_API_TOKEN'; const apiUrl = 'https://api.useapi.net/v1/dreamina/videos'; // Text-to-video const response = await fetch(apiUrl, { method: 'POST', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' }, body: JSON.stringify({ prompt: 'A serene mountain landscape at sunset', model: 'seedance-2.0', ratio: '16:9', duration: 5 }) }); const result = await response.json(); console.log('Job created:', result.jobid); // Poll for completion const poll = async (jobid) => { while (true) { const res = await fetch(`https://api.useapi.net/v1/dreamina/videos/${jobid}`, { headers: { 'Authorization': `Bearer ${token}` } }); const job = await res.json(); console.log('Status:', job.status); if (job.status === 'completed') { console.log('Video URL:', job.response.videoUrl); return job; } if (job.status === 'failed') throw new Error(job.error); await new Promise(r => setTimeout(r, 10000)); } }; const completed = await poll(result.jobid); ``` **Python** ``` python import requests import time token = 'YOUR_API_TOKEN' api_url = 'https://api.useapi.net/v1/dreamina/videos' headers = { 'Authorization': f'Bearer {token}', 'Content-Type': 'application/json' } # Text-to-video data = { 'prompt': 'A serene mountain landscape at sunset', 'model': 'seedance-2.0', 'ratio': '16:9', 'duration': 5 } response = requests.post(api_url, headers=headers, json=data) result = response.json() print(f"Job created: {result['jobid']}") # Poll for completion jobid = result['jobid'] while True: job = requests.get( f'https://api.useapi.net/v1/dreamina/videos/{jobid}', headers={'Authorization': f'Bearer {token}'} ).json() print(f"Status: {job['status']}") if job['status'] == 'completed': print(f"Video URL: {job['response']['videoUrl']}") break if job['status'] == 'failed': raise Exception(job.get('error')) time.sleep(10) ``` ### Try It
=== URL: https://useapi.net/docs/start-here/setup-faceswap === Document URL: https://useapi.net/docs/start-here/setup-faceswap --- layout: default title: Setup InsightFaceSwap description: "How to set up InsightFaceSwap for the useapi.net API — connect your account and start generating via the API." parent: Start Here nav_order: 500 --- # Setup InsightFaceSwap ## Table of contents Approximately 3 minutes to complete setup steps. --- > This is the setup guide for [InsightFaceSwap API](/docs/api-faceswap-v1). A [Discord](https://discord.com) account and a [useapi.net subscription](/docs/subscription) are required for the API to work. ## Create Discord account You need a [Discord](https://discord.com) account to interact with [InsightFaceSwap Discord bot](https://discord.gg/Ym3X8U59ZN). Create a [new account](https://discord.com/register) if you don't have one already. Please note even if you have an existing Discord account we are **strongly** recommending creating a separate Discord account specifically designated to be used with useapi.net API. ## Create Discord server Please log in to your Discord account and create a new Discord server following [official instructions](https://support.discord.com/hc/en-us/articles/204849977-How-do-I-create-a-server-). ## Create `#api` text channel on your Discord server Once you created the Discord server you need to create a designated for API-related work text channel. You can refer to [official instructions](https://support.discord.com/hc/en-us/articles/4412085582359-Text-Channels-Text-Chat-In-Voice-Channels) to learn about Discord channels and how to manage them on your server. We suggest naming the text channel `#api` for clarity and also making that channel private. ## Join Picsi.Ai - Powered by InsightFace Discord Server Follow Picsi.Ai [instructions](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md) and join official [Picsi.Ai - Powered by InsightFace Discord Server](https://discord.gg/Ym3X8U59ZN). ## Add InsightFaceSwap bot to your Discord server Please follow [official instructions](https://discord.com/channels/1095014106576212101/1128550062683865178/1189604165006135379) to add InsightFaceSwap bot to your Discord server created earlier. ## Example of Discord server with private `#api` text channel and InsightFace bot Below you can see we created `useapi` Discord server with private `#api` text channel: ![](/assets/images/discord_faceswap_server_setup_example.png) InsightFace bot invited to the server and has access to private `#api` text channel ![](/assets/images/discord_faceswap_channel_setup_example.png) ## Test InsightFace bot Navigate to the created above `#api` text channel and execute few InsightFaceSwap bot command(s) to make sure it works. ## Make a note of your server id and channel id values Your Discord URL looks like `https://discord.com/channels//` In the screenshot above URL is `https://discord.com/channels/1122226477161144546/1122277481822456166` where `1122226477161144546` is your Discord server id and `1122277481822456166` is your private `#api` channel id. Save both server id and channel id values, you will need those numbers for API. ## Obtain Discord token There are many tutorials describing how to obtain Discord tokens. Please refer to the following links bellow for additional guidance: - [How to Find Your Discord Token](https://discordhelp.net/discord-token) - [How To Get Your Discord Token](https://pcstrike.com/how-to-get-discord-token/) - [How to get Discord Token](https://linuxhint.com/get-discord-token/) Keep in mind that anyone with a Discord token can have **full access** to your Discord account so please keep it **safe** and **secure**. To reset your Discord token simply change your Discord password. ## Verify Discord access Once all the above steps are completed you should have the following: - Discord token - Discord server id number - Discord private `#api` channel id number This only verifies that the token, server id and channel id values are correct. To complete setup, you **MUST** proceed to [POST account/`channel`](/docs/api-faceswap-v1/post-faceswap-account-channel) and complete the configuration. ##### Server
##### Channel
=== URL: https://useapi.net/docs/api-faceswap-v1 === Document URL: https://useapi.net/docs/api-faceswap-v1 --- layout: default title: InsightFaceSwap API nav_logo: /assets/images/picsi.png nav_title: InsightFaceSwap API seo_title: "InsightFaceSwap API: Automate the Picsi.Ai Discord Bot" description: "Third-party InsightFaceSwap API by useapi.net: automate the Picsi.Ai Discord bot over REST for face swaps, HiFidelity, backgrounds and headshots, free or paid." nav_order: 9000 has_children: true permalink: /docs/api-faceswap-v1 --- # InsightFaceSwap API February 2024 (October 21, 2026) This is a [third-party](/docs/legal#affiliation--third-party-services) API for the [InsightFaceSwap Discord Bot](https://discord.gg/Ym3X8U59ZN) by [Picsi.Ai](https://www.picsi.ai/). It uses your [InsightFaceSwap subscription](https://www.patreon.com/picsi/membership) on Patreon: Free, Basic $9.99, Pro $19.99 or Ultra $34.99 a month (as of October 2026). It turns the Discord bot into a REST API that swaps faces from your photos onto target images and GIFs, makes AI headshots and changes backgrounds. Picsi.Ai sells no API of its own (as of October 2026), so your code swaps faces without opening Discord. ## Models | Model | What it makes | Notes | |---|---|---| | Saved-face swap
`/swapid` | [Swaps a saved face](/docs/api-faceswap-v1/post-faceswap-swapid) onto a target image | Save faces once with [POST saveid](/docs/api-faceswap-v1/post-faceswap-saveid). Join names with `+`, as in `mother+father`, to blend up to 3 saved faces into one | | One-step swap
`/picsi` | [Swaps the face](/docs/api-faceswap-v1/post-faceswap-picsi) from a source image onto a target image or animated GIF | No saved face needed. Free options keep the target's mouth `-m` or closed eyes `--shut` and fix chin `--ch` and hairline `--hl` | | INSwapper
`Apps/INSwapper` | [Swaps the active face](/docs/api-faceswap-v1/post-faceswap-inswapper) onto an image already posted in your Discord channel | Pick the active face with [POST setid](/docs/api-faceswap-v1/post-faceswap-setid), which also takes `+` blends | | Paid modes
`-f` `-s` `-e` `-o` `-y` `-a` `-x` | Face Texturizer, Sharpen, Expression matching, Oldify, Youngify, [ARTIFY](https://www.patreon.com/posts/picsi-ai-v2-0-97389077) and Xtreme close-ups, plus [HiFidelity Mode](https://www.patreon.com/posts/89036144) | Expression, Oldify and Youngify take an intensity from 1 to 1000 | | AI headshot
`/headshot` | [Portraits of your saved face](/docs/api-faceswap-v1/post-faceswap-headshot) from a text prompt | Results by webhook or [GET jobs/?jobid=](/docs/api-faceswap-v1/get-faceswap-jobid) | | Background change
`/changebg` | [A new AI background](/docs/api-faceswap-v1/post-faceswap-changebg) behind the person in your photo, from a text prompt | Results by webhook or polling, and running jobs can be [listed](/docs/api-faceswap-v1/get-faceswap-jobs) or [cancelled](/docs/api-faceswap-v1/get-faceswap-jobs-cancel) | | Face library
`/listid` `/delid` `/delall` | [Lists](/docs/api-faceswap-v1/post-faceswap-listid), [deletes one](/docs/api-faceswap-v1/del-faceswap-delid) or [deletes every](/docs/api-faceswap-v1/post-faceswap-delall) saved face | Picsi.Ai keeps a face-print, not your photo | ## Pricing What each InsightFaceSwap plan gives you on the Discord bot, from [Picsi.Ai's price list](https://www.picsi.ai/en/pricing) (as of October 2026). Each plan comes with daily credits, and each job uses some of them. | | Free $0 (10 cr a day) | Ultra $34.99/m (800 cr a day) | Pro $19.99/m (400 cr a day) | Basic $9.99/m (200 cr a day) | |---|---|---|---|---| | Image face swap | 1 cr per face (largest face only) | 1 cr per face (up to 4 faces) | 1 cr per face (up to 4 faces) | 1 cr per face (up to 4 faces) | | Animated GIF swap | paid plans | up to 50 cr (up to 150 frames) | 30 cr (up to 75 frames) | 20 cr (up to 20 frames) | | Paid modes and ARTIFY | paid plans | included | included | included | | Saved faces | 20 | 60 | 60 | 60 | | VIP queue | paid plans | included | included | included | | Lossless PNG output | not included | included | included | not included | - A free InsightFaceSwap account swaps the largest face in a static image, and each account you connect has its own daily credits. - Credits reset every day at 0:00 UTC and don't roll over. Yearly billing costs 20% less, and Picsi.Ai sells the same plans by card on [picsi.ai](https://www.picsi.ai/en/pricing). - Paid plans also allow commercial use of your results, with attribution to Picsi.Ai as its [terms](https://www.picsi.ai/en/terms) set out, and add [many more](https://discord.com/channels/1095014106576212101/1128550062683865178) bot features. ### 开始使用 每月 15 美元的订阅即可使用 useapi.net 上的所有 API:一个 Token,所有服务。每个服务最多绑定 3 个你自己的账号,useapi.net 负责 REST 接口、负载均衡和轮询。需要更多账号?每增加一个订阅每月 10 美元,每个服务再多 3 个账号。 [订阅 — 每月 15 美元](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [用加密货币支付](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) 没有国际信用卡?可以[用加密货币订阅](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK)(加密货币付款不退款)。价格与批量方案见[订阅页面](/docs/subscription)。用 Stripe 付款,首次购买 14 天内、且成功生成少于 50 次可全额退款。已经订阅?请在 [Stripe 客户门户](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) 修改数量,无需重新购买。 ### API を使い始める 月額15ドルのサブスクリプション1つで、useapi.net のすべての API を使えます。トークン1つで、すべてのサービスに対応します。各サービスにご自身のアカウントを最大3つまで接続でき、REST API、負荷分散、ポーリングは useapi.net が担当します。アカウントを増やしたい場合は、サブスクリプションを1つ追加するごとに月額10ドルで、各サービスのアカウントが3つずつ増えます。 [登録する — 月額15ドル](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [暗号資産で支払う](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) 海外で使えるクレジットカードがない場合は、[暗号資産で登録](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK)することもできます(暗号資産での支払いは返金できません)。料金とボリュームプランは[サブスクリプションのページ](/docs/subscription)をご覧ください。Stripe でお支払いの場合、初回購入から14日以内で、成功した生成が50回未満であれば全額返金されます。すでに登録済みの場合は、新たに購入せず [Stripe カスタマーポータル](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo)で数量を変更してください。 ### Comece a usar a API Uma assinatura de US$ 15 por mês dá acesso a todas as APIs da useapi.net: um token, todos os serviços. Você conecta até 3 contas suas por serviço, e a useapi.net cuida da API REST, do balanceamento de carga e do polling. Precisa de mais contas? Cada assinatura extra custa US$ 10 por mês e acrescenta mais 3 contas por serviço. [Assinar — US$ 15/mês](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Pagar com cripto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) Não tem cartão de crédito internacional? Você também pode [assinar com criptomoedas](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) (pagamentos em cripto não são reembolsáveis). Preços e planos de volume estão na [página de assinatura](/docs/subscription). Pagando pelo Stripe, você recebe reembolso integral em até 14 dias após a primeira compra, se tiver menos de 50 gerações bem-sucedidas. Já é assinante? Altere a quantidade no [portal do cliente Stripe](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) em vez de comprar de novo. ### Bắt đầu dùng API Một gói đăng ký $15/tháng dùng được mọi API trên useapi.net: một token cho tất cả dịch vụ. Mỗi dịch vụ bạn kết nối tối đa 3 tài khoản của riêng mình, còn useapi.net lo REST API, cân bằng tải và polling. Cần thêm tài khoản? Mỗi gói đăng ký thêm giá $10/tháng và cho thêm 3 tài khoản ở mỗi dịch vụ. [Đăng ký — $15/tháng](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Thanh toán bằng tiền mã hóa](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) Không có thẻ thanh toán quốc tế? Bạn có thể [đăng ký bằng tiền mã hóa](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) (thanh toán bằng tiền mã hóa không được hoàn tiền). Giá và các gói số lượng lớn có trên [trang đăng ký](/docs/subscription). Nếu thanh toán qua Stripe, bạn được hoàn tiền toàn bộ trong 14 ngày kể từ lần mua đầu tiên khi có dưới 50 lượt tạo thành công. Đã đăng ký rồi? Hãy đổi số lượng trong [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) thay vì mua lại. ### Mulai memakai API Satu langganan US$15/bulan mencakup semua API di useapi.net: satu token untuk semua layanan. Di setiap layanan Anda bisa menghubungkan hingga 3 akun milik Anda sendiri, dan useapi.net menangani REST API, load balancing, dan polling. Butuh lebih banyak akun? Setiap langganan tambahan US$10/bulan dan menambah 3 akun lagi per layanan. [Berlangganan — US$15/bulan](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Bayar dengan kripto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) Tidak punya kartu kredit internasional? Anda bisa [berlangganan dengan kripto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) (pembayaran kripto tidak bisa di-refund). Harga dan paket volume ada di [halaman langganan](/docs/subscription). Jika membayar lewat Stripe, Anda mendapat refund penuh dalam 14 hari sejak pembelian pertama, selama jumlah generasi yang berhasil kurang dari 50. Sudah berlangganan? Ubah jumlahnya di [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo), tidak perlu membeli lagi. ### เริ่มใช้งาน API การสมัครสมาชิกเดือนละ $15 ใช้ได้กับทุก API บน useapi.net ใช้ Token เดียวกับทุกบริการ เชื่อมบัญชีของคุณเองได้สูงสุด 3 บัญชีต่อบริการ แต่ละบัญชีใช้แพ็กเกจของเว็บไซต์นั้นเอง ส่วน useapi.net ดูแล REST API การกระจายโหลด และการ polling ให้ ต้องการบัญชีมากกว่านี้? สมัครเพิ่มแต่ละครั้งเดือนละ $10 และได้เพิ่มอีก 3 บัญชีต่อบริการ [สมัครสมาชิก — $15/เดือน](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [ชำระด้วยคริปโต](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) ไม่มีบัตรเครดิตที่ใช้จ่ายต่างประเทศได้? [สมัครด้วยคริปโต](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK)ก็ได้ (การชำระด้วยคริปโตขอคืนเงินไม่ได้) ดูราคาและแพ็กเกจสำหรับปริมาณมากได้ที่[หน้าการสมัครสมาชิก](/docs/subscription) ถ้าชำระผ่าน Stripe ขอคืนเงินเต็มจำนวนได้ภายใน 14 วันหลังซื้อครั้งแรก หากสร้างงานสำเร็จไม่ถึง 50 ครั้ง สมัครไว้แล้ว? เปลี่ยนจำนวนได้ที่ [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) โดยไม่ต้องซื้อใหม่ ### Start using the API A single $15/month subscription covers every API on useapi.net — one token, all services. You connect up to 3 accounts per service, each with its own website subscription, and useapi.net handles the REST API, load balancing, and polling. Need more accounts? Each extra subscription is $10/month and adds 3 more accounts per service. [Subscribe — $15/month](https://buy.stripe.com/8x2aEX4Bd8Vh9PMg4qeUU03){: .btn .btn-purple .mr-2 .mt-3 .mb-3 } [Pay with crypto](https://pay.boomfi.xyz/38UTma36Rv0DrY8NlH1r2SEG7VK) [Pricing and volume options](/docs/subscription) — full refund within the first 14 days if you have fewer than 50 successful generations. Already subscribed? Change the quantity in the [Stripe Customer Portal](https://billing.stripe.com/p/login/28obM4fZld0JaHu6oo) instead of buying again. ## Run several InsightFaceSwap accounts Each useapi.net subscription connects 3 InsightFaceSwap Discord accounts, each with its own channel and daily credits, so free accounts add up too. Each channel runs one command at a time, which takes about 3 to 10 seconds. One-step swaps and background changes don't need `channel`: they go to a random connected channel with credits left. Other commands name the `channel` once you connect more than one account. An account out of credits answers `412`, and a busy one `429`, so wait 10 to 30 seconds and send it again. [GET account](/docs/api-faceswap-v1/get-faceswap-account) lists your connected accounts. Every command can post its result to your webhook with `replyUrl`, or you poll [GET jobs/?jobid=](/docs/api-faceswap-v1/get-faceswap-jobid). [How useapi.net works](/docs/how-it-works) has tips for keeping your accounts healthy. ## Questions ### Is there an InsightFaceSwap API? Through useapi.net, yes. The useapi.net InsightFaceSwap API sends the bot's [/swapid](/docs/api-faceswap-v1/post-faceswap-swapid), [/picsi](/docs/api-faceswap-v1/post-faceswap-picsi), [/headshot](/docs/api-faceswap-v1/post-faceswap-headshot) and [/changebg](/docs/api-faceswap-v1/post-faceswap-changebg) commands over REST and returns the results as JSON or to your webhook. Picsi.Ai sells no API, only the Discord bot, its web studio and its apps (as of October 2026), so calling InsightFaceSwap from code runs through useapi.net. ### How much does the InsightFaceSwap API cost? Through useapi.net, it runs on your InsightFaceSwap membership, and the free plan works with 10 credits a day. Basic at $9.99 a month raises that to 200 credits a day and adds GIF swaps, multi-face swaps and the paid modes (as of October 2026). The [plan table](#pricing) shows what each tier adds. ### Do I need an InsightFaceSwap API key? Through useapi.net, one [API token](/docs/start-here/setup-useapi) is all the key you need. Invite the bot to a private channel on your own Discord server, then save your Discord token, server and channel with [POST account/`channel`](/docs/api-faceswap-v1/post-faceswap-account-channel). [Setup InsightFaceSwap](/docs/start-here/setup-faceswap) walks through it in about 3 minutes, with a separate Discord account kept for the API. [Setup InsightFaceSwap](/docs/start-here/setup-faceswap) [LLM-friendly API spec](https://useapi.net/assets/aibot/api-faceswap-v1.txt) Feed this to your LLM to build integrations [Claude Code skill](/llm-tools) A drop-in useapi.net skill for Claude Code, and a rule for Cursor [Postman collection](https://www.postman.com/useapinet/useapi-net/collection/29112081-9ac29d7b-9ca5-42c9-9d86-b9e29a16df56) (January 20, 2026) [Setup multiple accounts](/docs/api-faceswap-v1/setup-multiple-faceswap-accounts) Connect several InsightFaceSwap Discord accounts and spread jobs across them Articles: * [How to Face Swap & Animate AI Images via API](/docs/articles/imagine-faceswap-animate) Official documentation links: - [Picsi.Ai Discord bot guide](https://www.picsi.ai/en/docs/discord-bot) - [Discord support channel](https://discord.com/channels/1095014106576212101/1128550062683865178) - [Patreon support channel](https://www.patreon.com/picsi/posts) - [YouTube channel](https://www.youtube.com/@PicsiAi) Developer Community: * Discord Server * Telegram Channel === URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-account-channel === Document URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-account-channel --- layout: default title: DEL faceswap/account/`channel` description: "Delete a configured InsightFaceSwap Discord account by channel via DEL faceswap/account/channel in the useapi.net InsightFaceSwap API v1." parent: InsightFaceSwap API nav_order: 400 --- ## Delete InsightFaceSwap account --- > **https://api.useapi.net/v1/faceswap/account/`channel`** The `channel` value should correspond to an account configured previously via a [POST](/docs/api-faceswap-v1/post-faceswap-account-channel) request. ##### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Responses **204** **204 No Content** **401** **401 Unauthorized** ```json { "error": "Unauthorized", "code": 401 } ``` **404** **404 Not Found** ##### Model ```typescript { // TypeScript, all fields are optional error: string, errorDetails: string, code: number } ``` ##### Examples **Curl** ``` bash curl -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer …" \ -X DELETE https://api.useapi.net/v1/faceswap/account/ ``` **JavaScript** ``` javascript const channel = "Previously configured channel id"; const apiUrl = `https://api.useapi.net/v1/faceswap/account/${channnel}`; const token = "API token"; const data = { method: 'DELETE', headers: { 'Authorization': `Bearer ${token}`, 'Content-Type': 'application/json' } }; const response = await fetch(apiUrl, data); const result = await response.json(); console.log("response", {response, result}); ``` **Python** ``` python import requests channel = "Previously configured channel id" apiUrl = f"https://api.useapi.net/v1/faceswap/account/{channel}" token = "API token" headers = { "Content-Type": "application/json", "Authorization" : f"Bearer {token}" } response = requests.delete(apiUrl, headers=headers) print(response, response.json()) ``` === URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-delid === Document URL: https://useapi.net/docs/api-faceswap-v1/del-faceswap-delid --- layout: default title: DEL faceswap/delid description: "Delete a saved face ID by name via DEL faceswap/delid in the useapi.net InsightFaceSwap API v1 — wraps the /delid Discord command with optional replyUrl callback." parent: InsightFaceSwap API nav_order: 1100 --- ## InsightFaceSwap [/delid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delid-name) command --- Use this endpoint to submit the InsightFaceSwap [/delid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delid-name) command to your [InsightFaceSwap Discord channel](/docs/start-here/setup-faceswap). The result will be returned in the response body and can also be sent as a callback to an optional [`replyUrl`](#request-body). This is a blocking call, you will **not** be able to make another call to the same InsightFaceSwap Discord channel until the current call is completed. The average execution time is approximately 3 to 10 seconds. If you expect high load and need to make multiple concurrent calls, please consider setting up [multiple InsightFaceSwap accounts](/docs/api-faceswap-v1/post-faceswap-account-channel). It is **important** not to use the InsightFaceSwap account setup for API access for any purposes other than its intended use, such as executing `/delid` or any other InsightFaceSwap commands _manually_ or in conjunction with _any other_ automation tools. The useapi.net API internally tracks the usage of the InsightFaceSwap account, including the number of currently active executions. Using it for other activities may cause API to function incorrectly. > **https://api.useapi.net/v1/faceswap/delid** ##### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: multipart/form-data ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Request Body ```json { "channel": "Discord channel id", "idname": "idname param", } ``` - `channel` is optional when only one [faceswap/account](/docs/api-faceswap-v1/get-faceswap-account) configured. However, if you have multiple accounts configured, this parameter becomes **required**. - `idname` is **required**, please refer to InsightFaceSwap [/delid](https://github.com/deepinsight/insightface/blob/master/web-demos/swapping_discord/README.md#delid-name) for details. - `replyUrl` is optional, if not provided value from [useapi.net account](/docs/account-management/get-account) will be used. Place here your callback URL. API will call the provided `replyUrl` once job completed or failed. Maximum length 1024 characters. We recommend using sites like [webhook.site](https://webhook.site) to test callback URL functionality. - `replyRef` is optional, place here your reference id which will be stored and returned along with this job response / result. Maximum length 1024 characters. ##### Responses **200** **200 OK** Field `content` contains message generated by InsightFaceSwap. ```json { "jobid": "", "verb": "faceswap-delid", "status": "completed", "idname": "me", "created": "2023-09-09T02:04:49.667Z", "updated": "2023-09-09T02:04:53.490Z", "discord": "", "server": "", "channel": "", "replyUrl": "https://webhook.site/abc", "replyRef": "", "messageId": "", "content": "idname me deleted", "timestamp": "2023-09-09T02:04:51.926000+00:00", "code": 200 } ``` **400** **400 Bad Request** ```json { "error": "Required param idname is missing or empty" "Optional param replyRef is too long" "Optional param replyUrl is too long" "Required param channel is missing or empty" "Configuration not found for channel , to create POST v1/faceswap/account/" "code": 400 } ``` **401** **401 Unauthorized** ```json { "error": "Unauthorized", "code": 401 } ``` **402** **402 Payment Required** ```json { "error": "Account has no subscription or subscription expired", "code": 402 } ``` **429** **429 Too Many Requests** Wait in a loop for **at least** 10..30 seconds and retry again. There are two possible cases for API response 429. 1. API query is full and can not accept new [faceswap/delid](#insightfaceswap-delid-command) requests. ```json { "error": "Unable to lock Discord after attempts", "code": 429 } ``` 2. The API received an HTTP status 429 from the Discord API when it attempted to POST to the `/interactions` endpoint. Under normal circumstances, this should be a rare occurrence because the API is designed to strictly adhere to Discord rate limits. However, in certain scenarios, Discord may still issue a 429 response. ```json { "error": "Discord /interactions failed with HTTP status 429", "errorDetails": "{\"global\":true,\"message\":\"You are being rate limited.\",\"retry_after\":10}", "code": 429 } ``` ##### Model ```typescript { // TypeScript, all fields are optional jobid: string, verb: 'faceswap-delid', status: 'completed' | 'failed', idname: string, created: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC updated: string, // YYYY-MM-DDTHH:mm:ss.sssZ, IS0 8601, UTC discord: string, // Provided for debugging purposes only, contains the first 3 and the last 3 characters of the original value server: string, channel: string, replyUrl: string, replyRef: string, messageId: string, content: string, // Contains message generated by InsightFaceSwap timestamp: string, error: string, errorDetails: string, code: number } ``` ##### Examples **Curl** ``` bash curl -H "Accept: application/json" \ -H "Authorization: Bearer …" \ -X DELETE https://api.useapi.net/v1/faceswap/delid \ -F "channel=" \ -F "idname=" ``` **JavaScript** ``` javascript const main = async () => { const apiUrl = "https://api.useapi.net/v1/faceswap/delid"; const token = "API token"; const channel = "Discord channel"; const idname = "idname"; const data = { method: 'DELETE', headers: { 'Authorization': `Bearer ${token}` } }; const formData = new FormData(); formData.append("channel", channel); formData.append("idname", idname); data.body = formData; const response = await fetch(apiUrl, data); const result = await response.json(); console.log("response", { response, result }); }; main() ``` **Python** ``` python import requests api_url = "https://api.useapi.net/v1/faceswap/delid" token = "API token" channel = "Discord channel" idname = "idname" headers = { 'Authorization': f'Bearer {token}' } files = { 'channel': (None, channel), 'idname': (None, idname) } response = requests.delete(api_url, headers=headers, files=files) print(response, response.json()) ``` === URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account-channel === Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account-channel --- layout: default title: GET faceswap/account/`channel` description: "Retrieve the InsightFaceSwap Discord account config for a specific channel via GET faceswap/account/channel in the useapi.net InsightFaceSwap API v1." parent: InsightFaceSwap API nav_order: 200 --- ## Retrieve InsightFaceSwap configuration for `channel` --- > **https://api.useapi.net/v1/faceswap/account/`channel`** The `channel` value should correspond to an account configured previously via a [POST](/docs/api-faceswap-v1/post-faceswap-account-channel) request. ##### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Responses **200** **200 OK** ```json { "server": "Discord server id", "channel": "Discord channel id", "discord": "Discord token", "credits": { "timestamp": "2024-02-01T02:05:24.991000+00:00", "total": 50, "used": 18 } } ``` **401** **401 Unauthorized** ```json { "error": "Unauthorized", "code": 401 } ``` **404** **404 Not Found** Configuration not found. To create configuration use [faceswap/account/`channel`](/docs/api-faceswap-v1/post-faceswap-account-channel). ##### Model ```typescript { // TypeScript, all fields are optional discord: string, server: string, channel: string, credits: { timestamp: string, total: number, used: number } } ``` ##### Examples **Curl** ``` bash curl https://api.useapi.net/v1/faceswap/account/ \ -H "Accept: application/json" \ -H "Authorization: Bearer …" ``` **JavaScript** ``` javascript const token = "API token"; const channel = "Previously configured channel id"; const apiUrl = `https://api.useapi.net/v1/faceswap/account/${channel}`; const response = await fetch(apiUrl, { headers: { "Authorization": `Bearer ${token}`, }, }); const result = await response.json(); console.log("response", {response, result}); ``` **Python** ``` python import requests token = "API token" channel = "Previously configured channel id" apiUrl = f"https://api.useapi.net/v1/faceswap/account/{channel}" headers = { "Content-Type": "application/json", "Authorization" : f"Bearer {token}" } response = requests.get(apiUrl, headers=headers) print(response, response.json()) ``` === URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account === Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-account --- layout: default title: GET faceswap/account description: "List all configured InsightFaceSwap Discord accounts via GET faceswap/account in the useapi.net InsightFaceSwap API v1 — supports multi-account load balancing." parent: InsightFaceSwap API nav_order: 100 --- ## Retrieve InsightFaceSwap accounts information --- Before you start using the API, you **must** [configure](/docs/start-here/setup-faceswap) at least one InsightFaceSwap Discord account. You may specify multiple InsightFaceSwap accounts, the API will automatically perform load balancing by randomly selecting an account with available credits before making calls to InsightFaceSwap Discord bot. This endpoint retrieves the complete list of configured accounts for InsightFaceSwap. > **https://api.useapi.net/v1/faceswap/account** ##### Request Headers ``` yaml Authorization: Bearer {API token} Content-Type: application/json ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Responses **200** **200 OK** ```json { "Discord channel A": { "server": "Discord server A", "channel": "Discord channel A", "discord": "Discord token A", "credits": { "timestamp": "2024-02-01T02:05:24.991000+00:00", "total": 50, "used": 18 }, }, "Discord channel B": { "server": "Discord server B", "channel": "Discord channel B", "discord": "Discord token B" }, "Discord channel N": { "server": "Discord server N", "channel": "Discord channel N", "discord": "Discord token N", "credits": { "timestamp": "2024-02-01T03:17:48.159000+00:00", "total": 200, "used": 115 } } } ``` **401** **401 Unauthorized** ```json { "error": "Unauthorized", "code": 401 } ``` **404** **404 Not Found** Configuration not found. To create configuration use [faceswap/account/`channel`](/docs/api-faceswap-v1/post-faceswap-account-channel). ##### Model ```typescript { // TypeScript, all fields are optional [channel: string]: { discord: string, server: string, channel: string, credits: { timestamp: string, total: number, used: number } } } ``` ##### Examples **Curl** ``` bash curl https://api.useapi.net/v1/faceswap/account \ -H "Accept: application/json" \ -H "Authorization: Bearer …" ``` **JavaScript** ``` javascript const token = "API token"; const apiUrl = "https://api.useapi.net/v1/faceswap/account"; const response = await fetch(apiUrl, { headers: { "Authorization": `Bearer ${token}`, }, }); const result = await response.json(); console.log("response", {response, result}); ``` **Python** ``` python import requests token = "API token" apiUrl = "https://api.useapi.net/v1/faceswap/account" headers = { "Content-Type": "application/json", "Authorization" : f"Bearer {token}" } response = requests.get(apiUrl, headers=headers) print(response, response.json()) ``` === URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobid === Document URL: https://useapi.net/docs/api-faceswap-v1/get-faceswap-jobid --- layout: default title: GET faceswap/jobs/?jobid=`jobid` description: "Poll the status and results of any InsightFaceSwap job by jobid via GET faceswap/jobs in the useapi.net InsightFaceSwap API v1 — supports all job types (headshot, changebg, picsi, swapid, saveid, and more)." parent: InsightFaceSwap API nav_order: 1300 --- ## Retrieve InsightFaceSwap job status and results --- Use this endpoint to retrieve status and results of - [faceswap/headshot](/docs/api-faceswap-v1/post-faceswap-headshot) - [faceswap/changebg](/docs/api-faceswap-v1/post-faceswap-changebg) - [faceswap/picsi](/docs/api-faceswap-v1/post-faceswap-picsi) with initial jobs status returned `started` If you specified optional parameter [`replyUrl`](/docs/api-faceswap-v1/post-faceswap-headshot#request-body) you technically do not need to use this endpoint to retrieve results since API will call provided `replyUrl` once job generation completed. **Important** API periodically polls (checks) Discord every 15 to 60 seconds (depending on the load) and updates all currently executed jobs statuses and results. Polling interval is used for safety reasons, aiming to prevent any potential issues with Discord and InsightFaceSwap, such as bans or excessive requests. Jobs lifespan guaranteed to be at least 31 days, after that they will be expired and may be recycled. > **https://api.useapi.net/v1/faceswap/jobs/?jobid=`jobid`** ##### Request Headers ``` yaml Authorization: Bearer {API token} ``` - `API token` is **required**, see [Setup useapi.net](/docs/start-here/setup-useapi) for details. ##### Query Parameter `jobid` is **required**, use value returned by - [faceswap/headshot](/docs/api-faceswap-v1/post-faceswap-headshot) - [faceswap/changebg](/docs/api-faceswap-v1/post-faceswap-changebg) - [faceswap/picsi](/docs/api-faceswap-v1/post-faceswap-picsi) with initial jobs status returned `started` ##### Responses **200** **200 OK** If field `status` value is *created*, *started* or *progress* wait in a loop for **at least** 10..30 seconds and retry again. When completed retrieve generated images or video from `attachments` array. Field `content` contains message generated by InsightFaceSwap reflecting current generation parameters and progress. Optional array `embeds` contains additional information. ```json { "jobid": "", "verb": "faceswap-headshot", "status": "completed", "created": "2023-09-09T02:04:49.667Z", "updated": "2023-09-09T02:19:20.256Z", "prompt": "me, a mad king with an evil smile, wearing medieval royal blue attire and a crown. --no green --square", "discord": "", "server": "", "channel": "", "messageId": "", "content": "<@Discord user id> Picsi.Ai Headshot Job Submitted [jobid: 8a1f574fdbf79e8cd57e070476d9d5f3] [credits: 4] [prompt: 'a mad king with an evil smile, wearing medieval royal blue attire and a crown. --no green --square'] [time: