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.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/instantly-ai-supersearchenrichment-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Explorer Super Search Enrichment API
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: 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
paths:
/api/v2/supersearch-enrichment/signal-keywords-facet:
post:
operationId: signalKeywordsFacet
summary: Facet keywords for a signal category
tags:
- SuperSearchEnrichment
description: 'Return the top matching keyword tokens for a given signal category and keyword field, aggregated from the last 90 days of signal data. Powers the Signals filter autocomplete in the Lead Finder. Unknown (category, field) pairs return 400.
Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`'
requestBody:
content:
application/json:
schema:
type: object
required:
- category
- field
properties:
category:
type: string
description: Signal category to facet against (e.g. `linkedin_post_contact`).
example: linkedin_post_contact
field:
type: string
description: Indexed keyword field on `autobound_signals` to aggregate on.
example: tags
prefix:
type: string
description: Optional case-insensitive prefix to narrow the tokens returned.
example: ai
limit:
type: number
description: Max number of keyword buckets to return (1-100).
minimum: 1
maximum: 100
example: 20
required: true
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
keywords:
type: array
description: Keyword tokens ordered by descending frequency.
items:
type: object
properties:
keyword:
type: string
description: The keyword token (lowercased).
example: artificial intelligence
count:
type: number
description: Number of signal records with this token in the last 90 days.
example: 22418
'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: This request cannot be fulfilled because the workspace does not have an active paid plan
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
enum:
- 402
examples:
- 402
example: 402
error:
type: string
enum:
- Payment Required
examples:
- Payment Required
example: Payment Required
message:
type: string
examples:
- Workspace does not have an active paid plan
example: Workspace does not have an active paid plan
required:
- statusCode
- error
- message
'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
/api/v2/supersearch-enrichment/ai:
post:
operationId: createAIEnrichment
summary: Create AI enrichment
tags:
- SuperSearchEnrichment
description: '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`'
requestBody:
content:
application/json:
schema:
type: object
required:
- resource_id
- output_column
- resource_type
- model_version
properties:
resource_id:
type: string
format: uuid
description: Id of the resource (list or campaign) to enrich
example: 01234567-89ab-cdef-0123-456789abcdef
output_column:
type: string
description: Name of the column where the AI enrichment results will be stored
example: ai_generated_content
resource_type:
type: number
enum:
- 1
- 2
x-enumDescriptions:
'1': Campaign
'2': List
description: Type of the entity to enrich
example: 2
input_columns:
type: array
items:
type: string
example: first_name
description: 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:
type: string
enum:
- '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
x-enumDescriptions:
'3.5': GPT-3.5 Turbo - OpenAI's standard model with good performance and low cost
gpt-5: GPT-5 is OpenAI’s most advanced model, offering major improvements in reasoning, code quality, and user experience.
gpt-5.4: GPT-5.4 is the latest generation non-reasoning model, optimized for fast, high-quality responses at low latency.
gpt-5-mini: GPT-5 Mini is a compact version of GPT-5, designed to handle lighter-weight reasoning tasks.
gpt-5-nano: GPT-5-Nano is the smallest and fastest variant in the GPT-5 system, optimized for developer tools, rapid interactions, and ultra-low latency environments.
'4.0': GPT-4 - OpenAI's advanced model with improved reasoning
gpt-4o: GPT-4o - OpenAI's optimized model with improved performance
o3: o3 is a well-rounded and powerful model across domains. It sets a new standard for math, science, coding, and visual reasoning tasks.
gpt-4.1: GPT-4.1 is a flagship large language model optimized for advanced instruction following, real-world software engineering, and long-context reasoning.
gpt-4.1-mini: GPT-4.1 Mini is a mid-sized model delivering performance competitive with GPT-4o at substantially lower latency and cost.
claude-4.5-sonnet: Claude Sonnet 4.5 is Anthropic's most advanced Sonnet model to date, optimized for real-world agents and coding workflows.
claude-4.6-sonnet: Claude Sonnet 4.6 is Anthropic's latest Sonnet model, optimized for real-world agents and coding workflows.
r1: R1 - Deepseek's advanced chat model
grok-4.3: Grok 4.3 - X AI's latest reasoning model
gemini-3.0-flash: Gemini 3.0 Flash - Is a high speed, high value thinking model designed for agentic workflows, multi turn chat, and coding assistance
gemini-3.5-flash: Gemini 3.5 Flash - Google's high-speed flash model.
sonar: Sonar - Perplexity's lightweight, affordable, fast, and simple to use model.
sonar-pro: Sonar Pro - Perplexity's most advanced model.
instantly-ai-lightspeed-agent-for-web-research: Instantly AI - LightSpeed Agent for Web Research
instantly-ai-lightspeed-agent-for-email-generation: Instantly AI - LightSpeed Agent for Email Generation
description: Version of the AI model to use for enrichment. Different models have different capabilities, costs, and token limits.
example: gpt-4o
use_instantly_account:
type: boolean
description: When true, the enrichment will use Instantly's account for API calls. When false, it will use your own API keys configured in settings.
example: true
overwrite:
type: boolean
description: When true, will overwrite existing values in the output column. When false, only empty fields will be enriched.
example: false
auto_update:
type: boolean
description: When true, new leads added to the campaign/list will be automatically enriched using these same settings.
example: true
skip_leads_without_email:
type: boolean
description: When true, leads without an email will be skipped.
example: false
limit:
type: number
description: Maximum number of leads to enrich.
minimum: 1
maximum: 1000000
example: 100
prompt:
type: string
description: Custom prompt to guide the AI enrichment. Use {{variables}} to reference input data. Only used when templateId is not provided.
example: Write a personalized email to {{first_name}} from {{company_name}} about our new product
template_id:
type: string
description: ID of a predefined AI prompt template to use instead of a custom prompt. Templates are reusable prompt configurations.
example: '123'
status:
type: number
enum:
- 1
- 2
- 3
- 4
x-enumDescriptions:
'1': Job is pending processing
'2': Job is currently being processed
'3': Job has been completed successfully
'4': Job processing failed
description: Status of the job
example: 1
filters:
type: array
items:
type: object
properties: {}
description: Filters to apply to the enrichment
example:
column_name: email
type: 1
value:
- test@test.com
required: true
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Unique identifier for the enrichment
example: 01234567-89ab-cdef-0123-456789abcdef
resource_id:
type: string
format: uuid
description: ID of the resource being enriched
example: 01234567-89ab-cdef-0123-456789abcdef
resource_type:
type: number
description: Type of the resource (1 for Campaign, 2 for List)
enum:
- CAMPAIGN
- LIST
- 1
- 2
x-enumDescriptions:
'1': Campaign
'2': List
example: 1
output_column:
type: string
description: Name of the column where results will be stored
example: ai_generated_content
status:
type: number
description: Status of the enrichment job
example: 1
model_version:
type: string
description: AI model version used for enrichment
example: gpt-4o
input_columns:
type: array
items:
type: string
example: first_name
description: Input columns used for enrichment
overwrite:
type: boolean
description: Whether to overwrite existing data
example: false
auto_update:
type: boolean
description: Whether to auto-update new leads
example: true
limit:
type: number
description: Maximum number of leads to process
example: 100
template_id:
type:
- 'null'
- string
description: ID of the prompt template used
example: '15762598695796759'
required:
- id
- resource_id
- resource_type
- output_column
- status
- model_version
- overwrite
- auto_update
additionalProperties: false
'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: This request cannot be fulfilled because the workspace does not have an active paid plan
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
enum:
- 402
examples:
- 402
example: 402
error:
type: string
enum:
- Payment Required
examples:
- Payment Required
example: Payment Required
message:
type: string
examples:
- Workspace does not have an active paid plan
example: Workspace does not have an active paid plan
required:
- statusCode
- error
- message
'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
/api/v2/supersearch-enrichment/ai/{resource_id}/in-progress:
get:
operationId: getAiEnrichmentForResource
summary: Get AI enrichment for resource
tags:
- SuperSearchEnrichment
description: 'Get the AI enrichment for a specific resource
Requires one of the following scopes: `supersearch_enrichments:read`, `supersearch_enrichments:all`, `all:read`, `all:all`'
parameters:
- schema:
format: uuid
type: string
example: 123e4567-e89b-12d3-a456-426614174000
example: 123e4567-e89b-12d3-a456-426614174000
in: path
name: resource_id
required: true
description: The ID of the list or campaign to retrieve the AI enrichment.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
description: Unique identifier for the enrichment
example: 01234567-89ab-cdef-0123-456789abcdef
organization_id:
type: string
format: uuid
description: Organization ID that owns this enrichment
example: 01234567-89ab-cdef-0123-456789abcdef
resource_id:
type: string
format: uuid
description: ID of the resource being enriched
example: 01234567-89ab-cdef-0123-456789abcdef
resource_type:
type: number
description: Type of the resource (1 for Campaign, 2 for List)
enum:
- CAMPAIGN
- LIST
- 1
- 2
x-enumDescriptions:
'1': Campaign
'2': List
example: 1
output_column:
type: string
description: Name of the column where results will be stored
example: ai_generated_content
status:
type: number
description: Status of the enrichment job
example: 1
required:
- organization_id
- resource_id
- resource_type
- output_column
- status
'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: This request cannot be fulfilled because the workspace does not have an active paid plan
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
enum:
- 402
examples:
- 402
example: 402
error:
type: string
enum:
- Payment Required
examples:
- Payment Required
example: Payment Required
message:
type: string
examples:
- Workspace does not have an active paid plan
example: Workspace does not have an active paid plan
required:
- statusCode
- error
- message
'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
/api/v2/supersearch-enrichment/{resource_id}:
get:
operationId: getEnrichmentForResource
summary: Get enrichment for resource
tags:
- SuperSearchEnrichment
description: Get the enrichment for a specific resource
parameters:
- schema:
format: uuid
type: string
example: 123e4567-e89b-12d3-a456-426614174000
example: 123e4567-e89b-12d3-a456-426614174000
in: path
name: resource_id
required: true
description: The ID of the list or campaign to retrieve the enrichment.
responses:
'200':
description: Default Response
content:
application/json:
schema:
type: object
properties:
resource_id:
type: string
format: uuid
description: ID of the resource being enriched
example: 01234567-89ab-cdef-0123-456789abcdef
in_progress:
type: boolean
description: Whether the enrichment is in progress
example: false
has_no_leads:
type: boolean
description: Whether the enrichment for this resource returned no leads for these search filters. This is only applicable for enrichments created from SuperSearch.
example: false
exists:
type: boolean
description: Whether the enrichment exists
example: true
enrichment_payload:
type: object
description: Enrichment types
minProperties: 1
properties:
work_email_enrichment:
type: boolean
example: true
fully_enriched_profile:
type: boolean
example: true
email_verification:
type: boolean
example: false
joblisting:
type: boolean
example: true
technologies:
type: boolean
example: true
news:
type: boolean
example: true
funding:
type: boolean
example: true
engagement_score:
type: boolean
example: true
ai_enrichment:
type: object
additionalProperties: true
custom_flow:
type: array
items:
type: string
example: leadmagic
example:
- leadmagic
- prospeo
- hunter
limit:
type: number
description: Maximum number of leads to enrich
example: 10
autofill:
type: boolean
description: Whether to automatically fill in missing lead information
example: true
additionalProperties: true
auto_update:
type: boolean
description: Whether leads added to the list will be automatically enriched
example: false
is_evergreen:
type: boolean
description: Whether the enrichment is evergreen
example: false
search_filters:
type: object
description: Search filters used to create this enrichment (only present for enrichments created from SuperSearch)
additionalProperties: true
required:
- resource_id
# --- truncated at 32 KB (311 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/instantly-ai/refs/heads/main/openapi/instantly-ai-supersearchenrichment-api-openapi.yml