Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
SuperSearchEnrichment

Create AI enrichment

Create an AI enrichment for a resource (list or campaign)

Requires one of the following scopes: supersearch_enrichments:create, supersearch_enrichments:all, all:create, all:all

post/api/v2/supersearch-enrichment/ai

Request body

resource_idstring uuid required

Id of the resource (list or campaign) to enrich

output_columnstring required

Name of the column where the AI enrichment results will be stored

resource_type1 | 2 required

Type of the entity to enrich

input_columnsstring[]

List of column names to use as input data for the AI enrichment. These are the fields from your leads that will be used to generate content.

model_version'3.5' | '4.0' | 'gpt-4o' | 'o3' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5' | 'gpt-5.4' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'r1' | 'grok-4.3' | 'gemini-3.0-flash' | 'gemini-3.5-flash' | 'sonar' | 'sonar-pro' | 'instantly-ai-lightspeed-agent-for-web-research' | 'instantly-ai-lightspeed-agent-for-email-generation' required

Version of the AI model to use for enrichment. Different models have different capabilities, costs, and token limits.

use_instantly_accountboolean

When true, the enrichment will use Instantly's account for API calls. When false, it will use your own API keys configured in settings.

overwriteboolean

When true, will overwrite existing values in the output column. When false, only empty fields will be enriched.

auto_updateboolean

When true, new leads added to the campaign/list will be automatically enriched using these same settings.

skip_leads_without_emailboolean

When true, leads without an email will be skipped.

limitnumber

Maximum number of leads to enrich.

promptstring

Custom prompt to guide the AI enrichment. Use {{variables}} to reference input data. Only used when templateId is not provided.

template_idstring

ID of a predefined AI prompt template to use instead of a custom prompt. Templates are reusable prompt configurations.

status1 | 2 | 3 | 4

Status of the job

filtersobject[]

Example request

{
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "output_column": "ai_generated_content",
  "resource_type": 2,
  "input_columns": [
    "first_name"
  ],
  "model_version": "gpt-4o",
  "use_instantly_account": true,
  "auto_update": true,
  "limit": 100,
  "prompt": "Write a personalized email to {{first_name}} from {{company_name}} about our new product",
  "template_id": "123",
  "status": 1,
  "filters": [
    {
      "column_name": "email",
      "type": 1,
      "value": [
        "test@test.com"
      ]
    }
  ]
}

Response

Default Response

idstring required

Unique identifier for the enrichment

resource_idstring uuid required

ID of the resource being enriched

resource_typenumber required

Type of the resource (1 for Campaign, 2 for List)

output_columnstring required

Name of the column where results will be stored

statusnumber required

Status of the enrichment job

model_versionstring required

AI model version used for enrichment

input_columnsstring[]

Input columns used for enrichment

overwriteboolean required

Whether to overwrite existing data

auto_updateboolean required

Whether to auto-update new leads

limitnumber

Maximum number of leads to process

template_idstring nullable

ID of the prompt template used

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "resource_type": 1,
  "output_column": "ai_generated_content",
  "status": 1,
  "model_version": "gpt-4o",
  "input_columns": [
    "first_name"
  ],
  "auto_update": true,
  "limit": 100,
  "template_id": "15762598695796759"
}