> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Bounty > Creates a bounty and escrows its reward pool. Publishes immediately, or as a scheduled draft when you set `publish_at`. ## OpenAPI ````yaml /openapi/api-v1-native.json post /bounties openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead. name: Team Members x-whop-summary: An account's team members and the roles that scope their access. - description: > A Member is one buyer's relationship with an account — one record per customer regardless of how many memberships they hold. It carries relationship-level state: whether they have joined or left, their access level (`customer`, `admin`, or `no_access`), when they joined, and when they last opened the account's content. Use the Members API to list an account's members with filtering by access level, status, join date, and name or username search, and to retrieve a single member. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead. name: Members x-whop-summary: One buyer's relationship with an account, across all their purchases. - name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/beta/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > An Export is an asynchronous CSV of one resource for one account — members, payments, disputes, ads, and the other tables the Whop dashboard can export. Generating a full table takes longer than a request, so an export is created in `pending`, moves through `processing`, and lands on `completed` with a download link. Each resource requires that resource's own export scope. Use the Exports API to start an export, poll it until `download_url` is set, and list the exports already requested for an account. Finished CSVs are retained for 30 days, after which the file is deleted and the export moves to `expired`. name: Exports x-whop-summary: Asynchronous CSV dumps of an account's dashboard data. - description: > A Notification is a message delivered to a user — a new post, a payment, a mention. Every notification comes from an experience the user belongs to or a team they are on, and users control what they receive with notification preferences. Every notification belongs to a topic: the category it falls under, such as new sales or account activity. Topics carry a default, so a user only needs a preference row where they diverge from it. `GET /notifications/topics` lists the platform's visible topics, and a topic's `id` is what the notification preference endpoints take as `topic_id` — the catalog is the only place those ids come from, so read it rather than hardcoding. Each topic also carries an `identifier` such as `new-follower`, which is stable across environments and is the value to match on in code. Use the Notifications API to list the authenticated user's feed, read per-experience unread badges, mark an experience (or everything) as read, send notifications from your app to an experience's users or an account's team, and list the topic catalog. name: Notifications x-whop-summary: >- The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. - description: > A Payment is one charge against a buyer. Create it with a payment method already on file, or with a `confirmation_token` describing a method the buyer has just supplied. Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](/api-reference/beta/payments/retrieve-status) for how far the payment has got and, while it is `requires_action`, what the buyer must do next — follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Use the return_url operation to change where they land afterwards, up until they come back. name: Payments x-whop-summary: A charge against a buyer, and the step they still owe. - description: > A Setup Intent saves a buyer's payment method for later without taking money now. It runs the same collection flow a payment does, so the buyer may still owe a step — 3D Secure on a card, a hosted enrollment, or linking a bank account. Poll [Retrieve status](/api-reference/beta/setup-intents/retrieve-status) for how far the setup has got and what is outstanding. Once it reaches `succeeded` the method is on file and can be charged. name: Setup Intents x-whop-summary: Saving a buyer's payment method without charging it. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, withdrawal, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable. name: Ledgers x-whop-summary: The activity feed behind an account or user's balance. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create and track payouts, manage saved payout methods, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > A Dispute is a chargeback a customer files against a payment through their bank, or an inquiry that may become one. It carries the disputed payment, a deadline to respond, your evidence, and the outcome once the processor rules. Use the Disputes API to list disputes, edit the evidence packet while a dispute is still contestable, and submit it for review. name: Disputes x-whop-summary: Chargebacks filed against an account, with evidence and outcomes. - description: > A Dispute alert is an early warning from a card issuer that a settled payment is being questioned, ahead of any chargeback. `type` separates fraud reports (`early_fraud_warning`), pre-dispute notices (`dispute_alert`), and Visa RDR cases the network already closed by refunding (`rapid_dispute_resolution`). Use the Dispute alerts API to list alerts for an account, filter them by type or payment, and read `actionable` to see whether refunding can still avoid the chargeback. name: Dispute alerts x-whop-summary: Issuer warnings that arrive before a chargeback does. - description: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Resolution Center Case is opened by a buyer when something is wrong with a purchase — an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the two sides work it out directly, and Whop decides the case if they can't. Each case carries a reason, a status naming which side it is waiting on, a timeline of events, and the actions available to whoever is reading it. Use the Resolution Center Cases API from either side: as the buyer, open a case, reply, appeal a decision, or withdraw it; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. Both sides read the same case, page its timeline, and summarize the cases they can see. name: Resolution Center Cases x-whop-summary: File or respond to a case against a payment, as the buyer or the merchant. - description: > A Product is a digital good or service sold on Whop. Products may contain plans for pricing and/or experiences for content delivery. Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold. name: Products x-whop-summary: The things you sell. Each owns plans and a store page. - description: > A Plan defines how customers buy a product. It controls pricing, billing cadence, availability, tax behavior, checkout fields, and purchase visibility. Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered. name: Plans x-whop-summary: 'Pricing for a product: one-time, recurring, trials, stock.' - name: Promo Codes x-whop-summary: Discounts that creators configure for checkout. - description: > A Membership is a customer's purchase of a plan: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing. Use the Memberships API to list an account's memberships or the caller's own, retrieve one by ID or license key, invite a recipient to join through a free plan, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled period-end cancellation, pause and resume payment collection, extend with free days, generate a transfer link, and update metadata. name: Memberships x-whop-summary: A customer's purchase of a plan, from checkout through cancellation. - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a plan into a shareable, prefilled checkout link. - description: > A Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at `/.well-known/apple-developer-merchantid-domain-association` — and `status` reports whether verification has completed. Use the Payment Method Domains API to register domains for your account or its connected accounts, retry verification once the association file is hosted, and remove domains that should no longer serve wallet payments. A domain a platform shares with its connected accounts at checkout is listed on the platform's account, not on each connected account. name: Payment Method Domains x-whop-summary: >- Domains verified to show wallet payment methods like Apple Pay at checkout. - description: > A Shipment attaches a carrier tracking number to a payment and follows the package from label creation to delivery, exposing the current delivery status and a customer-facing tracking URL. Use the Shipments API to list an account's shipments, retrieve one by its id or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment. name: Shipments x-whop-summary: Track the delivery of an order by its carrier tracking number. - description: > The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard. Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- The users and businesses you referred to Whop, and what you earn from them. - description: > A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied. Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one. name: Bounty Submissions x-whop-summary: Work submitted to a bounty, from attempt to payout. - description: > A Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/beta/events/event) the person generated — pixel page views, ad clicks, leads, identifies, and payments. Each profile carries the person's known identities (names, emails, phones, user IDs), purchase history and LTV, geo/device profile, traffic sources, and the first and last marketing touches that reached them. Use the People API to list and segment the people of an account — filter by activity, purchases, traffic source, location, or marketing touch, and sort by value — or retrieve one person by person ID, user ID, email address, or phone number. name: People x-whop-summary: >- Visitors and customers of an account, with identity, purchase, and traffic profiles. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. The resource also exposes an anonymized read mode — the pulse feed — a platform-wide snapshot of recent purchases that carries nothing identifying. The pulse feed is public; other Events endpoints require authentication and are scoped to an account. Events are only as good as the pixel sending them, so [Validate Pixel](/api-reference/beta/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > A Recommended Action Chain is a short, ordered sequence of dashboard actions — create a product, price it, publish it — suggested for an account based on what it already has. Seeded chains come from hand-written presets; generated chains, produced per account, share the same shape. Use the Recommended Actions API to list the chains recommended for an account and to record that a chain was run. Running a chain executes nothing server-side — the client follows each step's CTA itself; the run endpoint records the `recommended_action_chain.executed` analytics event. name: Recommended Actions x-whop-summary: Suggested next-step action chains for an account. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. name: Ad Campaigns x-whop-summary: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences. Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > A Social Account represents an external profile connected to a Whop account or user, such as a Facebook page or Instagram account. Connecting a social account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts or a Facebook page's lead forms. name: Social Accounts x-whop-summary: Connected Facebook and Instagram accounts that run ads. - description: > An App is software you build on Whop. It can be a hosted web app served at `.whop.app` or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration, deploy an app's working copy and follow the run on the app's `deployment` field, and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' - description: > An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production. name: App Builds x-whop-summary: Versioned build artifacts deployed to an app's platforms. - description: > An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. Use the API Keys API to list an account or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key. name: API Keys x-whop-summary: Programmatic credentials for an account or app. - description: > A Permission is one action, such as `stats:read`, paired with whether your credential is granted it on a given resource. It answers for whatever you authenticated with, so you can decide what to show or attempt instead of discovering a `403`. Use the Permissions API to check an account, product, experience, or app, narrowing to the actions you care about. It reports only your own access — to manage who else can reach an account, use the Team Members API. name: Permissions x-whop-summary: What your credential is allowed to do on a resource. paths: /bounties: parameters: - $ref: '#/components/parameters/ApiVersionDate' post: tags: - Bounties summary: Create Bounty description: >- Creates a bounty and escrows its reward pool. Publishes immediately, or as a scheduled draft when you set `publish_at`. operationId: createBounty parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: content: application/json: schema: properties: accepted_submissions_limit: description: >- Number of submissions that can be accepted (winner slots). Defaults to 1. The escrowed total is `gross_reward_amount` times this limit and must be at least $5. example: 3 type: - integer - 'null' accepted_submissions_per_user_limit: description: >- How many winner slots one worker can win. Defaults to `1`. Wins plus proofs awaiting review never exceed this number, and a worker runs one attempt at a time. Cannot exceed `accepted_submissions_limit`. example: 2 minimum: 1 type: - integer - 'null' account_id: description: >- Account whose balance funds the bounty pool (`biz_` tag). Defaults to the caller's personal balance. Requires permission to move the account's funds. example: biz_xxxxxxxxxxxxxx type: - string - 'null' allowed_country_codes: description: >- Countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. items: example: US type: string type: - array - 'null' business_goal_type: description: >- What the poster wants the work to achieve, declared once here. enum: - clipping - post_engagement - owned_account_growth - ugc_content - local_activation - data_capture - other example: clipping type: string capture_spec: description: >- Per-bounty overrides of the served capture contract. Only accepted when `business_goal_type` is `data_capture`; omitted fields keep the platform defaults, and the resulting contract is echoed back as `capture_spec` on the bounty. properties: bitrate_target_mbps: description: >- Average bitrate the recorder encodes at, in megabits per second. Must sit within the served floor and ceiling. example: 12 type: integer embed_camera_metadata: description: >- Whether the recorder also writes camera make and model into the video container's metadata. example: true type: boolean frame_gap_tolerance_ms: description: >- Longest stall between consecutive frames a clip may contain before the client rejects it, in milliseconds. Unlike the recording fields this one can also be tuned after the bounty is created, since it bounds what is accepted rather than how footage is captured. example: 2000 type: integer min_clip_duration_seconds: description: Minimum length of a single clip, in seconds. example: 120 type: integer min_total_verified_duration_seconds: description: >- Total verified footage a submission must accumulate across all its clips before it can be submitted, in seconds. Must be a whole number of hours between 1 and 12. Editable after create, until someone starts an attempt. example: 14400 type: integer stabilization_mode: description: >- How the recorder configures video stabilization. `off` preserves raw motion for pose extraction. enum: - 'off' - 'on' - any example: 'off' type: string type: object description: description: Full task instructions shown to workers. example: >- Record one continuous pass of a full interior detail, dash to trunk, on a customer vehicle. type: string experience_id: description: >- Experience to host the bounty in (`exp_` tag). Any visibility — public for an open bounty, private for an invited one. Required unless account_id is set, in which case the bounty anchors in that account's public forum. example: exp_xxxxxxxxxxxxxx type: - string - 'null' frequency: description: >- How often the schedule creates a new bounty. Each occurrence is a separate bounty. Defaults to `once`; only applies with `publish_at`. enum: - once - hourly - daily - weekly - monthly example: weekly type: string gross_reward_amount: description: >- Gross bounty-pool amount (USD) escrowed per accepted submission, in whole dollars. Platform fees and affiliate shares are paid from this amount. example: 40 type: number publish_at: description: >- ISO 8601 time to publish the bounty. When set, the bounty is created as a hidden draft and funded + published at this time instead of immediately. example: '2026-01-01T12:00:00.000Z' type: - string - 'null' publish_at_timezone: description: >- IANA timezone for recurring occurrences. Required when publish_at is set. example: America/Chicago type: - string - 'null' title: description: Short name of the task shown to workers. example: Record interior detailing passes type: string required: - title - description - gross_reward_amount type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/Bounty' description: bounty created '400': $ref: '#/components/responses/InvalidParameters' description: missing reward amount '403': $ref: '#/components/responses/Forbidden' description: credential cannot fund the requested account '409': $ref: '#/components/responses/Conflict' security: - bearerAuth: - bounty:create - bearerAuth: - payout:transfer_funds x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const bounty = await client.bounties.create({ description: 'Record one continuous pass of a full interior detail, dash to trunk, on a customer vehicle.', gross_reward_amount: 40, title: 'Record interior detailing passes', }); console.log(bounty.id); components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: '2026-08-21' type: string IdempotencyKey: description: >- A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). in: header name: Idempotency-Key required: false schema: example: d9105228-4a08-46b1-8b91-42fed586d383 maxLength: 255 type: string schemas: Bounty: properties: accepted_deliverable_types: items: description: >- The deliverable shapes this bounty accepts. Every bounty accepts any combination of `content_url` (posted links) and `media` (uploaded files), except `data_capture` bounties, whose proof is clips recorded in the Whop app that accumulate on the attempt. enum: - content_url - media - data_capture example: data_capture type: string type: array accepted_submissions_count: description: Submissions accepted so far. example: 0 type: integer accepted_submissions_limit: description: Number of submissions that can be accepted (winner slots). example: 3 type: integer accepted_submissions_per_user_limit: description: >- How many winner slots one worker can win. Defaults to `1`. Wins plus proofs awaiting review never exceed this number, and a worker runs one attempt at a time. Cannot exceed `accepted_submissions_limit`. example: 1 type: integer affiliate_share_amount: description: >- What a referrer earns per accepted submission when the worker arrived through their affiliate link, in whole currency units, at the standard platform fee rate. Taken out of the worker's post-fee reward rather than added on top. `0` when the bounty pays no affiliate share, including bounties tied to no account, which cannot record a referral. example: 5.6 type: number allowed_country_codes: items: description: >- Countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. example: US type: string type: array budget_amount: description: >- Total gross budget committed to the bounty: `gross_reward_amount` times `accepted_submissions_limit`. example: 120 type: number business_goal_type: description: >- What the poster wants the work to achieve, declared once at create. `null` for bounties created before the taxonomy rolled out. enum: - clipping - post_engagement - owned_account_growth - ugc_content - local_activation - data_capture - other - null example: data_capture type: - string - 'null' cancel_requested_at: description: >- When cancellation was requested, as an ISO 8601 timestamp. On a `closed` bounty this means the cancel is pending: submissions are stopped and the bounty cancels once in-flight submissions resolve. On a `canceled` bounty it records when the cancellation was requested. `null` when no cancellation was ever requested. example: '2026-01-01T12:00:00.000Z' type: - string - 'null' capture_spec: description: >- The technical contract footage must be recorded against. Present only on `data_capture` bounties; `null` for every other goal type. oneOf: - $ref: '#/components/schemas/CaptureSpec' - type: 'null' created_at: description: When the bounty was created, as an ISO 8601 timestamp. example: '2026-01-01T12:00:00.000Z' type: string currency: description: >- Currency for all amounts on the bounty, as a lowercase ISO 4217 code. enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - cny - kzt - awg example: usd type: string description: description: Full task instructions shown to workers. example: >- Record one continuous pass of a full interior detail, dash to trunk, on a customer vehicle. type: string discussion_experience_id: description: >- Experience the bounty's discussion thread lives in, prefixed `exp_`. Read this — not `experience_id` — to open the thread: a platform-wide bounty has no hosting experience of its own but its discussion still lives in one. type: - string - 'null' discussion_feed_id: description: >- Forum feed containing the bounty's discussion thread. `null` for a bounty with no forum post. type: - string - 'null' discussion_post_id: description: >- Forum post anchoring the bounty's discussion thread. Read together with `discussion_experience_id` to address the thread. `null` for a bounty with no forum post. type: - string - 'null' experience_id: description: >- Experience the bounty is hosted in, prefixed `exp_`. `null` for platform-wide bounties; may belong to a different account than the funder. example: exp_xxxxxxxxxxxxxx type: - string - 'null' funding_account: description: >- Account whose balance funds the bounty pool, or `null` when a user funds it personally. May differ from the account hosting `experience_id`. oneOf: - $ref: '#/components/schemas/AccountSummary' - type: 'null' gross_paid_out_amount: description: >- Gross amount paid out from the bounty pool across accepted submissions — worker payouts, platform fees, and affiliate shares together. Tips and reviewer rewards are excluded. example: 0 type: number gross_reward_amount: description: >- Gross bounty-pool amount allocated per accepted submission, in whole currency units. example: 40 type: number hosting_account: description: >- Account hosting the bounty's forum — the one whose `route` and `experience_id` address its discussion thread, and where its submissions dashboard lives. `null` for a platform-wide bounty with no host. May differ from `funding_account`. oneOf: - $ref: '#/components/schemas/StorefrontAccount' - type: 'null' id: description: Bounty ID, prefixed `bnty_`. example: bnty_xxxxxxxxxxxxxx type: string net_reward_amount: description: >- What a worker is quoted per accepted submission after the platform fee, in whole currency units. The exact post-fee figure, at the standard platform fee rate — a worker who locked a different rate, or who arrived through an affiliate link, is paid a different amount. example: 28 type: number poster: $ref: '#/components/schemas/UserSummary' description: >- User who posted the bounty — the account owner when created with an account API key. scheduled_frequency: description: >- How often the schedule creates a new bounty. Each occurrence is a separate bounty; the original is not republished. enum: - once - hourly - daily - weekly - monthly - null example: weekly type: - string - 'null' scheduled_publish_at: description: >- When a scheduled bounty will publish, as an ISO 8601 timestamp. `null` once published, for bounties that were never scheduled, and for terminally failed drafts parked for manual rescheduling. example: '2026-01-01T12:00:00.000Z' type: - string - 'null' spots_remaining: description: >- Unfilled winner capacity: `accepted_submissions_limit` minus `accepted_submissions_count`, clamped to zero. Not on its own a signal that the bounty accepts new claims — read `status` for that: only an `open` bounty takes new submissions. example: 3 type: integer status: description: >- Lifecycle state. `scheduled` bounties are unpublished drafts, visible to their poster and the account's authorized managers; `open` bounties accept new submissions; `closed` bounties are live but no longer accept new submissions; `completed` bounties paid out every winner slot; `canceled` bounties ended before filling their slots. enum: - scheduled - open - closed - completed - canceled example: scheduled type: string submissions_closed_at: description: >- When new submissions stopped being accepted, as an ISO 8601 timestamp. Set when a cancellation is requested on a bounty with work in flight, so in-flight submissions can resolve before the bounty cancels. `null` when submissions were never stopped — including completed bounties that simply filled every winner slot. example: '2026-01-01T12:00:00.000Z' type: - string - 'null' title: description: Short name of the task shown to workers. example: Record interior detailing passes type: string unresolved_submissions_count: description: >- Submissions still awaiting an outcome: in progress or pending review. example: 0 type: integer updated_at: description: When the bounty was last updated, as an ISO 8601 timestamp. example: '2026-01-01T12:00:00.000Z' type: string viewer_accepted_submissions_count: description: >- How many winner slots the authenticated user has already won on this bounty. Read against `accepted_submissions_per_user_limit` to show a worker their remaining allowance. `0` when the request has no authenticated user. example: 0 type: integer required: - id - title - description - status - currency - gross_reward_amount - net_reward_amount - affiliate_share_amount - budget_amount - gross_paid_out_amount - accepted_submissions_limit - accepted_submissions_per_user_limit - accepted_submissions_count - unresolved_submissions_count - viewer_accepted_submissions_count - spots_remaining - business_goal_type - accepted_deliverable_types - allowed_country_codes - submissions_closed_at - cancel_requested_at - scheduled_publish_at - scheduled_frequency - experience_id - discussion_post_id - discussion_feed_id - discussion_experience_id - created_at - updated_at - capture_spec - poster - funding_account - hosting_account type: object CaptureSpec: properties: filename_pattern: description: >- The naming convention for uploaded files, built from the required metadata fields. example: Country_City_Site_Station_Operator type: string imu: $ref: '#/components/schemas/CaptureSpecImu' description: Inertial measurement unit (IMU) recording requirements. manifest_schema_version: description: >- Schema version the client must stamp on the capture manifest it uploads. example: 2 type: integer min_clip_duration_seconds: description: Minimum length of a single clip, in seconds. example: 120 type: integer min_total_verified_duration_seconds: description: >- Total verified footage a submission must accumulate across all its clips before it can be submitted, in seconds. Always a whole number of hours. example: 14400 type: integer required_metadata_fields: items: description: >- Metadata fields a submission must provide, matching the `metadata` object on the submissions API. example: country type: string type: array single_continuous_take: description: >- Whether each clip must be one uninterrupted recording rather than stitched segments. example: true type: boolean video: $ref: '#/components/schemas/CaptureSpecVideo' description: Video recording requirements. required: - manifest_schema_version - video - imu - min_clip_duration_seconds - min_total_verified_duration_seconds - single_continuous_take - required_metadata_fields - filename_pattern type: object AccountSummary: properties: id: description: Account ID, prefixed `biz_`. example: biz_xxxxxxxxxxxxxx type: string title: description: Account display name. example: Shine Time Auto Detailing type: string required: - id - title type: object StorefrontAccount: properties: id: description: Account ID, prefixed `biz_`. example: biz_xxxxxxxxxxxxxx type: string route: description: >- Account public route identifier — the `whop.com/{route}` storefront path. example: shine-time-auto-detailing type: string title: description: Account display name. example: Shine Time Auto Detailing type: string required: - id - title - route type: object UserSummary: properties: id: description: User ID, prefixed `user_`. example: user_xxxxxxxxxxxxxx type: string name: description: Display name. example: Dana Whitfield type: - string - 'null' profile_picture: $ref: '#/components/schemas/UserProfilePicture' description: >- Avatar wrapper; its `url` is always present, using a generated placeholder when the user set no picture. username: description: Public username. example: danawhitfield type: string required: - id - username - name - profile_picture type: object V1ErrorResponse: properties: error: properties: code: description: >- Machine-readable reason for this specific refusal, such as `bank_warning_not_acknowledged`. Only present when the error carries one. type: string message: description: Human-readable error message. example: account_id is required type: string type: description: Machine-readable error code. example: bad_request type: string required: - type - message type: object required: - error type: object CaptureSpecImu: properties: device_motion_units: description: Units for the device-motion channels, as a compact key=unit string. example: ua=m/s²,gv=g,r=rad/s,q=unit type: string magnetometer_units: description: Units for the magnetometer channel. example: µT type: string min_rate_hz: description: >- Minimum sustained IMU sample rate in hertz for a clip to pass validation. example: 90 type: number target_rate_hz: description: Target IMU sample rate in hertz. example: 100 type: integer warmup_min_rate_hz: description: Minimum IMU sample rate in hertz tolerated during the warmup window. example: 45 type: number warmup_ns: description: >- Startup window, in nanoseconds, during which the relaxed warmup rate applies. example: 3000000000 type: integer required: - target_rate_hz - min_rate_hz - warmup_ns - warmup_min_rate_hz - device_motion_units - magnetometer_units type: object CaptureSpecVideo: properties: bitrate_ceiling_mbps: description: Maximum acceptable average bitrate, in megabits per second. example: 50 type: integer bitrate_floor_mbps: description: Minimum acceptable average bitrate, in megabits per second. example: 4 type: integer bitrate_target_mbps: description: Recommended average bitrate to encode at, in megabits per second. example: 12 type: integer camera_lens: description: Which physical lens to record with. example: ultra_wide type: string codecs: items: description: Accepted video codecs, in preference order. example: h264 type: string type: array embed_camera_metadata: description: >- Whether the client must also write the camera make and model into the video container's metadata. When `false`, the capture manifest and export CSV are the metadata carrier. example: false type: boolean fps: description: Target capture frame rate. example: 30 type: integer frame_gap_tolerance_ms: description: >- Longest stall between consecutive frames a clip may contain before the client rejects it, in milliseconds. Every frame is timestamped in the frame log, so a stall stays alignable downstream — this bounds how broken a capture may be, not how evenly it must be paced. example: 1000 type: integer height: description: >- Required frame height in pixels — recorded footage must match exactly. example: 1080 type: integer min_fov_degrees: description: Minimum acceptable horizontal field of view, in degrees. example: 130 type: integer orientation: description: Device orientation to record in. example: landscapeRight type: string preferred_fov_degrees: description: Preferred horizontal field of view, in degrees. example: 140 type: integer stabilization_mode: description: >- How the client must configure video stabilization: `off` disables EIS so raw motion is preserved for pose extraction, `on` requires it, `any` leaves the device default. enum: - 'off' - 'on' - any example: 'off' type: string stabilization_required: description: >- Whether hardware/software stabilization must be enabled. True exactly when stabilization_mode is `on`. example: false type: boolean width: description: >- Required frame width in pixels — recorded footage must match exactly. example: 1920 type: integer required: - codecs - width - height - fps - bitrate_floor_mbps - bitrate_ceiling_mbps - bitrate_target_mbps - min_fov_degrees - preferred_fov_degrees - camera_lens - orientation - stabilization_required - stabilization_mode - embed_camera_metadata - frame_gap_tolerance_ms type: object UserProfilePicture: properties: url: description: >- Avatar image URL. Always present — a generated placeholder when the user set no picture. example: https://ui-avatars.com/api/ type: string required: - url type: object responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters Forbidden: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Forbidden Conflict: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Conflict securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````