> ## Documentation Index > Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt > Use this file to discover all available pages before exploring further. # Enrich selected creators, or the first creators of a search, into a creator list > Converts the creators in `creator_refs`, or the first `count` creators of `search`, into leads with their email in a new creator list (`list_name`) or an existing one (`batch_id`). Runs in the background: follow it with `GET /creator-search/outreach-batches/{id}`. Costs 25 credits per creator whose email is found, plus 35 for insights (`tier: full`) and 15 for brand collaborations; nothing for a creator without an email, and nothing again for what the workspace already bought. The most it may charge is held until it ends (`reserved_credits`); 402 when the balance cannot cover it. A request repeated with the same `idempotency_key` is not run twice. With `campaign_id`, the creators with a valid email also go to that campaign; 403 with `leadsRemaining` when the plan cannot take every creator who may have an email. Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `all:create`, `all:all` ## OpenAPI ````yaml https://api.instantly.ai/openapi/api_v2.json post /api/v2/creator-search/outreach-batches openapi: 3.1.0 info: title: API Explorer description: >- The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the `ApiKeyAuth_token` blue text. version: 2.0.0 servers: - url: https://api.instantly.ai description: Instantly API Server security: - ApiKeyAuth: [] tags: - name: Analytics description: Endpoints related to analytics x-group: Analytics - name: OAuth description: >- OAuth authentication endpoints for connecting Google and Microsoft email accounts x-group: OAuth - name: Account description: An email account that can be used to send campaigns x-group: Account - name: Campaign description: A campaign that can be sent to a list of recipients x-group: Campaign - name: Email description: >- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox x-group: Email - name: EmailVerification description: A single email verification x-group: Email Verification - name: LeadList description: A list used to store leads x-group: Lead List - name: InboxPlacementTest description: An inbox placement test x-group: Inbox Placement Test - name: InboxPlacementAnalytics description: Analytics data for individual emails in inbox placement tests x-group: Inbox Placement Analytics - name: InboxPlacementBlacklistAndSpamAssassinReport description: Report data for an inbox placement test x-group: Inbox Placement Blacklist And SpamAssassin Report - name: AIInboxManager description: An AI Inbox Manager agent x-group: AI Inbox Manager - name: AIDeliverabilityAgent description: An AI Deliverability Agent x-group: AI Deliverability Agent - name: AILeadFinderAgent description: An AI Lead Finder Agent x-group: AI Lead Finder Agent - name: LocalBusiness description: >- A local business found by the Local businesses search. Search businesses by category and location, then convert them into leads with a verified email in a lead list or a campaign. x-group: Local Business - name: Creator description: >- A social media creator found by the Creators search. Search creators by platform, niche, audience and location, then convert them into leads with their email. x-group: Creator - name: APIKey description: API Key x-group: API Key - name: AccountCampaignMapping description: Account Campaign Mapping x-group: Account Campaign Mapping - name: Lead description: A lead entity representing an individual lead x-group: Lead - name: BackgroundJob description: A background job that can be used to perform long-running tasks x-group: Background Job - name: CustomTag description: >- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. x-group: Custom Tag - name: CustomTagMapping description: >- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. x-group: Custom Tag Mapping - name: BlockListEntry description: A blocked email or domain x-group: Block List Entry - name: LeadLabel description: A custom label for categorizing and managing leads x-group: Lead Label - name: Workspace description: A workspace entity representing a workspace x-group: Workspace - name: SuperSearchEnrichment description: >- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. x-group: SuperSearch Enrichment - name: WorkspaceGroupMember description: >- A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group. x-group: Workspace Group Member - name: WorkspaceMember description: A member of a workspace with associated user details x-group: Workspace Member - name: CampaignSubsequence description: A subsequence entity representing a follow-up sequence x-group: Campaign Subsequence - name: AuditLog description: Audit log records for tracking system activities x-group: Audit Log - name: AISalesAgent description: >- An AI Sales Development Representative that autonomously manages outreach campaigns x-group: AI Sales Agent - name: Webhook description: A webhook subscription for receiving event notifications x-group: Webhook - name: WebhookEvent description: A webhook event that was sent or attempted to be sent x-group: Webhook Event - name: DFYEmailAccountOrder description: A Done-For-You email account order x-group: DFY Email Account Order - name: DomainForwarding description: Web forwarding configuration for a domain ordered through Instantly x-group: Domain Forwarding - name: CustomPromptTemplate description: Custom prompt templates for creating custom prompts x-group: Custom Prompt Template - name: SalesFlow description: >- Manages how sales users view and interact with campaign and lead lists within the sales flow. x-group: Sales Flow - name: EmailTemplate description: A campaign email template x-group: Email Template - name: WorkspaceBilling description: Workspace Billing x-group: Workspace Billing - name: CRMActions description: CRM related actions x-group: CRM Actions - name: EngageItem description: >- A unified Engage item representing a campaign, AI agent, automation workflow, broadcast, or journey. x-group: Engage Item paths: /api/v2/creator-search/outreach-batches: post: tags: - Creator summary: >- Enrich selected creators, or the first creators of a search, into a creator list description: >- Converts the creators in `creator_refs`, or the first `count` creators of `search`, into leads with their email in a new creator list (`list_name`) or an existing one (`batch_id`). Runs in the background: follow it with `GET /creator-search/outreach-batches/{id}`. Costs 25 credits per creator whose email is found, plus 35 for insights (`tier: full`) and 15 for brand collaborations; nothing for a creator without an email, and nothing again for what the workspace already bought. The most it may charge is held until it ends (`reserved_credits`); 402 when the balance cannot cover it. A request repeated with the same `idempotency_key` is not run twice. With `campaign_id`, the creators with a valid email also go to that campaign; 403 with `leadsRemaining` when the plan cannot take every creator who may have an email. Requires one of the following scopes: `supersearch_enrichments:create`, `supersearch_enrichments:all`, `all:create`, `all:all` operationId: createCreatorOutreachBatch requestBody: content: application/json: schema: type: object additionalProperties: false required: - platform - search_kind - list_name - idempotency_key properties: tier: type: string enum: - email - full collaborations: type: boolean send_to_agent: type: boolean campaign_id: type: string format: uuid description: >- Also add the creators with a valid email to this campaign once their emails are checked. Needs a new list (`list_name`); progress is in `run.campaign`. platform: type: string enum: - all - instagram - tiktok - youtube batch_id: type: string format: uuid search_kind: type: string enum: - structured - ai_text - lookalike - result_image - image_upload query: type: string maxLength: 2000 filters: type: object additionalProperties: false default: {} properties: creator: type: string maxLength: 255 locations: type: array maxItems: 20 items: anyOf: - type: string minLength: 1 - type: number languages: type: array maxItems: 10 items: type: string minLength: 1 maxLength: 20 followers: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 engagement_rate: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 average_views: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 growth_rate: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 posting_frequency: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 last_posted_days: type: integer minimum: 0 maximum: 3650 interests: type: array maxItems: 20 items: anyOf: - type: string minLength: 1 - type: number hashtags: type: array maxItems: 30 items: type: string minLength: 1 maxLength: 100 bio: type: string maxLength: 1000 account_type: type: string enum: - creator - business - regular verified: type: boolean has_email: type: boolean authenticity_min: type: number minimum: 0 maximum: 1 brand_ids: type: array maxItems: 20 items: anyOf: - type: string minLength: 1 - type: number audience_locations: type: array maxItems: 20 items: type: object additionalProperties: false required: - id properties: id: anyOf: - type: string minLength: 1 - type: number weight: type: number minimum: 0 maximum: 1 audience_languages: type: array maxItems: 10 items: type: object additionalProperties: false required: - id properties: id: anyOf: - type: string minLength: 1 - type: number weight: type: number minimum: 0 maximum: 1 audience_interests: type: array maxItems: 20 items: type: object additionalProperties: false required: - id properties: id: anyOf: - type: string minLength: 1 - type: number weight: type: number minimum: 0 maximum: 1 creator_refs: type: array minItems: 1 maxItems: 1500 items: type: string maxLength: 20000 search: type: object additionalProperties: false required: - platform - search_kind properties: platform: type: string enum: - all - instagram - tiktok - youtube search_kind: type: string enum: - structured - ai_text - lookalike - result_image sort: type: string enum: - relevance - followers - engagement query: type: string maxLength: 2000 filters: type: object additionalProperties: false default: {} properties: creator: type: string maxLength: 255 locations: type: array maxItems: 20 items: anyOf: - type: string minLength: 1 - type: number languages: type: array maxItems: 10 items: type: string minLength: 1 maxLength: 20 followers: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 engagement_rate: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 average_views: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 growth_rate: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 posting_frequency: type: object additionalProperties: false properties: min: type: number minimum: 0 max: type: number minimum: 0 last_posted_days: type: integer minimum: 0 maximum: 3650 interests: type: array maxItems: 20 items: anyOf: - type: string minLength: 1 - type: number hashtags: type: array maxItems: 30 items: type: string minLength: 1 maxLength: 100 bio: type: string maxLength: 1000 account_type: type: string enum: - creator - business - regular verified: type: boolean has_email: type: boolean authenticity_min: type: number minimum: 0 maximum: 1 brand_ids: type: array maxItems: 20 items: anyOf: - type: string minLength: 1 - type: number audience_locations: type: array maxItems: 20 items: type: object additionalProperties: false required: - id properties: id: anyOf: - type: string minLength: 1 - type: number weight: type: number minimum: 0 maximum: 1 audience_languages: type: array maxItems: 10 items: type: object additionalProperties: false required: - id properties: id: anyOf: - type: string minLength: 1 - type: number weight: type: number minimum: 0 maximum: 1 audience_interests: type: array maxItems: 20 items: type: object additionalProperties: false required: - id properties: id: anyOf: - type: string minLength: 1 - type: number weight: type: number minimum: 0 maximum: 1 creator_refs: type: array minItems: 1 maxItems: 5 items: type: string maxLength: 20000 visual_ref: type: string maxLength: 5000 count: type: integer minimum: 1 maximum: 1500 list_name: type: string minLength: 1 maxLength: 255 idempotency_key: type: string format: uuid oneOf: - required: - creator_refs not: anyOf: - required: - search - required: - count - required: - search - count not: required: - creator_refs required: true responses: '200': description: Default Response content: application/json: schema: type: object additionalProperties: false required: - batch - selected_count - email_ready_count - missing_email_count - can_continue - credits_cost properties: batch: type: object additionalProperties: false required: - id - status - platform - search_kind - filters - creators - lead_ids properties: id: type: string format: uuid description: The creator list; also the id of its lead list list_id: type: string format: uuid agent_id: type: string format: uuid status: type: string enum: - preparing - queued - running - ready - attaching - attached - partial - failed description: >- `queued` and `running` mean a conversion is still in progress platform: type: string enum: - instagram - tiktok - youtube - all example: instagram search_kind: type: string enum: - structured - ai_text - lookalike - result_image - image_upload query: type: string filters: type: object additionalProperties: false properties: creator: type: string locations: type: array items: type: - string - number example: '148838' languages: type: array items: type: string followers: type: object additionalProperties: false properties: min: type: number max: type: number engagement_rate: type: object additionalProperties: false properties: min: type: number max: type: number average_views: type: object additionalProperties: false properties: min: type: number max: type: number growth_rate: type: object additionalProperties: false properties: min: type: number max: type: number posting_frequency: type: object additionalProperties: false properties: min: type: number max: type: number last_posted_days: type: number interests: type: array items: type: - string - number example: '148838' hashtags: type: array items: type: string bio: type: string account_type: type: string enum: - creator - business - regular verified: type: boolean has_email: type: boolean authenticity_min: type: number brand_ids: type: array items: type: - string - number example: '148838' audience_locations: type: array items: type: object additionalProperties: false required: - id properties: id: type: - string - number example: '148838' weight: type: number audience_languages: type: array items: type: object additionalProperties: false required: - id properties: id: type: - string - number example: '148838' weight: type: number audience_interests: type: array items: type: object additionalProperties: false required: - id properties: id: type: - string - number example: '148838' weight: type: number creators: type: array items: type: object additionalProperties: false required: - creator_ref - platform - name - handle - followers - engagement_rate - has_email - is_unlocked - collaboration_brands - content properties: creator_ref: type: string description: >- Opaque reference to the creator in this workspace; pass it back to convert or find lookalikes. It expires after a while: search again for a fresh one. example: eyJ2IjoxLCJwIjoiaW5zdGFncmFtIn0 platform: type: string enum: - instagram - tiktok - youtube example: instagram name: type: string example: Jane Doe handle: type: string example: janedoe profile_url: type: - 'null' - string example: https://www.instagram.com/janedoe avatar_url: type: - 'null' - string example: https://example.com/avatar.jpg bio: type: - 'null' - string example: Travel and food location: type: - 'null' - string example: Austin, United States category: type: - 'null' - string example: Travel followers: type: number example: 120000 engagement_rate: type: number description: A fraction, 0 to 1 example: 0.034 average_views: type: - 'null' - number example: 25000 posting_frequency: type: - 'null' - number description: Posts per month example: 12 growth_rate: type: - 'null' - number example: 0.02 has_email: type: boolean description: >- Whether an email is known for this creator; converting one without an email charges nothing example: true is_verified: type: - 'null' - boolean example: false is_unlocked: type: boolean description: >- Whether this workspace already bought the creator's insights example: false collaboration_brands: type: array items: type: string example: Nike content: type: array description: Recent posts items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean list_member_id: type: string public_report: type: object additionalProperties: false properties: audience: type: object additionalProperties: false properties: geography: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number ages: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number genders: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number languages: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number interests: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number credibility: type: number description: >- Share of followers that look like real people, 0 to 1 performance: type: object additionalProperties: false properties: average_likes: type: number average_comments: type: number average_views: type: number engagement_rate: type: number posting_frequency: type: number description: Posts per month follower_growth: type: number paid_post_performance: type: number content_type_performance: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number recent_content: type: array items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean popular_content: type: array items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean sponsored_content: type: array items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean collaborations: type: array items: type: object additionalProperties: false required: - brand properties: brand: type: string posts: type: number likes: type: number comments: type: number views: type: number collaborations: type: array items: type: object additionalProperties: false required: - brand properties: brand: type: string posts: type: number likes: type: number comments: type: number views: type: number review: type: object additionalProperties: false properties: decision: type: - 'null' - string enum: - approved - passed - null decided_by: type: - 'null' - string comments: type: array items: type: object additionalProperties: false properties: id: type: string author_name: type: string body: type: string timestamp_created: type: string email: type: string description: The email the conversion found lead_id: type: string format: uuid description: The lead created for this creator lead_ids: type: array items: type: string format: uuid run: type: - 'null' - object additionalProperties: false description: >- How the last conversion run went; null until one has run properties: selected_count: type: integer email_ready_count: type: integer description: Leads created with an email missing_email_count: type: integer description: Creators without an email; not charged duplicate_email_count: type: integer description: Emails already in the list; not added again credits_cost: type: number can_continue: type: boolean verifying_count: type: integer description: Leads whose email is still being verified error_code: type: - 'null' - string pages_loaded: type: integer paging_credits: type: number campaign: type: object additionalProperties: false required: - id - status - added_count - error_code description: >- Set when the run also adds its creators to `campaign_id` properties: id: type: string format: uuid status: type: string enum: - pending - added - failed description: >- `pending` until the emails are checked and the valid creators are added added_count: type: integer error_code: type: - 'null' - string enum: - lead_limit_reached - destination_unavailable - null error_code: type: - 'null' - string selected_count: type: integer email_ready_count: type: integer missing_email_count: type: integer duplicate_email_count: type: integer can_continue: type: boolean credits_cost: type: number reserved_credits: type: number description: The most this conversion may charge; held until it ends '202': description: Default Response content: application/json: schema: type: object additionalProperties: false required: - batch - selected_count - email_ready_count - missing_email_count - can_continue - credits_cost properties: batch: type: object additionalProperties: false required: - id - status - platform - search_kind - filters - creators - lead_ids properties: id: type: string format: uuid description: The creator list; also the id of its lead list list_id: type: string format: uuid agent_id: type: string format: uuid status: type: string enum: - preparing - queued - running - ready - attaching - attached - partial - failed description: >- `queued` and `running` mean a conversion is still in progress platform: type: string enum: - instagram - tiktok - youtube - all example: instagram search_kind: type: string enum: - structured - ai_text - lookalike - result_image - image_upload query: type: string filters: type: object additionalProperties: false properties: creator: type: string locations: type: array items: type: - string - number example: '148838' languages: type: array items: type: string followers: type: object additionalProperties: false properties: min: type: number max: type: number engagement_rate: type: object additionalProperties: false properties: min: type: number max: type: number average_views: type: object additionalProperties: false properties: min: type: number max: type: number growth_rate: type: object additionalProperties: false properties: min: type: number max: type: number posting_frequency: type: object additionalProperties: false properties: min: type: number max: type: number last_posted_days: type: number interests: type: array items: type: - string - number example: '148838' hashtags: type: array items: type: string bio: type: string account_type: type: string enum: - creator - business - regular verified: type: boolean has_email: type: boolean authenticity_min: type: number brand_ids: type: array items: type: - string - number example: '148838' audience_locations: type: array items: type: object additionalProperties: false required: - id properties: id: type: - string - number example: '148838' weight: type: number audience_languages: type: array items: type: object additionalProperties: false required: - id properties: id: type: - string - number example: '148838' weight: type: number audience_interests: type: array items: type: object additionalProperties: false required: - id properties: id: type: - string - number example: '148838' weight: type: number creators: type: array items: type: object additionalProperties: false required: - creator_ref - platform - name - handle - followers - engagement_rate - has_email - is_unlocked - collaboration_brands - content properties: creator_ref: type: string description: >- Opaque reference to the creator in this workspace; pass it back to convert or find lookalikes. It expires after a while: search again for a fresh one. example: eyJ2IjoxLCJwIjoiaW5zdGFncmFtIn0 platform: type: string enum: - instagram - tiktok - youtube example: instagram name: type: string example: Jane Doe handle: type: string example: janedoe profile_url: type: - 'null' - string example: https://www.instagram.com/janedoe avatar_url: type: - 'null' - string example: https://example.com/avatar.jpg bio: type: - 'null' - string example: Travel and food location: type: - 'null' - string example: Austin, United States category: type: - 'null' - string example: Travel followers: type: number example: 120000 engagement_rate: type: number description: A fraction, 0 to 1 example: 0.034 average_views: type: - 'null' - number example: 25000 posting_frequency: type: - 'null' - number description: Posts per month example: 12 growth_rate: type: - 'null' - number example: 0.02 has_email: type: boolean description: >- Whether an email is known for this creator; converting one without an email charges nothing example: true is_verified: type: - 'null' - boolean example: false is_unlocked: type: boolean description: >- Whether this workspace already bought the creator's insights example: false collaboration_brands: type: array items: type: string example: Nike content: type: array description: Recent posts items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean list_member_id: type: string public_report: type: object additionalProperties: false properties: audience: type: object additionalProperties: false properties: geography: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number ages: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number genders: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number languages: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number interests: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number credibility: type: number description: >- Share of followers that look like real people, 0 to 1 performance: type: object additionalProperties: false properties: average_likes: type: number average_comments: type: number average_views: type: number engagement_rate: type: number posting_frequency: type: number description: Posts per month follower_growth: type: number paid_post_performance: type: number content_type_performance: type: array items: type: object additionalProperties: false required: - label - value properties: label: type: string value: type: number recent_content: type: array items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean popular_content: type: array items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean sponsored_content: type: array items: type: object additionalProperties: false required: - id properties: id: type: string url: type: string thumbnail_url: type: string video_url: type: string media_type: type: string enum: - image - video - carousel visual_ref: type: string description: >- Pass as `visual_ref` to find creators with similar posts caption: type: string hashtags: type: array items: type: string published_at: type: string likes: type: number comments: type: number views: type: number shares: type: number is_sponsored: type: boolean collaborations: type: array items: type: object additionalProperties: false required: - brand properties: brand: type: string posts: type: number likes: type: number comments: type: number views: type: number collaborations: type: array items: type: object additionalProperties: false required: - brand properties: brand: type: string posts: type: number likes: type: number comments: type: number views: type: number review: type: object additionalProperties: false properties: decision: type: - 'null' - string enum: - approved - passed - null decided_by: type: - 'null' - string comments: type: array items: type: object additionalProperties: false properties: id: type: string author_name: type: string body: type: string timestamp_created: type: string email: type: string description: The email the conversion found lead_id: type: string format: uuid description: The lead created for this creator lead_ids: type: array items: type: string format: uuid run: type: - 'null' - object additionalProperties: false description: >- How the last conversion run went; null until one has run properties: selected_count: type: integer email_ready_count: type: integer description: Leads created with an email missing_email_count: type: integer description: Creators without an email; not charged duplicate_email_count: type: integer description: Emails already in the list; not added again credits_cost: type: number can_continue: type: boolean verifying_count: type: integer description: Leads whose email is still being verified error_code: type: - 'null' - string pages_loaded: type: integer paging_credits: type: number campaign: type: object additionalProperties: false required: - id - status - added_count - error_code description: >- Set when the run also adds its creators to `campaign_id` properties: id: type: string format: uuid status: type: string enum: - pending - added - failed description: >- `pending` until the emails are checked and the valid creators are added added_count: type: integer error_code: type: - 'null' - string enum: - lead_limit_reached - destination_unavailable - null error_code: type: - 'null' - string selected_count: type: integer email_ready_count: type: integer missing_email_count: type: integer duplicate_email_count: type: integer can_continue: type: boolean credits_cost: type: number reserved_credits: type: number description: The most this conversion may charge; held until it ends '400': description: >- The request is invalid (e.g. missing required fields, invalid field values, or an invalid state for the operation) content: application/json: schema: type: object properties: statusCode: type: number enum: - 400 examples: - 400 example: 400 code: type: string error: type: string enum: - Bad Request examples: - Bad Request example: Bad Request message: type: string examples: - body must have required property 'name' example: body must have required property 'name' required: - statusCode - error - message '401': description: >- This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: Default Response content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 error: type: string enum: - Insufficient credits - Payment required message: type: string code: type: string enum: - creator_search_payment_required creditsRequired: type: number creditsAvailable: type: number required: - statusCode - error - message - creditsRequired - creditsAvailable '403': description: Default Response content: application/json: schema: type: object additionalProperties: true '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: >- You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message components: securitySchemes: ApiKeyAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.