whoamiRead · any key
Identify the workspace, plan, scopes and permissions of the connected Croud API key. Call this first to learn which side (creator / advertiser) the workspace operates on.get_usageRead · any key
AI credit balance and this period's API / MCP / AI generation usage for the workspace.list_formatsRead · templates:read
List Instagram ad formats (feed image, carousel, reel, story…) with specs and whether this workspace can launch them.list_templatesRead · templates:read
List content templates (caption structure, hashtags, CTA, media guidance) available to this workspace. Filter by format, source or category.get_workspaceRead · any key
Read the workspace profile (name, logo, website, Instagram username, description, industry, country, time zone).update_workspaceWrite · workspace:write
Update the workspace profile: name, logo URL, website, Instagram username, description, industry, country or time zone. Omitted fields are unchanged.list_membersRead · members:read
List workspace members with their role, teams and status.list_invitationsRead · members:read
List pending and expired workspace invitations.invite_membersWrite · members:write
Email workspace invitations to one or more addresses with a role (system role key or custom role id).resend_invitationWrite · members:write
Email a pending or expired workspace invitation again with a fresh 7-day link.revoke_invitationDestructive · members:write
Cancel a pending workspace invitation so its link stops working.update_memberWrite · members:write
Change a workspace member's role (system role key or custom role id), access scope or teams.remove_memberDestructive · members:write
Remove a member from the workspace (revokes the API keys they created).list_webhooksRead · webhooks:write
List the workspace's webhook endpoints, their events and recent delivery counts.create_webhookWrite · webhooks:write
Register an https webhook endpoint for event types; returns its signing secret once.get_webhookRead · webhooks:write
Get one webhook endpoint.update_webhookWrite · webhooks:write
Change a webhook endpoint's URL, description, events or enabled state.delete_webhookDestructive · webhooks:write
Delete a webhook endpoint and its delivery history.test_webhookWrite · webhooks:write
Send a signed test event to a webhook endpoint and report whether it answered 2xx.get_templateRead · templates:read
Get one caption template (structure, hashtags, CTA, variables).create_templateWrite · templates:write
Create a workspace caption template (format, caption with {{variables}}, hashtags, CTA), as a draft or published.update_templateWrite · templates:write
Edit a workspace caption template; omitted fields are unchanged.publish_templateWrite · templates:write
Publish a workspace caption template so it can be used in creatives.unpublish_templateWrite · templates:write
Move a workspace caption template back to draft (also restores an archived one).archive_templateWrite · templates:write
Archive a workspace caption template (can be restored or deleted).delete_templateDestructive · templates:write
Permanently delete an archived workspace caption template.list_mediaRead · creatives:read
List images and videos in the media library (filter by type, folder or name).add_media_from_urlWrite · creatives:write
Download a public image or video URL into the media library so creatives can use it.delete_mediaDestructive · creatives:write
Delete an unused file from the media library.list_campaignsRead · campaigns:read
List the workspace's advertiser campaigns with status, budget, placement counts and reach. Filter by status (e.g. live, draft, paused).create_campaignWrite · campaigns:write
Create a draft advertiser campaign (name, type targeted/open/direct, objective, ad category, optional budget, open-offer price and acceptance mode, collab settings, schedule, targeting, brand kit and unique posts per creator via variants_enabled + variant_config). It is not launched.get_campaignRead · campaigns:read
Get a campaign with its creatives, placements and performance totals.update_campaignWrite · campaigns:write
Update campaign fields such as budget, schedule, targeting or landing URL (running campaigns allow a limited set).delete_campaignDestructive · campaigns:write
Delete a draft campaign that never launched.archive_campaignWrite · campaigns:write
Archive a draft, completed or canceled campaign.duplicate_campaignWrite · campaigns:write
Copy a campaign (settings, targeting, creatives) into a new draft.get_campaign_readinessRead · campaigns:read
Check whether a campaign can launch: blocking issues, warnings, wallet coverage and the placement estimate.launch_campaignDestructive · campaigns:write
Launch a draft campaign. Requires ready creatives, a budget and enough wallet balance; creates placement requests to matching creators. Spends real money once creators approve.pause_campaignWrite · campaigns:write
Pause an active or scheduled campaign (no new placement requests).resume_campaignDestructive · campaigns:write
Resume a paused campaign; newly eligible creators receive requests.cancel_campaignDestructive · campaigns:write
Cancel a campaign and all of its unpublished placements. Irreversible.preview_campaign_matchesRead · campaigns:read
Dry-run which creator accounts a campaign would match, with price and the reasons ineligible accounts are excluded.list_creativesRead · creatives:read
List ad creatives (caption, hashtags, media, format, status). Filter by campaign, format or status.create_creativeWrite · creatives:write
Create an ad creative (format, caption, hashtags, CTA, link, media URLs), optionally attached to a campaign. status=ready validates it against the format specs.get_creativeRead · creatives:read
Get one ad creative.update_creativeWrite · creatives:write
Edit a creative's caption, hashtags, media, CTA or status (draft, ready, archived).delete_creativeDestructive · creatives:write
Permanently delete an unused creative.duplicate_creativeWrite · creatives:write
Copy a creative into a new draft, optionally for another campaign.attach_creative_to_campaignWrite · creatives:write
Add an existing library creative to a campaign (creatives already used by another campaign are copied).detach_creative_from_campaignWrite · creatives:write
Move a creative out of a campaign back to the library (refused while it has open placements).render_templateWrite · creatives:write
Fill a content template's variables to get caption, hashtags and CTA for a new creative.list_campaign_variantsRead · campaigns:read
List the unique per-creator posts (variants) of a campaign with their review status, angle, uniqueness score and placement.approve_all_variantsWrite · campaigns:write
Approve every unique post waiting for review in a campaign so they are sent to the creators.approve_variantWrite · campaigns:write
Approve one creator's unique post so it is sent to the creator.update_variantWrite · campaigns:write
Edit a unique post's caption, hashtags and CTA while it is in review or the creator asked for changes.regenerate_variantWrite · campaigns:write
Rewrite a creator's unique post in the background, optionally with a different angle, design template or notes. Uses AI credits.use_base_creativeDestructive · campaigns:write
Skip a creator's unique post and send the campaign's base creative instead.list_brand_kitsRead · creatives:read
List the workspace's brand kits (colors, fonts, logos, handle). The default kit is first.create_brand_kitWrite · creatives:write
Create a brand kit: name, five hex colors (dark, light, accent, accent_ink, secondary), display/body/mono fonts, optional logos, handle and website.get_brand_kitRead · creatives:read
Get one brand kit with color contrast warnings.update_brand_kitWrite · creatives:write
Edit a brand kit's colors, fonts, logos, handle, website or radius.delete_brand_kitDestructive · creatives:write
Delete a brand kit; designs and campaigns using it move to the next kit.set_default_brand_kitWrite · creatives:write
Make a brand kit the workspace default.list_design_templatesRead · creatives:read
List visual design templates (carousels, single posts, stories) with category, supported formats and whether this workspace can use them.get_design_templateRead · creatives:read
Get one design template with its sample slides and available layouts.update_design_templateWrite · templates:write
Rename a custom (workspace) design template or change its description, category or tags.list_layoutsRead · creatives:read or templates:read
List slide layouts (cover, list, quote, stat, cta…) with their content fields and limits, and the canvas formats.list_designsRead · creatives:read
List designs (branded carousels, posts, stories). Filter by campaign, template, brand kit or status.create_designWrite · creatives:write
Create a branded design from a design template; with `brief`, AI writes the slides, caption and hashtags (uses AI credits).get_designRead · creatives:read
Get one design with its slides, caption and hashtags.update_designWrite · creatives:write
Edit a design: slides, caption, hashtags, format, brand kit, campaign, persona, content type or status (draft, ready, archived).delete_designDestructive · creatives:write
Permanently delete a design and its export files.duplicate_designWrite · creatives:write
Copy a design into a new draft.write_design_with_aiWrite · creatives:write
Have AI write a design's slides, caption and hashtags from a brief (uses AI credits). apply=false returns a draft without saving.rewrite_design_slidesWrite · creatives:write
Rewrite some slides of a design with AI (shorter, punchier, more casual, fix overflow, or an instruction), keeping layouts and images. Uses AI credits.design_caption_optionsWrite · creatives:write
Get AI caption options (with hashtags) for a design's slides. Nothing is saved; update the design with the one you pick. Uses AI credits.export_designWrite · creatives:write
Render a design to PNG/JPG/ZIP/PDF (counts toward the monthly export limit). Returns download URLs; save_to_library also adds the images to the media library.list_design_exportsRead · creatives:read
List a design's recent exports with status and download URLs.get_design_exportRead · creatives:read
Check an export's status and get its download URLs.save_design_as_creativeWrite · creatives:write
Turn a design into a draft ad creative (feed image, carousel or story) with its slides as media.list_placementsRead · placements:read
List placements (ad requests). side=creator lists requests on the workspace's Instagram accounts (filter status=pending_approval for the review inbox); side=advertiser lists placements of the workspace's campaigns.get_placementRead · placements:read
Get one placement with its creative (caption, hashtags, media), campaign, advertiser and status.approve_placementDestructive · placements:write
Approve an ad request on one of the workspace's accounts. It is then scheduled for publishing automatically.reject_placementDestructive · placements:write
Decline an ad request with a reason shown to the advertiser.request_placement_changesWrite · placements:write
Ask the advertiser to change an ad request (e.g. caption edits) before you approve it.resubmit_placementWrite · campaigns:write
Advertiser: send a placement in changes_requested back to the creator after updating its creative.cancel_placementDestructive · campaigns:write
Advertiser: cancel a placement that has not been published yet.list_placement_messagesRead · placements:read
Read the creator/advertiser conversation on a placement.send_placement_messageWrite · placements:write or campaigns:write
Send a message to the other party on a placement.counter_direct_requestWrite · placements:write
Creator: reply to a direct request with your own price. The advertiser then accepts, declines or counters back.list_opportunitiesRead · accounts:read or placements:read
Creator: list open campaigns the workspace's accounts can accept, with price, earning, requirements, creatives and per-account fit.get_opportunityRead · accounts:read or placements:read
Creator: get one open campaign with its creatives, requirements and which of your accounts can accept it.accept_opportunityDestructive · placements:write
Creator: accept an open campaign with one account and creative. Instant campaigns book immediately; review campaigns create an application.preview_direct_requestRead · marketplace:read
Advertiser: check whether a creator takes direct requests, their rates, and warnings for a campaign/creative/price before sending.list_requestable_campaignsRead · campaigns:read
Advertiser: campaigns and ready creatives that a direct request can be sent for, with remaining budget.send_direct_requestDestructive · campaigns:write
Advertiser: send a creator a request for one campaign creative at your price. Reserves the amount from the wallet; spends money once the creator approves.list_sent_requestsRead · campaigns:read
Advertiser: list direct requests and open-campaign applications; status=action shows counter-offers and applications waiting on you.get_sent_requestRead · campaigns:read
Advertiser: get a direct request or application with negotiation state, available actions and messages.respond_to_counter_offerDestructive · campaigns:write
Advertiser: accept, decline or counter a creator's counter-offer on a direct request. Accepting books the post at the counter price.review_applicationDestructive · campaigns:write
Advertiser: approve or decline a creator's application to an open campaign that requires review.get_reference_dataRead · any key
List valid keys for content categories, ad categories, countries, campaign objectives, decline reasons, creative angles (for unique posts per creator), content types (AI writing rules per kind of post) or persona tones.list_accountsRead · accounts:read
List the workspace's connected Instagram creator accounts with followers, engagement, approval mode and pending request counts.get_accountRead · accounts:read
Get a connected account with its full ad policy (content rules, requirements, approval mode) and rate cards.update_account_settingsWrite · accounts:write
Change an account's marketplace listing, purpose or team.get_account_policyRead · accounts:read
Get an account's ad policy: accepted categories, blocked keywords, minimum price, pacing, posting windows and approval mode.update_account_policyWrite · accounts:write
Update which ads an account accepts (categories, keywords, advertisers, formats, disclosure, AI content). Omitted fields are unchanged.update_account_requirementsWrite · accounts:write
Update an account's minimum price/budget, lead time, frequency caps, approval SLA and posting windows. Omitted fields are unchanged.update_approval_settingsWrite · accounts:write
Set an account's approval mode (manual, rules, auto), optional auto-approval rules, and who may send direct requests (anyone, eligible_only, off).list_rate_cardsRead · accounts:read
Get an account's price per post for each ad format.update_rate_cardsWrite · accounts:write
Set an account's price per post for one or more formats: automatic (suggested) or manual price in cents (minimum 500), plus optional collab add-on. Omitted fields keep their current values.get_account_insightsRead · accounts:read
Get an account's analyzed content categories, description, recent-post stats and suggested price per format with the pricing breakdown.update_account_profileWrite · accounts:write
Set an account's content categories or advertiser-facing description (marked manual), or reset either to the analysis results.analyze_accountWrite · accounts:write
Queue a fresh analysis of an account's recent posts; results arrive via get_account_insights or the account.analyzed webhook.sync_accountWrite · connections:write
Refresh a connected account's followers, engagement and profile from Instagram.disconnect_accountDestructive · connections:write
Disconnect a connected Instagram account; open and scheduled placements on it are closed.generate_contentWrite · ai:generate
Generate Instagram copy (caption, hashtags, ideas, script, rewrite, image prompt) using the brand's saved details. Pass content_type (e.g. education, promo, ugc) for the right length, hashtags and voice; omit persona_id to let the content type pick the voice; pass campaign_id to write for a campaign's objective and landing page. Omit model for automatic routing, or pass a ref from list_ai_models (e.g. openrouter:anthropic/claude-haiku-5.5) to pick one. Consumes AI credits (times the model's multiplier) unless it runs on the workspace's own key.list_ai_modelsRead · ai:generate
List the AI models this workspace can use (platform credits or its own keys), with credits per generation kind. Pass a model's ref as `model` to generate_content.list_ai_providersRead · ai:generate
List the AI providers a workspace can add its own key for, with key hints and models.list_generationsRead · ai:generate
List previous AI generations with their outputs.search_creatorsRead · marketplace:read
Search the creator marketplace by niche, country, followers, engagement, format, price, approval mode, availability and collab support.get_creator_profileRead · marketplace:read
Get a marketplace creator's stats, audience, rate card, track record and policy summary.get_analyticsRead · analytics:read
Advertiser (spend, reach, engagement, clicks) or creator (earnings, approvals) analytics for 7, 30 or 90 days.list_personasRead · personas:read
List voices available for AI generation: the workspace's personas and the platform voices (platform: true). Each has tone, do/don't lists and sample posts.get_personaRead · personas:read
Get one brand voice persona.create_personaWrite · personas:write
Create a brand voice persona (tone, formality, emoji and hashtag style, do/don't lists, sample posts).update_personaWrite · personas:write
Edit a persona's voice settings. Omitted fields are unchanged.duplicate_personaWrite · personas:write
Copy a persona or platform voice into the workspace so it can be edited.archive_personaWrite · personas:write
Archive a workspace persona so it's no longer used for AI generation (can be restored).restore_personaWrite · personas:write
Restore an archived workspace persona.set_default_personaWrite · personas:write
Make an active workspace persona the default voice for AI generation.delete_personaDestructive · personas:write
Permanently delete an archived workspace persona.get_content_type_voicesRead · personas:read
Which persona writes each content type when generation is on Auto, and the platform default for each.set_content_type_voicesWrite · personas:write
Pick which persona writes each content type when generation is on Auto (null = platform default).get_walletRead · wallet:read or analytics:read
Wallet balances: available funds, reserved holds, pending earnings and lifetime totals (in cents).list_wallet_transactionsRead · wallet:read or analytics:read
Wallet ledger entries (deposits, holds, charges, earnings, payouts), newest first, with cursor pagination.list_payoutsRead · wallet:read
Creator payout requests and their status, newest first.list_payout_methodsRead · wallet:read
Payout methods creators can choose (admin-managed), with what `destination` to send and the usual processing time. Automatic methods (Stripe) need a connected Stripe account.request_payoutDestructive · payouts:write
Request a payout of settled creator earnings.cancel_payoutDestructive · payouts:write
Cancel a payout that is still `pending` (not yet approved). The amount returns to the withdrawable balance.open_disputeWrite · placements:write or campaigns:write
Report a problem with a booked post (removed early, not as approved, payment not released…).list_disputesRead · placements:read
Disputes on this workspace's placements (as advertiser or creator), newest first.