Add VIDEO-editing slots to a bundle

Add VIDEO-editing slots to a bundle. Buys video-editing slots — professional editing of a video by the account manager — and debits credits immediately (see `video_edit` in getCreditCosts). Non-refundable, with no cancellation path; confirm the exact cost with the user before calling. `edits_quantity` cannot exceed the bundle's `videos_quantity`, one video consumes at most one slot, and a slot is only consumed when that video carries `editing_instructions`. This has nothing to do with editing an account profile — use createAccountEditRequest for that.

JSON request body.

How many slots to buy. Charged immediately at the getCreditCosts rate and never refundable — there is no cancellation path for this purchase.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Bundle ID.

Optional Idempotency-Key header for safe retries.

Add video slots to a bundle

Add video slots to a bundle. Buys additional video slots on an existing bundle and debits credits immediately (see `video_upload` in getCreditCosts). The slots are non-refundable and there is no cancellation path for this purchase — confirm the exact cost with the user before calling. Configure the new positions with configureBundleVideo, then publish them.

JSON request body.

Bundle ID.

Approve a manually confirmed comment task

Approve a manually confirmed comment task. Approves and finalizes an owned manually_confirmed task. Execution is blocked while TokPortal Coverage is inactive; inspect MANAGED_ACCOUNT_TASK_BLOCKED and reactivate a recoverable account first.

Comment task ID.

Configure video slots in bulk

Configure video slots in bulk. Configures many video slots in one call after a single account-level Coverage preflight. Partial success: this call returns HTTP 200 even when some or all rows are rejected. Read `configured`, `results` and `errors[]` and never infer success from the status code — rows breaking the 3-videos-per-day cap or the minimum lead time fail individually while the rest succeed, and the paid options they carry are only charged for the rows that succeeded. An `auto_publish` failure never fails the request; inspect `auto_publish.blockers`. TOP-LEVEL ONLY on this endpoint: one publish attempt per call, applying to every video in it. auto_publish inside videos[] is rejected with a hint telling you to move it out — it is per-video only on the single-slot PUT /bundles/{id}/videos/{position}. Each row's `target_publish_date` is the first day of a 2-day window whose end is derived (that day + 1); `target_publish_end_date` is refused on this endpoint. Publish-time date guard: any slot whose target date has already reached today or the past is moved forward to the earliest allowed day (today+1 with a delivered or existing account, today+3 while the account is still being created, in UTC), respecting the 3-videos-per-day-per-bundle cap — an overflowing day spills to the next one. Slots still in the future are NOT moved. This never fails the publish. When something moved, the response carries `adjusted_videos` — one entry per moved slot, `{video_id, position, previous_date, new_date}` — and `adjusted_videos_note`. Read them back instead of assuming the schedule you sent survived. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

JSON request body.

Publish the bundle in the same call once at least one row has been configured. TOP-LEVEL ONLY on this endpoint: one publish attempt per call, applying to every video in it. auto_publish inside videos[] is rejected with a hint telling you to move it out — it is per-video only on the single-slot PUT /bundles/{id}/videos/{position}. A publish failure never fails the configuration: read auto_publish.published and auto_publish.blockers. If publishing moved stale target dates forward, auto_publish.adjusted_videos lists {video_id, position, previous_date, new_date}.

Slots to configure. Each entry is validated and applied independently: the call answers HTTP 200 even when some or all entries fail, so read configured, results and errors[] rather than the status code.

AI content notice (free). If true, the manager will enable the platform's AI-generated content label when posting.

Required for video_type 'carousel'. Use the storage_path returned by the image upload tools, NOT public_url (public_url is only correct for videos).

Required for 'video' and 'carousel'. Stories have no description.

Disclose as ad (free). If true, the manager will enable branded-content/paid-partnership disclosure (or add #ad) when posting.

Instagram bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields.

REQUIRED for every Instagram slot that is not a story (MISSING_FIELD otherwise). Instagram bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields.

Instant repost as story (paid, +1 credit charged once when first enabled, no refunds). Right after posting, the manager reposts this video as a story and provides a screenshot proof. Only for video_type 'video' on TikTok/Instagram bundles. Omit to keep the current value.

1-based slot position on the bundle. Required on every entry.

Story image (TikTok/Instagram). Provide exactly one of video_url or story_image_url for a story.

Optional. Make the story repost an existing post from the SAME platform (TikTok story → tiktok.com, Instagram story → instagram.com). Costs +1 credit.

YYYY-MM-DD. This is the FIRST day of a 2-day publishing window, not a fixed date: the manager may post on this day or the next. The end day is derived — always this day + 1 — and cannot be chosen here; sending target_publish_end_date is rejected. Every video response returns the resulting window as target_publish_start_date / target_publish_end_date (target_publish_date is an alias of the start). Max 3 videos per day per bundle — a 4th video on the same day is rejected with VIDEOS_PER_DAY_EXCEEDED. Minimum lead time, in UTC: the earliest allowed date is today+3 days while the bundle is still having its account created, and today+1 once that account is delivered or when the bundle runs on an existing account; an earlier date is rejected with INVALID_DATE carrying min_days_ahead and earliest_allowed (YYYY-MM-DD).

TikTok bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields. REQUIRED for a TikTok carousel (MISSING_FIELD otherwise), optional for a TikTok video.

Required for video_type 'video'. Use the public_url returned by uploadVideo / uploadVideoDirect (videos use public_url; images use storage_path).

Playback volume of the added sound, as a percentage; 100 leaves it unchanged. PAID OPTION: setting either volume field costs +1 credit per video, charged once when it is first set and never refunded.

Playback volume of the clip's own audio, as a percentage; 100 leaves it unchanged. PAID OPTION: setting either volume field costs +1 credit per video, charged once when it is first set and never refunded.

YouTube bundles only. Elsewhere it is accepted but not stored, and comes back in the response's ignored_fields.

YouTube bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields. YouTube bundles cannot currently be created (YOUTUBE_DELAYED).

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Bundle ID.

Optional Idempotency-Key header for safe retries.

Check analytics refresh availability

Check analytics refresh availability. Reports whether a manual analytics refresh is currently allowed and when the next one will be. Call it before refreshAccountAnalytics / refreshAnalyticsAccount to avoid a 429 cooldown (6 h for connected accounts, 24 h for the public fallback).

Saved account ID.

Pause TokPortal Coverage

Pause TokPortal Coverage. Immediately blocks new and ongoing TokPortal work for the account. Payments are not refunded. If a paid or included current period remains, reactivation is free until its original end. Otherwise it costs exactly the unpaid 30-day periods at the rate returned by the Coverage status endpoint.

Saved account ID.

Configure bundle account profile

Configure bundle account profile. Sets the profile of an account that has NOT been delivered yet: username, visible name, biography, profile picture, and link-in-bio on Instagram bundles. Only valid while the bundle is `pending_setup` or `configured` — unpublish first to edit after publishing, and use createAccountEditRequest for an account that is already delivered. This is a full replacement: any field you omit is written back as null, so re-send the whole profile when you change one part of it. `link_in_bio` is stored on Instagram bundles only. On any other platform it is accepted but not stored, and the response says so explicitly through `_warnings` while echoing `link_in_bio: null` — read both back. For backward compatibility this endpoint also accepts the exact purchased advanced_warming_terms list, but PUT /bundles/{id}/warming-terms is the recommended one-shot deferred-target endpoint because it remains available at any account status. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription. A new account that has not produced a saved account yet remains configurable before delivery.

JSON request body.

Backward-compatible account-configuration field for an Advanced Niche Warming purchase made with advanced_warming_terms_count. Prefer PUT /bundles/{id}/warming-terms, which remains available at any account status. Must contain exactly the purchased number of targets and can only be set once.

Profile biography. The enforced limit is platform-dependent: 120 characters on Instagram, 80 on every other platform.

Instagram bundles only. On TikTok and every other platform it is accepted, stored as null, and reported back in the response's _warnings array — read _warnings, not just the 200.

Legacy — kept only for accounts being re-created after a refund; use Advanced Niche Warming (wants_advanced_warming).

Public image URL, or the storage_path returned by uploadImage / uploadImageDirect / uploadImageFromUrl. Use storage_path, not public_url — public_url is only correct for videos.

Requested username. Cannot end with a dot.

Public display name. Avoid reusing the same wording across accounts of one batch: near-identical profiles raise the risk of mass-ban detection.

Bundle ID.

Configure a video slot

Configure a video slot. Configures one slot as a video, carousel, or story, and schedules it. A story (TikTok/Instagram only) is a single video OR a single image (provide exactly one of video_url or story_image_url), has no description, and is verified by an account-manager screenshot. Platform-specific fields are only stored on their own platform: `tiktok_sound_url` on TikTok, every `instagram_*` field on Instagram, every `youtube_*` field on YouTube. A field belonging to another platform is accepted and not stored, but it is no longer discarded in silence: the response lists those names in `ignored_fields`, next to `platform`, with an `ignored_fields_note` explaining why. Check `ignored_fields` on every 200 — an empty or absent list is the only proof that everything you sent landed. Some options are paid and charged the first time they are set, never refunded: story_repost_url, instant_repost_as_story, and setting either volume field. Scheduling: `target_publish_date` is the FIRST day of a 2-day publishing window, never a fixed date — the end day is derived as that day + 1 and cannot be chosen, so `target_publish_end_date` is refused here with a hint pointing at PATCH. The window that was actually stored comes back as `target_publish_start_date` / `target_publish_end_date`. `auto_publish` is per-video HERE and top-level-only on the batch endpoint. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

JSON request body.

AI content notice (free). If true, the manager will enable the platform's AI-generated content label when posting.

PER-VIDEO on this single-slot endpoint: it publishes this one slot in the same call. On the batch endpoint the same flag exists only at the ROOT of the body and covers every video in the call — it is not accepted inside videos[]. A publish failure never fails the configuration: the response carries auto_publish.published and auto_publish.blockers, so read them instead of assuming the slot went live. If publishing moved a stale target date forward, auto_publish.adjusted_videos lists {video_id, position, previous_date, new_date} — read it back rather than assuming the schedule you sent survived.

Required for video_type 'carousel'. Use the storage_path returned by the image upload tools, NOT public_url (public_url is only correct for videos).

Required for 'video' and 'carousel'. Stories have no description.

Disclose as ad (free). If true, the manager will enable branded-content/paid-partnership disclosure (or add #ad) when posting.

Instagram bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields.

REQUIRED for every Instagram slot that is not a story (MISSING_FIELD otherwise). Instagram bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields.

Instant repost as story (paid, +1 credit charged once when first enabled, no refunds). Right after posting, the manager reposts this video as a story and provides a screenshot proof. Only for video_type 'video' on TikTok/Instagram bundles. Omit to keep the current value.

Story image (TikTok/Instagram). Provide exactly one of video_url or story_image_url for a story.

Optional. Make the story repost an existing post from the SAME platform (TikTok story → tiktok.com, Instagram story → instagram.com). Costs +1 credit.

TikTok bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields. REQUIRED for a TikTok carousel (MISSING_FIELD otherwise), optional for a TikTok video.

Required for video_type 'video'. Use the public_url returned by uploadVideo / uploadVideoDirect (videos use public_url; images use storage_path).

Playback volume of the added sound, as a percentage; 100 leaves it unchanged. PAID OPTION: setting either volume field costs +1 credit per video, charged once when it is first set and never refunded.

Playback volume of the clip's own audio, as a percentage; 100 leaves it unchanged. PAID OPTION: setting either volume field costs +1 credit per video, charged once when it is first set and never refunded.

YouTube bundles only. Elsewhere it is accepted but not stored, and comes back in the response's ignored_fields.

YouTube bundles only. On any other platform it is accepted but not stored, and comes back in the response's ignored_fields. YouTube bundles cannot currently be created (YOUTUBE_DELAYED).

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Bundle ID.

Optional Idempotency-Key header for safe retries.

1-based video slot position.

Configure the niche targets of a count-only Advanced Niche Warming purchase

Configure the niche targets of a count-only Advanced Niche Warming purchase. Only for a bundle created with advanced_warming_terms_count (deferred targets). To warm an account that is already delivered, use rewarmAccount instead; this endpoint answers 404 WARMING_SESSION_NOT_FOUND when there is no count-only purchase to configure. Must provide EXACTLY the purchased number of targets. One-shot: once configured the targets cannot be changed. Unlike PUT /bundles/{id}/account, this stays available at any account status after the manager accepted the mission or submitted the account, in which case the warming session starts immediately. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription. A new account that has not produced a saved account yet remains configurable before delivery.

JSON request body.

The niche targets for a count-only Advanced Niche Warming purchase. Must contain EXACTLY the purchased number of targets (advanced_warming_terms_count at creation), each 2-50 characters. One-shot: once set they cannot be changed. This works at any account status, and the warming session starts immediately when the manager already holds the order.

Bundle ID.

Request profile edits for a delivered account

Request profile edits for a delivered account. Requests profile changes on an account that is already delivered and debits 8 credits. This is the ONLY way to change a delivered account's public username, visible name, biography, picture or link-in-bio: addEditSlots is unrelated (it buys video-editing slots) and configureBundleAccount only works before the account is delivered. Besides the username and visible name, supply at least one of requested_biography, requested_profile_picture_url or requested_link_in_bio — a request that changes nothing else is rejected. Only one request can be open per account at a time (409 otherwise); check getAccountEditRequest first. Active TokPortal Coverage and a routable active account manager are required. TokPortal uses the account's current active manager, then its still-active manager relationship, then eligible non-cancelled order history. Completed bundles remain eligible without a delivery-age limit; cancelled orders are never restored. Assignment, debit, and task creation are atomic, so an unavailable manager never costs credits. The task appears directly in that manager's calendar.

JSON request body.

Requested biography. The enforced limit is platform-dependent: 150 characters on Instagram, 80 on every other platform.

Public image URL, or the storage_path returned by the image upload tools (not public_url).

Requested username. Always required, even when it is unchanged.

Requested display name. Always required, even when it is unchanged.

Saved account ID.

Create analytics web report

Create analytics web report. Creates a shareable Analytics v2 web report and returns its bearer-like access token and URL. The body is validated before anything is rendered, so a malformed request fails with INVALID_FIELD instead of quietly producing a wrong report for your end client. `from` and `to` are calendar dates in YYYY-MM-DD; a full ISO timestamp is accepted and truncated to its date, and anything else is refused rather than treated as "no filter" (which used to widen the report to the account's entire history). An inverted window (`from` after `to`) is refused too. `template` is a published enum — executive, agency, creator, minimal, growth, board — and an unknown value is refused instead of becoming executive. `brandAccent` must be #rrggbb (#rgb is expanded); named colours, rgb() and 8-digit hex are refused instead of being replaced by the TokPortal default. White-labelling still depends on entitlement: `brandName` and `brandAccent` only apply on the full analytics tier with a Farmer plan, and are otherwise reset. The response carries `applied` — the template, brand name, brand accent and the exact date window the report covers — plus `canBrand`, so read those back instead of inspecting the rendered report. Do not send Idempotency-Key. The successful response contains a secret and is never stored in the replay ledger. A request with the header is rejected with IDEMPOTENCY_KEY_NOT_ALLOWED_FOR_SENSITIVE_RESPONSE (400) before any ledger claim or operation execution.

JSON request body.

White-label accent colour, #rrggbb (a #rgb short form is expanded). Named colours, rgb() and 8-digit hex are rejected with INVALID_FIELD instead of silently becoming the TokPortal default. Like brandName it only applies on a Farmer plan at the full tier; read applied.brand_accent back.

White-label brand name (80 characters, the real stored limit). Applied only on the full analytics tier with a Farmer plan; on every other plan it is reset to TokPortal, and the response says so through applied.brand_name and canBrand — check them before promising a client a white-labelled document.

Inclusive start date, YYYY-MM-DD. A full ISO timestamp is accepted and truncated to its date; anything else is rejected with INVALID_FIELD rather than silently treated as no filter (which used to widen the report to the account's entire history). Must not be after `to`. The window actually applied comes back as applied.filters.from.

Free-text filter. 120 characters, the real stored limit.

Report layout. Any other value is rejected with INVALID_FIELD rather than silently becoming executive. The applied template is echoed as applied.template on the JSON response and as X-TokPortal-Report-Template on the HTML export.

Report title. 120 characters, the real stored limit.

Inclusive end date, YYYY-MM-DD, same parsing as `from`. Echoed as applied.filters.to.

Create a bundle

Create a bundle. Creates and pays an account-only, account-and-videos, or videos-only bundle in one atomic creation checkout. Credits are debited immediately on a successful POST, not when the bundle is published, and THERE IS NO CANCELLATION OR REFUND PATH — read getCreditCosts and getCreditBalance and confirm the total with the user before calling. One bundle produces exactly one account; order several accounts with createBundlesBulk. TikTok and Instagram only: a YouTube bundle is rejected with YOUTUBE_DELAYED even though getCreditCosts lists a YouTube price. Advanced Niche Warming requires wants_advanced_warming: true ALONGSIDE advanced_warming_terms or advanced_warming_terms_count; targets sent without the flag are refused with ADVANCED_WARMING_FLAG_REQUIRED, never charged and dropped. Send the term list or the count, not two quantities that disagree (ADVANCED_WARMING_COUNT_MISMATCH), and send distinct terms — anything removed by cleanup fails the call with ADVANCED_WARMING_TERMS_REJECTED rather than silently reducing what you receive and pay for. Credit cost is calculated server-side from the workspace cohort and any contract_bundle_allowance returned by getCreditCosts. A qualifying allowance slot is consumed in the same transaction as the credit debit; failed requests consume nothing. The exact new-customer and saved-account cutoff is the immutable production PRE-migration instant returned by getCreditCosts. A real TikTok or Instagram saved account created on or after that cutoff receives its first 30 days of TokPortal Coverage included unless the creation response marks it contractually exempt, and Coverage then recurs every 30 days per account at the managed_account_subscription price. For Advanced Niche Warming, pass advanced_warming_terms now, or buy a target count with advanced_warming_terms_count at the effective workspace rate and configure the targets later via PUT /bundles/{id}/warming-terms — one or the other, always with wants_advanced_warming: true. Set the targets BEFORE publishing: publishBundle refuses a bundle whose warming has no targets (ADVANCED_WARMING_NOT_CONFIGURED), and a purchase left unconfigured is not refunded. The bundle is created in pending_setup and still needs configureBundleAccount and publishBundle. Delivered videos are approved automatically unless you send auto_finalize_videos: false — the response echoes the settlement mode as review_mode ('auto' or 'manual'), plus a one-off review_mode_notice when you left the choice to the default. external_ref is a client correlation and duplicate-detection aid, not a retry mechanism; only Idempotency-Key provides exact request replay.

JSON request body.

The single delivered account a videos_only bundle posts to. Required for videos_only bundles, forbidden otherwise. One bundle targets exactly one account — to post across several accounts, create one bundle per account.

3-30 niche targets (search terms), count a multiple of 3, each 2-50 characters. REQUIRES wants_advanced_warming: true in the same body (ADVANCED_WARMING_FLAG_REQUIRED otherwise). Every term must survive cleanup intact: entries are trimmed and compared case-insensitively, and if any is dropped as a duplicate or for its length the call fails with ADVANCED_WARMING_TERMS_REJECTED listing what was dropped — TokPortal will not quietly deliver, or bill, fewer targets than you asked for. Send this list OR advanced_warming_terms_count, not both: a count that disagrees with the list length fails with ADVANCED_WARMING_COUNT_MISMATCH.

Number of niche targets to purchase (3-30, multiples of 3; standard rate 5 credits each; GET /credit-costs returns the effective rate); the alternative to advanced_warming_terms when the targets are not decided yet. REQUIRES wants_advanced_warming: true in the same body (ADVANCED_WARMING_FLAG_REQUIRED otherwise). Do not send it alongside advanced_warming_terms unless it equals that list's length — a disagreement fails with ADVANCED_WARMING_COUNT_MISMATCH instead of one quantity silently winning. Configure the targets later via PUT /bundles/{id}/warming-terms — but BEFORE publishing: publishBundle refuses a bundle whose warming has no targets (ADVANCED_WARMING_NOT_CONFIGURED), because a warming that can never start also stops the bundle from ever completing. A purchase left unconfigured is not refunded.

Defaults to true: delivered videos are approved automatically and count as final. Set false to hold each delivered video for your manual review (approve or request corrections). Changeable later via updateBundle.

Country code exactly as returned by listCountries. Most are ISO-3166-1 alpha-2 (FR, DE, BR), but two are not: the United States is "USA" and the United Kingdom is "UK". The aliases "US" and "GB" are accepted and resolved to those. A full country name such as "United States" is rejected. Required unless bundle_type is videos_only.

Optional client correlation reference and duplicate-detection aid for new-account bundles. Reusing it can return DUPLICATE_ACCOUNT_BUNDLE. It does not provide request retry or response replay; use Idempotency-Key for that.

Legacy — kept only for accounts being re-created after a refund; use Advanced Niche Warming (wants_advanced_warming).

TikTok or Instagram only. YouTube is priced in getCreditCosts but cannot be ordered: a YouTube bundle is rejected with YOUTUBE_DELAYED.

Advanced Niche Warming, the warming product: niche-target (search-term) based warming with recorded proof and a data report. MANDATORY whenever you send advanced_warming_terms or advanced_warming_terms_count — TokPortal never infers it, and sending targets without it is rejected with ADVANCED_WARMING_FLAG_REQUIRED rather than charged and dropped. The standard rate is 5 credits per target (per target, never per day); GET /credit-costs returns the effective rate. TikTok and Instagram only. Provide advanced_warming_terms now, or advanced_warming_terms_count to configure the targets later.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Optional Idempotency-Key header for safe retries.

Create bundles in bulk

Create bundles in bulk. Creates and pays several bundles in one atomic creation checkout. Credits are debited immediately on a successful POST, not at publication, and THERE IS NO CANCELLATION OR REFUND PATH — read getCreditCosts and getCreditBalance and confirm the total with the user before calling, because the loss is multiplied by accounts_count and platforms. Each bundle produces exactly one account. Warming targets and credits are charged per account, not per batch. Advanced Niche Warming requires wants_advanced_warming: true ALONGSIDE advanced_warming_terms or advanced_warming_terms_count; targets sent without the flag are refused with ADVANCED_WARMING_FLAG_REQUIRED for the whole batch, never charged and dropped. Send the term list or the count, not two quantities that disagree (ADVANCED_WARMING_COUNT_MISMATCH), and send distinct terms — anything removed by cleanup fails the call with ADVANCED_WARMING_TERMS_REJECTED. The complete batch is checked against rolling workspace capacity and any contract_bundle_allowance returned by getCreditCosts. Qualifying allowance slots are consumed in deterministic bundle-ID order in the same transaction as all debits; if any bundle fails, the entire batch rolls back and consumes nothing, so never split a 429 capacity-cooldown batch into parallel calls. A batch crossing the final allowance slot receives the contract price only for the remaining qualifying bundles. For Advanced Niche Warming, pass advanced_warming_terms, using the same terms for every account, or buy a per-account target count with advanced_warming_terms_count and configure each bundle's targets later via PUT /bundles/{id}/warming-terms — one or the other, always with wants_advanced_warming: true. Every bundle is returned in pending_setup with no username: each one still needs configureBundleAccount and publishBundle before any work starts. Delivered videos are approved automatically for every bundle in the batch unless you send auto_finalize_videos: false — the response echoes review_mode ('auto' or 'manual'), plus a one-off review_mode_notice when you left the choice to the default. external_ref is one optional batch-level reference copied to the resulting bundles, not a unique per-bundle key or a retry mechanism; use returned bundle IDs for identity and Idempotency-Key for exact replay.

JSON request body.

Accounts to create per platform. Each one is a separate bundle with its own account, and every credit below is charged per account.

3-30 niche targets (search terms), count a multiple of 3, each 2-50 characters, applied identically to every account of the batch. REQUIRES wants_advanced_warming: true in the same body (ADVANCED_WARMING_FLAG_REQUIRED otherwise). Every term must survive cleanup intact: entries are trimmed and compared case-insensitively, and if any is dropped as a duplicate or for its length the call fails with ADVANCED_WARMING_TERMS_REJECTED listing what was dropped. Send this list OR advanced_warming_terms_count, not both: a count that disagrees with the list length fails with ADVANCED_WARMING_COUNT_MISMATCH.

Number of niche targets purchased PER ACCOUNT (3-30, multiples of 3; standard rate 5 credits each; GET /credit-costs returns the effective rate); the alternative to advanced_warming_terms when the targets are not decided yet. REQUIRES wants_advanced_warming: true in the same body (ADVANCED_WARMING_FLAG_REQUIRED otherwise). Do not send it alongside advanced_warming_terms unless it equals that list's length — a disagreement fails with ADVANCED_WARMING_COUNT_MISMATCH. Configure each bundle's targets later via PUT /bundles/{id}/warming-terms — but BEFORE publishing: publishBundle refuses a bundle whose warming has no targets (ADVANCED_WARMING_NOT_CONFIGURED). A purchase left unconfigured is not refunded.

Country code exactly as returned by listCountries. Most are ISO-3166-1 alpha-2 (FR, DE, BR), but two are not: the United States is "USA" and the United Kingdom is "UK". The aliases "US" and "GB" are accepted and resolved to those. A full country name such as "United States" is rejected. videos_only_countries is never valid here.

Optional batch-level client reference copied to every bundle created by this call. It is not unique per resulting bundle and is not an idempotency key. Use the returned bundle IDs for per-bundle identity and Idempotency-Key for retry/replay.

TikTok and/or Instagram. accounts_count accounts are created on EACH listed platform, so the batch total is accounts_count x platforms.length. YouTube cannot be ordered (YOUTUBE_DELAYED).

Advanced Niche Warming, the warming product: niche-target (search-term) based warming with recorded proof and a data report. MANDATORY whenever you send advanced_warming_terms or advanced_warming_terms_count — TokPortal never infers it, and sending targets without it is rejected with ADVANCED_WARMING_FLAG_REQUIRED rather than charged and dropped. The standard rate is 5 credits per target (per target, never per day), charged per account; GET /credit-costs returns the effective rate. TikTok and Instagram only. Provide advanced_warming_terms now, or advanced_warming_terms_count to configure the targets later.

Create comment tasks

Create comment tasks. Creates one comment task or a partial-success batch of up to 200. Each accepted task costs 1 credit. The target is any public TikTok or Instagram video, including a third party's — that is the intended use — while the posting account must be one of your own delivered accounts and its platform must match the target's (COMMENT_PLATFORM_MISMATCH otherwise). Deduplicate locally on (saved_account_id, target URL, comment_text): two different Idempotency-Keys carrying the same comment bill twice. The saved account must be client-owned, manager-assigned, and allowed to execute tasks by TokPortal Coverage, unless it is permanently grandfathered. TokPortal locks and revalidates the account and Coverage before the accepted-task debit and all accepted inserts commit in one transaction. Rejected rows are never charged. Read credits_charged instead of calculating it from the request, and read meta.rejected_count and each row's reason rather than inferring success from the 201. Send an Idempotency-Key and reuse the same key, method, path, and body after an uncertain transport result so the completed response is replayed without a second charge.

JSON request body.

Optional comment brief owned by the same client.

Exact text to post. The effective limit is 150 characters for TikTok and 2,200 for Instagram. Deduplicate locally on (saved_account_id, target URL, comment_text): two calls carrying the same comment under different Idempotency-Keys create two tasks and bill twice.

Client-owned saved account that will post the comment. TokPortal Coverage must currently allow tasks, unless the account is permanently grandfathered.

Required when target_type is 'comment'. TikTok comment deep-link (Share comment → Copy link); short or full form.

Target type. 'video' (default) posts a comment under a video; 'comment' replies to a specific comment (TikTok only).

Required when target_type is 'video' (or omitted). Any public TikTok/Instagram video URL, including a third party's — that is the intended use. Its platform must match the posting account's platform (COMMENT_PLATFORM_MISMATCH otherwise).

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Optional Idempotency-Key header for safe retries.

Request an ad code (TikTok Spark Code / Instagram Partner Code) for a finalized video

Request an ad code (TikTok Spark Code / Instagram Partner Code) for a finalized video. Requests an ad code (TikTok Spark Code or Instagram Partner Code) for one finalized video and debits 7 credits, which are not refundable. The platform is resolved from the video itself and cannot be chosen. The video must be finalized on TikTok or Instagram with a live post link. Active TokPortal Coverage and a routable active account manager are required. TokPortal uses the account's current active manager, then its still-active manager relationship, then eligible non-cancelled order history. Completed bundles remain eligible without a delivery-age limit; cancelled orders are never restored. Assignment, debit, and task creation are atomic. Only one open request per video is allowed, so a request made on the wrong video cannot be replaced until it closes. Poll the GET endpoint to retrieve the code once the manager submits it.

JSON request body.

Optional note to your manager (e.g. the campaign this ad code is for).

Video ID.

Create a webhook endpoint

Create a webhook endpoint. Creates a webhook endpoint and returns its signing secret once — store it, because a lost secret can only be replaced by deleting the endpoint and creating a new one. Call listWebhookEvents before choosing `events`: it returns the description, trigger condition and payload schema of each event, and several names are counter-intuitive. In particular account.published fires when YOU publish the order, not when the account is delivered — the delivery signal is account.in_review, and account.finalized fires when the account review is approved. Do not send Idempotency-Key. The successful response contains a secret and is never stored in the replay ledger. A request with the header is rejected with IDEMPOTENCY_KEY_NOT_ALLOWED_FOR_SENSITIVE_RESPONSE (400) before any ledger claim or operation execution.

JSON request body.

Call listWebhookEvents for the description, trigger condition and payload schema of every event. Note in particular: account.published fires when YOU publish the order, NOT when the account is delivered — the delivery signal is account.in_review, and account.finalized fires when the account review is approved. warming.session_started is not emitted for warming whose terms were set at bundle creation.

Cancel a pending comment task

Cancel a pending comment task. Cancels an owned task only while its status is pending. The terminal transition and refund of the task's exact stored credit cost commit atomically and are idempotent. Current tasks refund 1 credit; credits_refunded remains authoritative for historical tasks. Cancellation remains available when Coverage is paused because it stops pending work rather than executing it. Reuse the same Idempotency-Key after an uncertain transport result.

Comment task ID.

Delete a webhook endpoint

Delete a webhook endpoint. Permanently deletes a webhook endpoint and invalidates its signing secret. Events that could not be delivered are not queued for a replacement endpoint.

Webhook endpoint ID.

Dispute a manually confirmed comment task

Dispute a manually confirmed comment task. Returns an owned manually_confirmed task to pending corrections. Execution is blocked while TokPortal Coverage is inactive; inspect MANAGED_ACCOUNT_TASK_BLOCKED and reactivate a recoverable account first.

JSON request body.

Comment task ID.

Export analytics report HTML

Export analytics report HTML. Creates a standalone downloadable HTML analytics report from the same body as createAnalyticsReport, and validates it identically: `from` and `to` are YYYY-MM-DD (a full ISO timestamp is truncated to its date, anything else is refused with INVALID_FIELD rather than treated as no filter), an inverted window is refused, `template` is the published enum (executive, agency, creator, minimal, growth, board) and an unknown value is refused instead of becoming executive, and `brandAccent` must be #rrggbb or #rgb. The body of the response is the HTML document itself, so what was applied travels in headers: X-TokPortal-Report-Template, X-TokPortal-Report-Can-Brand, X-TokPortal-Report-Brand-Name, X-TokPortal-Report-From, X-TokPortal-Report-To, alongside X-TokPortal-Export-Rows and X-TokPortal-Export-Accounts. Read those headers to confirm the window and the branding actually used.

JSON request body.

White-label accent colour, #rrggbb (a #rgb short form is expanded). Named colours, rgb() and 8-digit hex are rejected with INVALID_FIELD instead of silently becoming the TokPortal default. Like brandName it only applies on a Farmer plan at the full tier; read applied.brand_accent back.

White-label brand name (80 characters, the real stored limit). Applied only on the full analytics tier with a Farmer plan; on every other plan it is reset to TokPortal, and the response says so through applied.brand_name and canBrand — check them before promising a client a white-labelled document.

Inclusive start date, YYYY-MM-DD. A full ISO timestamp is accepted and truncated to its date; anything else is rejected with INVALID_FIELD rather than silently treated as no filter (which used to widen the report to the account's entire history). Must not be after `to`. The window actually applied comes back as applied.filters.from.

Free-text filter. 120 characters, the real stored limit.

Report layout. Any other value is rejected with INVALID_FIELD rather than silently becoming executive. The applied template is echoed as applied.template on the JSON response and as X-TokPortal-Report-Template on the HTML export.

Report title. 120 characters, the real stored limit.

Inclusive end date, YYYY-MM-DD, same parsing as `from`. Echoed as applied.filters.to.

Export analytics videos CSV

Export analytics videos CSV. CSV export of post-level analytics for the selected accounts and date range. Requires the Creator tier or above. Call getAnalyticsContract before interpreting these numbers: top-line values are lifetime per-post totals, connected-account values are rolling windows, the two intentionally do not mirror each other, and your access tier may redact metrics — a missing field means unavailable, never zero.

Repeatable account filter.

Repeatable country filter.

query parameter from

Repeatable platform filter.

Search query.

query parameter to

query parameter workspace

Finalize account review

Finalize account review. Approves an in-review account and marks it finalized.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Bundle ID.

Optional Idempotency-Key header for safe retries.

Finalize video review

Finalize video review. Approves a delivered video and releases the account manager's payout — the review window cannot be reopened afterwards. Only valid while the slot is `in_review`. Any slot left in review is auto-finalized about 72 hours after entering it, so act inside that window. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Bundle ID.

1-based video slot position.

Fix a broken video download

Fix a broken video download. Replaces a manager-flagged broken video or carousel download URL and clears the download-issue flag. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

JSON request body.

Bundle ID.

1-based video slot position.

Generate Advanced Niche Warming search terms

Generate Advanced Niche Warming search terms. Generates platform-appropriate Advanced Niche Warming search terms (niche targets) from a free-text niche description (max 1000 characters). This is free and no credits are charged. Call it before buying warming rather than inventing terms: pass the result to advanced_warming_terms (bundle creation or PUT /bundles/{id}/warming-terms deferred configuration) or to search_terms (rewarmAccount).

JSON request body.

Desired number of terms: 3-30, must be a multiple of 3.

Platform the terms will be searched on.

Free-text description of the account's niche/brand (max 1000 characters). Terms are generated in the same language.

Get a delivered account

Get a delivered account. Returns one delivered account: handle, platform, Coverage state, ban state and warming summary. A `saved_account_id` invalidated by a remake returns 404 — re-read the bundle to get the new one.

Saved account ID.

Get account analytics compatibility view

Get account analytics compatibility view. Legacy compatibility view of one account's analytics, kept for older integrations. New code should call getAnalyticsAccount instead. Call getAnalyticsContract before interpreting these numbers: top-line values are lifetime per-post totals, connected-account values are rolling windows, the two intentionally do not mirror each other, and your access tier may redact metrics — a missing field means unavailable, never zero.

Saved account ID.

Get active account edit request

Get active account edit request. Returns the account's profile edit requests, newest first, with their status and credit cost. Only one request can be open per account at a time, so check here before calling createAccountEditRequest.

Saved account ID.

Get TokPortal Coverage status

Get TokPortal Coverage status. Returns the effective TokPortal Coverage status, current 30-day period, account-specific rate, unpaid periods, task access, and an exact timestamped reactivation quote for one eligible saved account. At current_period_end, status and task_access change immediately even if recorded_status remains included or active for a few minutes until the renewal worker persists the transition; period_expired makes that boundary explicit. A zero-credit quote is valid. Use its current_period_end and lock_version snapshot for reactivation. An eligible TikTok or Instagram account created before the global Coverage cutoff is grandfathered and has no subscription record. A missing record can also mean the account is not Coverage-eligible or has not reached delivery, so clients must not infer grandfathering from a generic 404. Coverage is independent from bundle completion or closure.

Saved account ID.

Get account analytics drilldown

Get account analytics drilldown. Analytics v2 drilldown for one account: current metrics, top posts and demographics. This is the current endpoint; getAccountAnalytics is the older compatibility shape of the same data. Call getAnalyticsContract before interpreting these numbers: top-line values are lifetime per-post totals, connected-account values are rolling windows, the two intentionally do not mirror each other, and your access tier may redact metrics — a missing field means unavailable, never zero.

Saved account ID.

Get analytics data contract

Get analytics data contract. Returns the Analytics v2 contract, current access payload, metric semantics, freshness targets, and redaction rules.

Get analytics dashboard

Get analytics dashboard. Portfolio-level analytics across your accounts for a date range. Call getAnalyticsContract before interpreting these numbers: top-line values are lifetime per-post totals, connected-account values are rolling windows, the two intentionally do not mirror each other, and your access tier may redact metrics — a missing field means unavailable, never zero.

Repeatable account filter.

Repeatable country filter.

query parameter from

Repeatable platform filter.

query parameter to

query parameter workspace

Get analytics time series

Get analytics time series. Daily or weekly time series for one metric, built from stored snapshots and date-scoped rollups — never a live fetch. `mode` selects cumulative totals, per-period gains, or raw snapshot values. Series are excluded on the Starter tier. Call getAnalyticsContract before interpreting these numbers: top-line values are lifetime per-post totals, connected-account values are rolling windows, the two intentionally do not mirror each other, and your access tier may redact metrics — a missing field means unavailable, never zero.

Repeatable account filter.

query parameter from

query parameter granularity

query parameter metric

query parameter mode

query parameter to

Get a bundle

Get a bundle. Full state of one bundle: status, account configuration, video slot counts, warming purchase, cancellation and remake history, and `next_action`. A remade bundle keeps the same id while its `saved_account_id` changes.

Bundle ID.

Get bundle account configuration

Get bundle account configuration. Returns the current account-profile configuration of a bundle (username, visible name, biography, picture) and its listing status. Read it before configureBundleAccount to see what is already set and whether the profile is still editable.

Bundle ID.

Check bundle publish readiness

Check bundle publish readiness. Returns every current publish blocker without mutating the bundle, settling Coverage, or debiting credits. MANAGED_ACCOUNT_TASK_BLOCKED includes details.account_id and details.reason. Fetch GET /accounts/{account_id}/managed-subscription for the authoritative state and exact reactivation quote. A due included or active period can temporarily appear blocked until renewal is settled by cron or an approved mutation.

Bundle ID.

Get video slot configuration

Get video slot configuration. Returns one video slot's configuration, schedule, review status and post link. Use it to check whether a slot is still inside its review window before finalizing it.

Bundle ID.

1-based video slot position.

Get comment pulse analytics

Get comment pulse analytics. Aggregated comment sentiment and themes across your posts, served from the analytics comment cache — never a live fetch. Full analytics tier only. Filters are not combinable: when `post` is supplied it takes precedence and `platform`, `country`, `account`, `workspace`, `from` and `to` are all ignored, and at most 12 post ids are sampled.

query parameter account

query parameter country

query parameter from

query parameter limit

query parameter platform

query parameter post

query parameter postLimit

query parameter to

Get a comment task

Get a comment task. Returns one owned comment task, including whether inactive TokPortal Coverage currently blocks manager execution and the stable block reason.

Comment task ID.

Get credit balance

Get credit balance. Returns the currently spendable credit balance and upcoming expirations. Check it before any purchase: a 402 on a mutation means this was short.

Get credit pricing

Get credit pricing. Authoritative live credit prices and workspace cohort. Call it immediately before any purchase and never hard-code or recall a price. Not every key is orderable: `youtube_account_creation` is listed for reference only (YouTube bundles are rejected with YOUTUBE_DELAYED), and `niche_warming` and `deep_warming` are legacy prices published for backward compatibility only — they are not products a caller may choose, and `advanced_warming` (Advanced Niche Warming, priced per niche target) is the only warming TokPortal sells. `managed_account_subscription` (TokPortal Coverage) recurs every 30 days per account after the included first period, so a multi-account quote must include it as a monthly cost. There is no dry-run endpoint: assemble the total from this table (account setup + video slots + Advanced Niche Warming targets + edit slots + paid video options), apply the returned cohort and contract_bundle_allowance, and confirm it with the user before creating anything.

Get authenticated user

Get authenticated user. Returns the authenticated workspace: profile, role, analytics access tier and live credit balance. Call once at the start of a session to learn what this key can do.

Get / poll the ad code for a video

Get / poll the ad code for a video. Returns the latest ad code request for the video. The `code` field is null until the manager submits it (status `in_review`) or it is delivered (status `finalized`).

Video ID.

Get single video analytics

Get single video analytics. Lifetime metrics for one tracked post. Interpret them with getAnalyticsContract: these are lifetime per-post totals and deliberately do not match the rolling-window figures shown for a connected account.

Video ID.

Get an Advanced Niche Warming session

Get an Advanced Niche Warming session. Returns one Advanced Niche Warming session you own: status, per-term tasks (with 3-calendar-day dispatch in the manager's timezone, verification status, client report and proof video link), and the aggregated report on completion. Created tasks remain open until completed; they do not expire.

Warming session ID.

Get a webhook endpoint

Get a webhook endpoint. Returns one webhook endpoint's URL, subscribed events and enabled state. The signing secret is not returned; if you lost it, delete this endpoint and create a replacement.

Webhook endpoint ID.

Import video slots from CSV

Import video slots from CSV. Uploads a CSV file, downloads the referenced media, and configures the available video slots. Partial success: this call returns HTTP 200 even when some or all rows are rejected. Read `imported`, `results` and `errors[]` and never infer success from the status code — rows breaking the 3-videos-per-day cap or the minimum lead time fail individually while the rest succeed. An `auto_publish` failure never fails the request; inspect `auto_publish.blockers`, and `auto_publish.adjusted_videos` when a stale date was moved forward at publish time. The date column is `target_publish_start_date` (note the name: the JSON endpoints call the same value `target_publish_date`) and it is the FIRST day of a 2-day window — the end is derived as that day + 1, so a `target_publish_end_date` column is refused with CSV_PARSE_ERROR rather than dropped. `auto_publish` is a form field on the multipart body and covers the whole import. Coverage is checked before TokPortal fetches or stores any referenced media. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Multipart form field auto_publish.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Local path to upload for multipart field file.

Bundle ID.

Optional Idempotency-Key header for safe retries.

List ban reports and appeals

List ban reports and appeals. Pollable list of validated ban reports for the caller's delivered accounts, covering the whole lifecycle: appeal_pending (platform appeal filed, account unavailable but NOT yet banned), appeal_accepted (account survived), appeal_refused / no_appeal_banned (confirmed ban), and the staff commercial resolution (refund / remake / no_remake with a machine-readable reason_code such as tos_ban). While a report is appeal_pending, do NOT order a replacement account: a duplicate can trigger a ban-evasion strike on the platform, which is why TokPortal itself waits for the appeal. Key your reports on bundle_id — account_id can be null after a staff reset. A resolution of refund returns setup, warming and unused video slots, but not work already delivered and not the Coverage period, and the restored credits expire 60 days after restoration (see the credits.restored event in listWebhookEvents). This is the REST counterpart of the account.banned, account.ban_appeal.submitted, account.ban_appeal.resolved and account.ban_resolution.decided webhook events. Only staff/CM-validated bans appear here — detections from TokPortal's internal health scan are never listed. Poll with the since parameter (updated_at watermark) to pick up new reports and status changes.

Filter by saved account ID.

When true, each report includes a signed 7-day URL of the ban-evidence screenshot when one exists.

Page number.

Items per page.

Filter by staff commercial resolution. 'pending' selects confirmed bans still awaiting the staff decision.

Only reports updated at or after this ISO 8601 timestamp. Use the highest updated_at you have seen as a polling watermark.

Filter by appeal lifecycle status.

List bundles for a delivered account

List bundles for a delivered account. Lists every bundle attached to one delivered account, including cancelled ones. Use it to see an account's full order history before ordering more work on it.

Saved account ID.

Page number.

Items per page.

Filter by bundle status.

List post analytics for an account

List post analytics for an account. Post-level analytics for one account, sortable by views, likes, engagement rate or upload date. Values are lifetime per-post totals. Call getAnalyticsContract before interpreting these numbers: top-line values are lifetime per-post totals, connected-account values are rolling windows, the two intentionally do not mirror each other, and your access tier may redact metrics — a missing field means unavailable, never zero.

Saved account ID.

Page number.

Items per page.

query parameter sort_by

query parameter sort_order

List Advanced Niche Warming sessions for an account

List Advanced Niche Warming sessions for an account. Lists Advanced Niche Warming sessions (newest first) for a saved account you own, including per-term tasks, per-term reports, proof links, and the aggregated session report when completed. Tasks unlock over 3 calendar days in the manager's timezone and, once created, do not expire.

Saved account ID.

List delivered accounts

List delivered accounts. Lists delivered saved accounts (real accounts that exist on the platform). Note the product has two ids: the account *listing* id carried by a bundle is stable across remakes, while the `saved_account_id` returned here is replaced every time an account is remade.

Filter by ban state. true returns only banned accounts (staff-validated or park-scan detected, matching the `banned` response field); false returns only non-banned accounts.

Filter by country code or country alias.

Page number.

Items per page.

Filter by platform.

List comments for an account post

List comments for an account post. Returns cached comment text for one tracked post of an account. Full analytics tier only; this read never calls the platform live.

Saved account ID.

query parameter limit

query parameter postId

query parameter trackedPostId

List raw account analytics snapshots

List raw account analytics snapshots. Returns owner-scoped stored raw analytics payloads for a saved account. Full analytics tier only.

query parameter from

Saved account ID.

query parameter limit

query parameter source

query parameter to

List raw post analytics snapshots

List raw post analytics snapshots. Returns owner-scoped stored raw analytics payloads for a tracked post. Full analytics tier only.

query parameter from

Tracked post ID.

query parameter limit

query parameter source

query parameter to

List bundle video slots

List bundle video slots. Lists every video slot of a bundle with its position, configuration, schedule and review status. Positions are 1-based and run up to the bundle's `videos_quantity`.

Bundle ID.

List bundles

List bundles. Lists your bundles with their lifecycle status and the computed `next_action` (`configure_account`, `configure_videos`, `publish_bundle`, or null). `next_action` is the recommended way to find what a bundle still needs.

query parameter account_status

query parameter bundle_type

query parameter external_ref

Page number.

Items per page.

query parameter platform

Filter by bundle status.

List comment task verification events

List comment task verification events. Lists verifier attempts for one owned task. This read remains available while TokPortal Coverage pauses task execution.

Comment task ID.

List comment tasks

List comment tasks. Lists owned comment tasks. execution_blocked and execution_block_reason identify tasks paused by inactive TokPortal Coverage; reads remain available while execution is paused.

Page number.

Items per page.

Filter by a user-owned saved account ID.

Filter by one status or a comma-separated list of statuses.

List available countries

List available countries. Lists the valid `country` values for bundle creation. Most are ISO-3166-1 alpha-2 (FR, DE, BR), but TokPortal's own codes are the authority and two of them are not alpha-2: the United States is `USA` and the United Kingdom is `UK`. Their ISO aliases `US` and `GB` are accepted and resolved to those two, so send a code from this list verbatim and never assume alpha-2. Call before createBundle or createBundlesBulk: `country` is validated against this list, and a full country name such as "United States" is rejected. `videos_only_countries` applies only to video orders on an existing account and is never valid for /bundles/bulk.

List credit transactions

List credit transactions. Paginated ledger of every credit debit and refund, newest first. Use it to reconcile what a bundle or batch actually cost, since server-side pricing (workspace cohort, contract allowance) can differ from the list price.

Filter transactions created on or after this date.

Filter transactions created before the day after this date.

Page number.

Items per page.

List available platforms

List available platforms. Lists the orderable platforms and, per video type, the exact required and optional fields. Call before configuring any slot: TikTok carousels require `tiktok_sound_url`, Instagram posts and reels require `instagram_content_type`, and a story takes exactly one of `video_url` or `story_image_url` and no description. Only TikTok and Instagram can be ordered; YouTube fields exist on the video schema but YouTube bundles are rejected with YOUTUBE_DELAYED.

List webhook deliveries

List webhook deliveries. Lists delivery attempts for one endpoint with the response status and body. Deliveries are at-least-once and retries reuse the same `TokPortal-Event-Id` — deduplicate on that id, not on the delivery id.

Filter by event type.

Webhook endpoint ID.

Page number.

Items per page.

Filter by delivery success.

List webhook endpoints

List webhook endpoints. Lists your webhook endpoints with their subscribed events and enabled state. Signing secrets are never returned here — only once, at creation.

Filter by enabled state.

Filter endpoints subscribed to an event.

Page number.

Items per page.

List webhook event catalog

List webhook event catalog. Returns the supported webhook event types with, for each one, its description, exact trigger condition, payload schema and an example payload, plus the delivery envelope and signature scheme. Read it before subscribing: several names are counter-intuitive — account.published fires when you publish the order, not when the account is delivered (that is account.in_review), and warming.session_started is not emitted for warming whose terms were set at bundle creation. This endpoint is public so teams can inspect webhook contracts before creating an API key.

Patch video metadata or schedule

Patch video metadata or schedule. Changes a configured slot's name, description, external reference or schedule without re-sending its media. Rescheduling obeys the maximum of 3 videos per day per bundle AND — enforced since 2026-08-26, where before only the per-day cap ran — the same minimum publish lead time as configuration: today+1 with a delivered or existing account, today+3 while the account is still being created, in UTC. Today and any past date are rejected with `INVALID_DATE` carrying `min_days_ahead` and `earliest_allowed` (YYYY-MM-DD), the same shape the configure PUT returns. Send either target_publish_date (a 2-day window whose end is derived as that day + 1) or the target_publish_start_date/target_publish_end_date pair, never both — this is the ONLY endpoint where the window's end can be chosen, and it must fall strictly after the start. Cannot be used once the video is finalized. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

JSON request body.

YYYY-MM-DD. Shorthand for a 2-day window: the end day is derived as this day + 1. Max 3 videos per day per bundle — a 4th video on the same day is rejected with VIDEOS_PER_DAY_EXCEEDED. Minimum lead time, in UTC: the earliest allowed date is today+3 days while the bundle is still having its account created, and today+1 once that account is delivered or when the bundle runs on an existing account; an earlier date is rejected with INVALID_DATE carrying min_days_ahead and earliest_allowed (YYYY-MM-DD). Cannot be combined with target_publish_start_date / target_publish_end_date.

End of an EXPLICIT publication window (ISO 8601 date-time). Must be strictly after target_publish_start_date, and must be sent together with it — never alongside target_publish_date, and never on the configuration or CSV endpoints, where the end is derived and this field is refused.

Start of an EXPLICIT publication window (ISO 8601 date-time). This is the only endpoint where the window's end is choosable — configuration and CSV import always derive it as start + 1 day. Send it together with target_publish_end_date and never alongside target_publish_date. Since 2026-08-26 it obeys the same minimum lead time as configuration (today+1 with a delivered or existing account, today+3 while the account is still being created, in UTC); an earlier value is rejected with INVALID_DATE carrying min_days_ahead and earliest_allowed.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Bundle ID.

Optional Idempotency-Key header for safe retries.

1-based video slot position.

Publish all configured videos on an active bundle

Publish all configured videos on an active bundle. Hands every configured, unpublished slot on an active bundle to the account manager for posting. Publishing is irreversible once a manager has posted; call unscheduleBundleVideo beforehand to hold a slot back. Slots whose target date has already reached today or the past are moved forward to the earliest allowed day, respecting the 3-videos-per-day-per-bundle cap (an overflowing day spills to the next); slots still in the future are left alone, and the publish never fails because of it. When something moved, the response carries `dates_adjusted` (how many), `adjusted_videos` (one `{video_id, position, previous_date, new_date}` per moved slot) and `hint`. There is no `earliest_allowed_date` field on this response — it was documented but never returned, and `adjusted_videos` replaces it with the per-slot dates. Read them back instead of assuming the original schedule survived. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Bundle ID.

Publish a bundle

Publish a bundle. Submits a fully configured bundle to the account-manager marketplace, which is what actually starts the work. Requires status `pending_setup`, a complete account profile, and at least one configured video on an `account_and_videos` bundle — call getBundlePublishReadiness first, it returns every blocker without debiting. A due Coverage period renews here, so this call can debit credits even though the bundle's own cost was charged at creation. Irreversible once a manager accepts: unpublishBundle only works before that, and never refunds. Publish-time date guard: any slot whose target date has already reached today or the past is moved forward to the earliest allowed day (today+1 with a delivered or existing account, today+3 while the account is still being created, in UTC), respecting the 3-videos-per-day-per-bundle cap — an overflowing day spills to the next one. Slots still in the future are NOT moved. This never fails the publish. When something moved, the response carries `adjusted_videos` — one entry per moved slot, `{video_id, position, previous_date, new_date}` — and `adjusted_videos_note`. Read them back instead of assuming the schedule you sent survived. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Bundle ID.

Publish one video slot

Publish one video slot. Hands one configured slot to the account manager for posting on its target date. Irreversible once the manager has posted. If that target date has already reached today or the past it is moved forward to the earliest allowed day rather than published as instantly-due work, and the response then carries `date_adjusted: true`, `original_date`, `new_date` (both YYYY-MM-DD) and `hint`. Those four fields were documented long before they were real: until 2026-08-26 the RPC never returned them, and the slot published on its stale date. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Bundle ID.

1-based video slot position.

Reactivate TokPortal Coverage

Reactivate TokPortal Coverage. Reactivates TokPortal Coverage from an explicit GET snapshot, and debits the projected unpaid 30-day periods — read the quote from getAccountManagedSubscription and confirm the amount with the user first. Reactivation is free while the current billing period is already paid or included; Coverage benefits and tasks remain paused until reactivation. At and after current_period_end, the endpoint accepts the effective lapsed state even if recorded_status has not yet been updated by the renewal worker, and charges exactly the projected unpaid periods without adding an extra period. The expected credits, period end, and lock version are checked atomically before any debit or task resume. Scheduled videos receive new future dates while preserving their cadence.

JSON request body.

The exact reactivation_credits value from the latest Coverage snapshot. Zero is valid.

The current_period_end value from the same snapshot.

The lock_version value from the same snapshot.

Saved account ID.

Refresh account analytics

Refresh account analytics. Legacy account-analytics refresh path, kept for older integrations; new code should call refreshAnalyticsAccount. Comment collection is gated on three conditions: includeComments only runs when force is true, includePosts is not false, and the workspace holds the full analytics tier. The two you control are refusals, not silence — includeComments without force, or with includePosts false, fails with INVALID_FIELD for MCP callers and is reported for direct REST callers. The one you cannot control, the analytics tier, comes back on the response as applied.include_comments plus applied.include_comments_dropped_reason. The call can still return 200 with deduped: true and skippedReason: "recent_snapshot", which means nothing was refreshed. Check canRefreshAccountAnalytics first: a forced retry consumes the manual-refresh cooldown slot and the next one is rejected with 429. Refresh is blocked for revealed/detached, banned or inactive-Coverage accounts; permanently grandfathered accounts remain eligible.

JSON request body.

Bypass the recent-snapshot dedup. Without it the call can return 200 with deduped: true and skippedReason: "recent_snapshot", meaning nothing was refreshed. A forced refresh consumes the manual-refresh cooldown slot (6 h connected / 24 h public); check canRefreshAccountAnalytics first.

Only takes effect when force is true AND includePosts is not false AND the workspace holds the full analytics tier. The two conditions you control are enforced: sending it without force, or with includePosts false, fails with INVALID_FIELD for MCP callers and is reported for direct REST callers. The tier condition, which you cannot control, is reported on the response as applied.include_comments with applied.include_comments_dropped_reason and applied.analytics_tier. Read applied rather than assuming a 200 means comments were imported.

Saved account ID.

Refresh analytics account

Refresh analytics account. Refreshes an owner-scoped account through Analytics v2. Comment collection is gated on three conditions: includeComments only runs when force is true, includePosts is not false, and the workspace holds the full analytics tier. The two you control are refusals, not silence — includeComments without force, or with includePosts false, fails with INVALID_FIELD for MCP callers and is reported for direct REST callers. The one you cannot control, the analytics tier, comes back on the response as applied.include_comments plus applied.include_comments_dropped_reason. The call can still return 200 with deduped: true and skippedReason: "recent_snapshot", which means nothing was refreshed. Check canRefreshAccountAnalytics first: a forced retry consumes the manual-refresh cooldown slot and the next one is rejected with 429. Refresh is blocked for revealed/detached, banned or inactive-Coverage accounts; permanently grandfathered accounts remain eligible.

JSON request body.

Saved account ID.

Request account corrections

Request account corrections. Moves an in-review account back to pending corrections with reviewer feedback.

JSON request body.

JSON body field. May be supplied here or inside body.comment.

JSON body field. May be supplied here or inside body.fields.

Bundle ID.

Request video corrections

Request video corrections. Sends a delivered video back to the account manager with written feedback instead of approving it. Only valid while the slot is `in_review`, i.e. inside the ~72-hour window before it auto-finalizes. The response does not echo `fields`, so keep your own record of what you flagged. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

JSON request body.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Bundle ID.

Optional Idempotency-Key header for safe retries.

1-based video slot position.

Reset one video slot

Reset one video slot. Clears a slot's configuration so it can be configured again. Only works from `pending` or `configured`: to clear a published or accepted slot call unscheduleBundleVideo first, then reset. The slot's credits are not refunded and any paid option already charged on it stays charged. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Bundle ID.

1-based video slot position.

Retrieve latest account verification code

Retrieve latest account verification code. Retrieving a verification code is the same irreversible first-access event as revealing credentials. Its policy is determined by this saved account's created_at timestamp against the immutable managed_pricing_new_customer_cutover_at value, never by the workspace action-pricing cohort or August 14 grace deadline. A saved account created before the cutoff permanently keeps the prior API contract: 0 credits, no new versioned acknowledgment body required, no TokPortal detachment, existing task access remains available, and support plus ban coverage end after access. A saved account created at or after the cutoff follows the managed policy: normally 150 credits, or the stored $10 legacy / $15 new per-30-day rate when Account Owning is already admin-approved. Managed access permanently detaches the account, makes it read-only, and ends TokPortal Coverage, task access, analytics updates, support, ban protection, replacement, refunds, compensation and credit restoration. For a new-policy account, missing explicit acceptance fails with 428 and returns the exact account-specific terms, price and policy version. A changed quote returns 409 before any debit or reveal. Reaching the Account Owning eligibility threshold only submits an admin review request; it never activates the agreement automatically. While approval is pending, reveal remains available for 150 credits on a post-cutoff account. Do not send Idempotency-Key: this response contains a verification secret and is never stored in the replay ledger. A request that includes the header is rejected before any ledger claim, reveal, debit, or inbox access with IDEMPOTENCY_KEY_NOT_ALLOWED_FOR_SENSITIVE_RESPONSE (400). After an uncertain transport result, fetch the safe account state before deciding whether to call this endpoint again without the header.

JSON request body.

Set to true to confirm, on behalf of the account owner, acceptance of the exact disclosure identified by policy_version. Required on first credential or verification-code access and ignored after the account has already been revealed.

The exact current policy version returned in error.details.policy_version by HTTP 428 or 409. A missing version returns 428. A supplied non-empty stale or mismatched version returns CREDENTIAL_REVEAL_QUOTE_CHANGED (409), with the current disclosure and expected_credit_cost, before any debit or reveal.

Saved account ID.

Retry a webhook delivery

Retry a webhook delivery. Resends the stored webhook payload to the endpoint's current URL with a fresh TokPortal-Signature header. The event ID is preserved so receivers can keep idempotent processing.

Webhook delivery ID.

Webhook endpoint ID.

Reveal delivered account credentials

Reveal delivered account credentials. The first credential or verification-code access is priced from this saved account's created_at timestamp against the immutable managed_pricing_new_customer_cutover_at value, never from the workspace action-pricing cohort or August 14 grace deadline. A saved account created before the cutoff permanently keeps the prior API contract: the reveal costs 0 credits, requires no new versioned acknowledgment body, and is irreversible; support and ban coverage end, but the account is not detached and existing TokPortal task access remains available. A saved account created at or after the cutoff follows the managed policy and requires the explicit versioned acknowledgment handshake: normally 150 credits, or the stored $10 legacy / $15 new per-30-day rate when Account Owning is already admin-approved. Crossing the Account Owning eligibility threshold only submits an admin review request and never activates it automatically. While approval is pending, reveal remains available for 150 credits on a post-cutoff account. Under the managed policy the charge is final and non-refundable, and reveal permanently detaches the account, makes it read-only, and ends TokPortal Coverage, all task access, analytics updates, support, ban protection, replacement, refunds, compensation and credit restoration. TokPortal is not responsible for later access, performance, reach, security, restrictions or bans. The debit or Account Owning activation, reveal marker and Coverage shutdown commit atomically. Previously revealed accounts are not charged a second time. Do not send Idempotency-Key: this response contains credentials and is never stored in the replay ledger. A request that includes the header is rejected before any ledger claim, reveal, debit, or secret access with IDEMPOTENCY_KEY_NOT_ALLOWED_FOR_SENSITIVE_RESPONSE (400). After an uncertain transport result, fetch the safe account state before deciding whether to call this endpoint again without the header.

JSON request body.

Saved account ID.

Order Advanced Niche Warming (rewarm) on a delivered account

Order Advanced Niche Warming (rewarm) on a delivered account. Starts an Advanced Niche Warming session on a saved account that is already delivered: for each provided term the manager screen-records a session that opens on the account profile (handle visible), searches the term on the account's platform, watches videos from the results, engages with them (likes/saves) and leaves a comment. Every recording is verified before completion. The standard rate is 5 credits per term, charged per target and never per day (3-30 terms, multiples of 3), with a 15-credit minimum; GET /credit-costs returns the effective rate. Once the session has tasks it is NEVER refunded, so confirm the total with the user before calling. Call listAccountWarmingSessions first: only one session can be active per account and a second one is rejected with 409 REWARM_ALREADY_ACTIVE. Requires active TokPortal Coverage, a routable active account manager backed by a non-cancelled support order, TikTok or Instagram, and no already-active warming session. A completed bundle remains eligible. Terms are split evenly over 3 calendar days in the manager's timezone; earlier-day tasks remain available until completed and sessions with tasks do not expire.

JSON request body.

3-30 search terms, and the count MUST be a multiple of 3 (3, 6, 9 … 30), each 2-50 characters. The standard rate is 5 credits per term (per target, never per day); GET /credit-costs returns the effective rate. For each term the manager screen-records a session that opens on the account profile, searches the term, watches videos from the results, engages with them (likes/saves) and leaves a comment. Every recording is verified before the manager is paid.

Saved account ID.

Send a test webhook

Send a test webhook. Sends a signed webhook.test event to the endpoint and records the delivery result.

Webhook endpoint ID.

Unpublish a bundle

Unpublish a bundle. Returns a published bundle to `pending_setup` so its account configuration can be edited again. Only works while the bundle is published and no account manager has accepted it (409 otherwise). Credits are NOT refunded and this is not a cancellation: there is no API path to cancel a bundle or recover its credits.

Bundle ID.

Unschedule one video slot

Unschedule one video slot. Pulls a published slot back out of the account-manager queue and returns it to `configured`, so it can be rescheduled or reset. Does not refund the slot. Requires active TokPortal Coverage on the resolved saved account, or permanent grandfathering: a due period renews automatically at the account's stored rate immediately before execution, and nothing starts if it cannot renew. See getAccountManagedSubscription.

Bundle ID.

1-based video slot position.

Update account commenting profile

Update account commenting profile. Sets the internal commenting-autopilot metadata (niche, persona, goal, language, tracked handles) that TokPortal uses to draft comments for this account. It NEVER changes the account's public profile — use createAccountEditRequest to change a delivered account's username, visible name, biography, picture or link. The account must belong to the API key owner and must have active TokPortal Coverage, unless it is permanently grandfathered. Revealed/detached, banned, paused, lapsed and unrecoverable accounts are read-only.

JSON request body.

Saved account ID.

Update bundle settings

Update bundle settings. Updates mutable bundle metadata: title, external_ref, and auto_finalize_videos. auto_finalize_videos true (the default) approves every delivered video automatically — it counts as final on arrival; set it to false to hold each delivered video for your review, approving with finalizeBundleVideo or pushing back with requestBundleVideoCorrections yourself. Note that anything left in review is auto-finalized about 72 hours after entering it either way.

JSON request body.

Bundle ID.

Update safe workspace settings

Update safe workspace settings. Updates client-owned workspace profile fields used by Operator context. Does not expose auth, role, credit, staff, or manager settings.

JSON request body.

Update a webhook endpoint

Update a webhook endpoint. Changes an endpoint's URL, subscribed events, description or enabled state. The signing secret is unchanged and is never re-returned. Call listWebhookEvents for the meaning, trigger condition and payload of each event type before changing the subscription list.

JSON request body.

Simulate this call: full validation and the real price, but nothing is created, no credits are debited, and no Idempotency-Key is consumed. Returned identifiers are synthetic and only usable in other dry-run calls.

Webhook endpoint ID.

Optional Idempotency-Key header for safe retries.

Create an image upload URL

Create an image upload URL. Returns a short-lived signed upload URL and upload token for an image. Use the returned `storage_path` — NOT `public_url` — for `carousel_images` and `profile_picture_url`; videos are the opposite, uploadVideo returns a `public_url` that goes straight into `video_url`. The stored object's extension comes from the declared `content_type` (image/png stores a .png), and only falls back to the extension in `filename` when the content type is unknown, so send the content type that matches the bytes you are about to PUT. `storage_path` on the response is the key the object is actually stored under — read it rather than rebuilding it from `filename`. Do not send Idempotency-Key. The successful response contains a secret and is never stored in the replay ledger. A request with the header is rejected with IDEMPOTENCY_KEY_NOT_ALLOWED_FOR_SENSITIVE_RESPONSE (400) before any ledger claim or operation execution.

JSON request body.

Allowed image MIME types: image/jpeg, image/jpg, image/png, image/webp, image/gif. This value determines the stored object's extension (image/png stores a .png); filename is only the fallback when the type is unrecognised. Send the type that matches the bytes you are about to PUT, and use it as the Content-Type of that PUT. Read storage_path on the response for the key the object actually landed under.

Original file name. Used only as a fallback for the stored object's extension when content_type is not a recognised image type; content_type is what normally names the object. The response's storage_path is the authoritative key.

Which bucket the image is stored in. Use the response's storage_path (not public_url) for carousel_images and profile_picture_url.

Upload an image file directly

Upload an image file directly. Uploads multipart/form-data directly through TokPortal and returns storage details. Use the returned `storage_path` — NOT `public_url` — for `carousel_images` and `profile_picture_url`. HEIF/HEIC may be converted to JPEG. `purpose` is validated like it is on the JSON upload endpoints: an explicit value other than `carousel` or `profile_picture` is refused with INVALID_FIELD for MCP callers and reported in `meta.ignored_fields` for direct REST callers — it is no longer quietly rounded down to `carousel`. Omitting `purpose` still means `carousel`, which is the documented default. Confirm the destination with the returned `bucket`.

Multipart form field bundle_id.

Local path to upload for multipart field file.

Multipart form field purpose.

Import an image from URL

Import an image from URL. Fetches a public direct image URL and stores it permanently in TokPortal storage. Use the returned `storage_path` — NOT `public_url` — for `carousel_images` and `profile_picture_url`.

JSON request body.

Public direct image URL.

Create a video upload URL

Create a video upload URL. Returns a short-lived presigned upload capability for a video file. The `public_url` it returns is what goes into `video_url` on configureBundleVideo — images are the opposite and require the upload response's `storage_path`. Do not send Idempotency-Key. The successful response contains a secret and is never stored in the replay ledger. A request with the header is rejected with IDEMPOTENCY_KEY_NOT_ALLOWED_FOR_SENSITIVE_RESPONSE (400) before any ledger claim or operation execution.

JSON request body.

Upload a video file directly

Upload a video file directly. Uploads multipart/form-data directly through TokPortal and returns the public video URL, which goes straight into `video_url` on configureBundleVideo.

Multipart form field bundle_id.


Chat with DeepSeek V4 models. deepseek-v4-flash (fast, economical) and deepseek-v4-pro (most capable), both 1M context with optional chain-of-thought thinking mode. deepseek-chat and deepseek-reasoner are deprecated aliases, still accepted for backward compatibility (resolve to v4-flash) but slated for removal; prefer the v4 names. Features: multi-turn sessions (session_id), function calling (tools parameter), thinking mode, JSON output mode, multimodal input (when enabled), automatic cost tracking, and model fallback with circuit breaker resilience.

Enable JSON output mode. The model will output valid JSON. Include the word "json" in your prompt for best results. Supported by both models.

Maximum tokens to generate. V4 models support up to 384000 output tokens.

Array of conversation messages. Each message has role (system/user/assistant/tool) and content (string or array of content parts for multimodal). Tool messages require tool_call_id.

Model to use. deepseek-v4-flash (default, fast/economical) or deepseek-v4-pro (most capable), both 1M context, up to 384K output. Non-thinking by default for speed; pass thinking:{type:"enabled"} to reason. Deprecated aliases (still accepted, prefer v4 names): deepseek-chat -> v4-flash non-thinking, deepseek-reasoner -> v4-flash thinking.

Reasoning effort while thinking mode is active: "high" (default) or "max". Only applies when thinking is enabled.

JSON Schema to validate the model output against. Implies JSON output mode. The server validates the parsed result and, on failure, issues up to RESPONSE_SCHEMA_MAX_RETRIES repair retries (feeding the validation error back). The returned content is the first schema-valid object, or the last attempt with schema.valid=false and schema.error set.

Session ID for multi-turn conversations. When provided, previous messages from this session are prepended to the current messages. If the session does not exist, it is created automatically. Omit for stateless single-turn requests.

Enable streaming mode. Returns full response after streaming completes.

Sampling temperature (0-2). Higher = more random. Default: 1.0. Ignored when thinking mode is enabled.

Toggle chain-of-thought thinking mode. Use {type: "enabled"} to reason, {type: "disabled"} for a fast direct answer (the default here). When enabled, temperature/top_p are ignored.

Controls which tool the model calls. "auto" (default), "none", "required", or {type:"function",function:{name:"..."}}

Array of tool definitions for function calling. Each tool has type "function" and a function object with name, description, and parameters (JSON Schema).

content model usage request finish_reason

DeepSeek Chat Completion

Fill-in-the-Middle (FIM) completion with DeepSeek V4. Provide a prompt (prefix) and an optional suffix; the model completes the text in between. Ideal for code completion and content infilling. Runs in non-thinking mode on the Beta endpoint; output is capped at 4K tokens. The deprecated aliases deepseek-chat and deepseek-reasoner are still accepted and resolve to deepseek-v4-flash (FIM has no thinking mode). Includes automatic cost tracking and model fallback with circuit breaker resilience.

Maximum tokens to generate. FIM completions are capped at 4096 tokens by the API.

Model to use. deepseek-v4-flash (default, fast/economical) or deepseek-v4-pro (most capable). Deprecated aliases deepseek-chat / deepseek-reasoner are still accepted and resolve to v4-flash. FIM is always non-thinking.

The prefix text that comes before the content to generate. Required. For code completion, this is the code up to the cursor.

Optional stop sequence(s). Generation stops when any is produced. A single string or an array of up to 16 strings.

Optional suffix text that comes after the content to generate. The model fills the gap between prompt and suffix.

DeepSeek FIM Completion

Manage multi-turn conversation sessions. List active sessions, delete a specific session, or clear all sessions. Sessions store conversation history for use with the session_id parameter in deepseek_chat.

Action to perform. "list": show all active sessions, "clear": remove all sessions, "delete": remove a specific session (requires session_id)

Session ID to delete (required when action is "delete")

DeepSeek Session Management


Click an element by snapshot ref (e.g., 's1e5' for main frame or 's1f2e10' for iframe elements). Returns: (1) shortened YAML snapshot text, (2) base64 PNG screenshot, (3) base64 PNG screenshot with refs. Note: Snapshot is shortened by default. If you see an element in the screenshot that has no ref in the snapshot, call browser_snapshot with detail='all' to get the full snapshot. Warning: Snapshot may not reflect latest page state due to async web content; call browser_snapshot to get current state if needed.

Element target: snapshot ref such as "s1e1" for main frame or "s1f2e5" for iframe elements (coordinates are also accepted).

Close all tabs in the Jan Browser MCP tab group and ungroup them. This clears the automation session. Use browser_navigate to create a new tab afterwards if needed.

Navigate the browser tab: open a URL, move browser history, or create a new tab. Pass 'target' as a URL/domain (https added if missing), 'back'/'forward' for history, or 'new' to create a blank tab. Set 'forceNewTabOpen: true' to force creating a new tab when navigating (instead of reusing existing assigned tab). Returns: (1) shortened YAML snapshot text, (2) base64 PNG screenshot, (3) base64 PNG screenshot with refs. Note: Snapshot is shortened by default. If you see an element in the screenshot that has no ref in the snapshot, call browser_snapshot with detail='all' to get the full snapshot. Warning: Snapshot may not reflect latest page state due to async web content; call browser_snapshot to get current state if needed.

If true, forces creating a new tab in the automation group even if a tab is already assigned. Default: false (reuses existing tab)

Where to go: full URL, bare domain (we add https://), "back"/"forward" for history navigation, or "new" to create a new tab

Scroll the current page or a referenced element; directions: up/down/top/bottom. amount controls pixel distance for up/down. Returns: (1) shortened YAML snapshot text, (2) base64 PNG screenshot, (3) base64 PNG screenshot with refs. Note: Snapshot is shortened by default. If you see an element in the screenshot that has no ref in the snapshot, call browser_snapshot with detail='all' to get the full snapshot. Warning: Snapshot may not reflect latest page state due to async web content; call browser_snapshot to get current state if needed.

Pixels to scroll for up/down (default 500). Ignored for top/bottom.

Scroll direction/position for the current page or element

Optional snapshot ref (e.g., 's1e5' for main frame or 's1f2e10' for iframe elements) to scroll a specific element instead of the page

Capture an accessibility snapshot of the current tab (ARIA tree, landmarks, headings, ref map). Returns: (1) YAML snapshot text (with ref map), (2) base64 PNG screenshot, (3) base64 PNG screenshot with refs overlaid. Default detail='shorten' for optimized output. Use detail='all' for complete snapshot when you see elements in the screenshot without refs in the snapshot. Use fullPage=false for viewport-only.

Snapshot detail level. Default: shorten. Use "all" for no limits. Result includes snapshot text, plain screenshot, and screenshot with refs using same snapshotId.

Capture full page (true) or only viewport-visible content (false). Default: true

Switch the current browser automation to a different tab by its ID. Get available tab IDs from browser_tabs tool. The switched tab becomes the active tab for subsequent browser operations. Returns: (1) shortened YAML snapshot text, (2) base64 PNG screenshot, (3) base64 PNG screenshot with refs of the switched tab. Warning: Snapshot may not reflect latest page state due to async web content; call browser_snapshot to get current state if needed.

The tab ID to switch to (from browser_tabs output)

Get all tabs in the Jan Browser MCP tab group with their metadata (tabId, url, title, active status). Use this to see available tabs for browser automation. If no tab group exists but a tab is assigned for browser use, creates the tab group and returns info. Returns error message if no tab group and no assigned tab.

Focus an element by snapshot ref (e.g., 's1e5' for main frame or 's1f2e10' for iframe elements), type text/keys. Returns: (1) shortened YAML snapshot text, (2) base64 PNG screenshot, (3) base64 PNG screenshot with refs. Note: Snapshot is shortened by default. If you see an element in the screenshot that has no ref in the snapshot, call browser_snapshot with detail='all' to get the full snapshot. Warning: Snapshot may not reflect latest page state due to async web content; call browser_snapshot to get current state if needed.

Whether to clear the existing value before typing. Default: true

Convenience flag to press Enter after typing

Text to type. Embed key presses with …, e.g., "Hello Enter". Supported keys: Meta (platform-aware: Cmd on macOS, Ctrl on Windows/Linux), Alt, Shift, Enter, Tab, Escape, Backspace, Delete, Space, ArrowLeft, ArrowRight, ArrowUp, ArrowDown, Home, End, PageUp, PageDown, and single characters. Combine with +, e.g., "Meta+A" for select-all on any platform.