> ## 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. # Get the default AI Deliverability Agent state > Get the live state of the workspace default AI Deliverability Agent, including current activity, schedule, latest run summary, and activity feed. If no agent has been deployed, this endpoint returns an empty state with `agent` set to `null`. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all` ## OpenAPI ````yaml https://api.instantly.ai/openapi/api_v2.json get /api/v2/ai-agents/deliverability/state 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: AIAgent description: An AI agent x-group: AI Agent - 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: 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: AISalesAgentActivity description: An activity performed by an AI Sales Agent 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 paths: /api/v2/ai-agents/deliverability/state: get: tags: - AIDeliverabilityAgent summary: Get the default AI Deliverability Agent state description: >- Get the live state of the workspace default AI Deliverability Agent, including current activity, schedule, latest run summary, and activity feed. If no agent has been deployed, this endpoint returns an empty state with `agent` set to `null`. Requires one of the following scopes: `ai_agents:read`, `ai_agents:all`, `all:read`, `all:all` operationId: getDeliverabilityAgentState parameters: - schema: type: integer minimum: 1 maximum: 100 example: 10 example: 10 in: query name: limit required: false description: The number of items to return - schema: type: string example: 01956fbd-0eb1-72db-a565-82977a586084 example: 01956fbd-0eb1-72db-a565-82977a586084 in: query name: starting_after required: false description: >- The ID of the last item in the previous page - used for pagination. You can use the value of the `next_starting_after` field from the previous response. - schema: type: string enum: - all - todo - done example: all example: all in: query name: feed_filter required: false description: Filter the activity feed items. responses: '200': description: Default Response content: application/json: schema: type: object properties: agent: anyOf: - $ref: '#/components/schemas/AIAgent' - type: 'null' examples: - null example: null current_activity: type: object properties: active: anyOf: - allOf: - type: object properties: id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 organization_id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 agent_id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 cycle_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null activity_code: type: string examples: - check_workspace_settings example: check_workspace_settings status: type: string enum: - queued - in_progress - completed - failed - skipped - cancelled examples: - queued example: queued priority: type: number examples: - 100 example: 100 subject_type: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_name: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null payload: type: object additionalProperties: true result_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null error_code: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null error_message: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null idempotency_key: type: string examples: - >- cycle:01956fbd-0eb1-72db-a565-82977a586084:check_workspace_settings example: >- cycle:01956fbd-0eb1-72db-a565-82977a586084:check_workspace_settings timestamp_created: type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' timestamp_updated: type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' queued_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null started_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null expires_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - id - organization_id - agent_id - activity_code - status - priority - payload - idempotency_key - timestamp_created - timestamp_updated - type: object properties: sub_messages: type: array items: type: object properties: id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 organization_id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 agent_id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 activity_id: type: string format: uuid examples: - 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 message_code: type: string examples: - checking_campaign example: checking_campaign status: type: string enum: - queued - in_progress - completed - failed examples: - in_progress example: in_progress sort_order: type: number examples: - 10 example: 10 subject_type: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_name: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null payload: type: object additionalProperties: true result_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null error_code: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null error_message: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null idempotency_key: type: string examples: - >- campaign:01956fbd-0eb1-72db-a565-82977a586084:copy_scan example: >- campaign:01956fbd-0eb1-72db-a565-82977a586084:copy_scan timestamp_created: type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' timestamp_updated: type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - id - organization_id - agent_id - activity_id - message_code - status - sort_order - payload - idempotency_key - timestamp_created - timestamp_updated required: - sub_messages - type: 'null' examples: - null example: null queued: type: array items: type: object properties: id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 organization_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 agent_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 cycle_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null activity_code: type: string example: check_workspace_settings status: type: string enum: - queued - in_progress - completed - failed - skipped - cancelled example: queued priority: type: number example: 100 subject_type: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_name: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null payload: type: object additionalProperties: true result_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null error_code: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null error_message: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null idempotency_key: type: string example: >- cycle:01956fbd-0eb1-72db-a565-82977a586084:check_workspace_settings timestamp_created: type: string format: date-time example: '2026-08-20T18:29:58.856Z' timestamp_updated: type: string format: date-time example: '2026-08-20T18:29:58.856Z' queued_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null started_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null expires_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - id - organization_id - agent_id - activity_code - status - priority - payload - idempotency_key - timestamp_created - timestamp_updated completed_summary: type: object properties: count: type: number example: 4 retention_days: type: number example: 30 last_completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - count - retention_days - last_completed_at required: - active - queued - completed_summary schedule: type: object properties: next_run_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - next_run_at run_summary: type: object properties: latest: type: object properties: cycle_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null status: type: string enum: - running - completed - scheduled - empty example: completed started_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null total_checks: type: number example: 8 completed_checks: type: number example: 8 healthy_count: type: number example: 6 needs_attention_count: type: number example: 2 info_count: type: number example: 0 failed_count: type: number example: 0 checks: type: array items: type: object properties: activity_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 activity_code: type: string example: check_workspace_settings status: type: string enum: - queued - in_progress - completed - failed - skipped - cancelled example: completed outcome: type: string enum: - healthy - needs_attention - info - running - queued - failed - skipped - cancelled - unknown example: healthy completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - activity_id - activity_code - status - outcome - completed_at feed_items: type: array items: type: object properties: id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 organization_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 agent_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 source_activity_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null feed_code: type: string example: workspace_settings_recommendation kind: type: string enum: - insight - recommendation - action example: recommendation status: type: string enum: - todo - done - dismissed - failed example: todo severity: type: string enum: - info - success - warning - critical example: warning priority: type: number example: 100 subject_type: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_name: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null payload: type: object additionalProperties: true result_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null action_code: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null action_status: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null action_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null dedupe_key: type: string example: >- workspace_settings_recommendation:workspace:01956fbd-0eb1-72db-a565-82977a586084 timestamp_created: type: string format: date-time example: '2026-08-20T18:29:58.856Z' timestamp_updated: type: string format: date-time example: '2026-08-20T18:29:58.856Z' completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null dismissed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null expires_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - id - organization_id - agent_id - feed_code - kind - status - severity - priority - payload - dedupe_key - timestamp_created - timestamp_updated required: - cycle_id - status - started_at - completed_at - total_checks - completed_checks - healthy_count - needs_attention_count - info_count - failed_count - checks - feed_items trend: type: array items: type: object properties: cycle_id: type: string example: 01956fbd-0eb1-72db-a565-82977a586084 completed_at: type: string format: date-time example: '2026-08-20T18:29:58.856Z' score: anyOf: - type: number examples: - 86 example: 86 - type: 'null' examples: - null example: null total_checks: type: number example: 8 healthy_count: type: number example: 6 needs_attention_count: type: number example: 2 info_count: type: number example: 0 failed_count: type: number example: 0 required: - cycle_id - completed_at - score - total_checks - healthy_count - needs_attention_count - info_count - failed_count required: - latest - trend activity_feed: type: object properties: items: type: array items: type: object properties: id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 organization_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 agent_id: type: string format: uuid example: 01a0206f-e3c8-7c89-bb8e-26ad638ed6a3 source_activity_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null feed_code: type: string example: workspace_settings_recommendation kind: type: string enum: - insight - recommendation - action example: recommendation status: type: string enum: - todo - done - dismissed - failed example: todo severity: type: string enum: - info - success - warning - critical example: warning priority: type: number example: 100 subject_type: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_id: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null subject_name: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null payload: type: object additionalProperties: true result_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null action_code: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null action_status: anyOf: - type: string examples: - campaign example: campaign - type: 'null' examples: - null example: null action_payload: anyOf: - type: object additionalProperties: true - type: 'null' examples: - null example: null dedupe_key: type: string example: >- workspace_settings_recommendation:workspace:01956fbd-0eb1-72db-a565-82977a586084 timestamp_created: type: string format: date-time example: '2026-08-20T18:29:58.856Z' timestamp_updated: type: string format: date-time example: '2026-08-20T18:29:58.856Z' completed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null dismissed_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null expires_at: anyOf: - type: string format: date-time examples: - '2026-08-20T18:29:58.856Z' example: '2026-08-20T18:29:58.856Z' - type: 'null' examples: - null example: null required: - id - organization_id - agent_id - feed_code - kind - status - severity - priority - payload - dedupe_key - timestamp_created - timestamp_updated next_starting_after: anyOf: - type: string examples: - 01a0206f-e3c9-73f5-8665-e29040faa1dc example: 01a0206f-e3c9-73f5-8665-e29040faa1dc - type: 'null' examples: - null example: null required: - items required: - agent - current_activity - schedule - run_summary - activity_feed '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 components: schemas: AIAgent: title: AI Agent description: An AI agent x-tags: - Schemas - AIAgent type: object properties: id: type: string description: Unique identifier for the AI agent readOnly: true format: uuid example: 01a0206f-ab5d-7a94-b390-0e72d746d00a organization_id: type: string description: Organization ID readOnly: true format: uuid example: 01a0206f-ab5d-7a94-b390-0e739ce03f39 name: type: string description: Name of the AI Agent example: Test AI Agent payload: type: object description: >- Payload of the AI Agent. Either reply agent (Inbox Manager) or sales agent (SDR), depending on type. anyOf: - type: object description: Lead Finder Agent payload additionalProperties: true required: - campaign_id properties: campaign_id: type: string format: uuid examples: - 01a0206f-ab5d-7a94-b390-0e718e34de4a description: Campaign this agent keeps topped up example: 01a0206f-ab5d-7a94-b390-0e718e34de4a campaign_name: type: string examples: - Outbound US description: Denormalized campaign name example: Outbound US search_filters: type: object additionalProperties: true description: Primary audience search filters min_active_leads: type: number examples: - 50 description: Threshold below which the agent tops up the campaign example: 50 on_exhaustion: type: string enum: - pause - fallback - broaden examples: - pause description: What the agent does when the search runs out of new leads x-enumDescriptions: pause: Pause the agent until its search filters are updated fallback: Switch to `fallback_search_filters` and keep topping up broaden: >- Automatically broaden the search filters and keep topping up example: pause fallback_search_filters: type: - object - 'null' additionalProperties: true description: >- Optional fallback audience used when the primary search is exhausted ai_enrichment: type: - object - 'null' additionalProperties: true description: >- AI enrichment columns the agent fills on every top-up, keyed by output column name. Returned in the stored executor shape; the write shape is documented on the create and update endpoints. ai_enrichment_workflow: type: - string - 'null' examples: - custom:0198c2a4-3f1e-7000-8000-000000000000 description: >- Workflow template the enrichment chain was loaded from — a built-in key or `custom:`. example: custom:0198c2a4-3f1e-7000-8000-000000000000 - type: object description: Sales agent (SDR) payload required: - ai_sdr_config properties: ai_sdr_config: type: object description: AI Sales Agent agent config properties: memory: type: object description: Business context and memory for the AI Sales Agent properties: company: type: string examples: - Acme Inc example: Acme Inc business_description: type: string examples: - We provide cloud software example: We provide cloud software active_icps_indexes: type: array items: type: number examples: - 0 example: 0 icps: type: array items: type: object properties: name: type: string examples: - Enterprise example: Enterprise problems_solved: type: array items: type: string examples: - Scale outreach example: Scale outreach benefits: type: array items: type: string examples: - Faster sales example: Faster sales usp: type: string examples: - AI-powered example: AI-powered customer_goals: type: array items: type: string examples: - Increase revenue example: Increase revenue success_stories: type: string examples: - Case study example: Case study keywords: type: object properties: include: type: - string - 'null' examples: - automation, efficiency, AI example: automation, efficiency, AI exclude: type: - string - 'null' examples: - manual, legacy example: manual, legacy company_size: type: array items: type: string examples: - 51-200 example: 51-200 industry: type: array items: type: string examples: - Technology example: Technology job_title: type: object properties: include: type: array items: type: string examples: - CEO example: CEO exclude: type: array items: type: string examples: - Intern example: Intern custom_fields: type: array items: type: string examples: - custom_field_1 example: custom_field_1 business_offers: type: array items: type: string examples: - Offer A example: Offer A active_business_offers_indexes: type: array items: type: number examples: - 0 example: 0 enrichment_settings: type: object description: Settings for lead enrichment properties: enrichment_limit_per_run: type: number description: Maximum number of leads to enrich per run examples: - 30 example: 30 outreach_settings: type: object description: Settings for email outreach properties: campaign_schedule: type: object properties: schedules: type: array items: type: object properties: name: type: string examples: - Default example: Default timing: type: object properties: from: type: string examples: - '09:00' example: '09:00' to: type: string examples: - '17:00' example: '17:00' days: type: object additionalProperties: type: boolean examples: - true example: true timezone: type: string examples: - America/New_York example: America/New_York email_list: type: array items: type: string format: email examples: - user@example.com example: user@example.com email_tag_list: type: array items: type: string examples: - tag-id example: tag-id daily_limit: type: number examples: - 100 example: 100 stop_on_reply: type: boolean examples: - true example: true open_tracking: type: boolean examples: - true example: true first_email_text_only: type: boolean examples: - false example: false prioritize_new_leads: type: boolean examples: - false example: false match_lead_esp: type: boolean examples: - false example: false autonomy_settings: type: object description: Settings for AI Sales Agent autonomy properties: autopilot_mode: type: boolean description: Whether autopilot mode is enabled examples: - false example: false auto_reply_to_responses: type: boolean description: Whether to auto-reply to responses examples: - false example: false type: type: string enum: - website - pitch_deck description: SDR source type examples: - website example: website input: type: string description: SDR input (e.g. website URL or pitch deck reference) examples: - https://example.com example: https://example.com master_lead_list_id: type: string format: uuid description: Master lead list ID for the SDR examples: - 01a0206f-ab5d-7a94-b390-0e701a341f2a example: 01a0206f-ab5d-7a94-b390-0e701a341f2a initial_scrape_ready: type: boolean description: Whether initial scrape is ready examples: - false example: false timestamp_last_action: type: string format: date-time description: Timestamp of last SDR action examples: - '2024-01-01T12:00:00Z' example: '2024-01-01T12:00:00Z' timestamp_last_decision: type: string format: date-time description: Timestamp of last SDR decision examples: - '2024-01-01T12:00:00Z' example: '2024-01-01T12:00:00Z' next_decision_time: type: string format: date-time description: Scheduled time for next decision examples: - '2024-01-01T12:00:00Z' example: '2024-01-01T12:00:00Z' - type: object description: Reply agent (Inbox Manager) payload properties: configuration_type: type: number examples: - 1 - 2 enum: - 1 - 2 description: Type of the AI agent configuration example: 1 tags: type: array items: oneOf: - type: string enum: - default examples: - default example: default - type: string format: uuid examples: - 01a0206f-ab5d-7a94-b390-0e6decf359ba example: 01a0206f-ab5d-7a94-b390-0e6decf359ba description: List of tags to use for AI Agent handle_followup: type: boolean examples: - true description: Whether to handle follow-up emails example: true respond_to_automatic_emails: type: boolean examples: - true description: Whether to respond to automatic emails example: true handle_objections: type: boolean examples: - true description: Whether to handle objections, declines, or negative replies example: true integrations: type: object additionalProperties: true description: Configurations for app integrations examples: - slack: connectionId: 01a0206f-ab5d-7a94-b390-0e6ee945717d connectionName: My Connection example: slack: connectionId: 01a0206f-ab5d-7a94-b390-0e6ee945717d connectionName: My Connection no_show: type: object description: No-show recovery feature configuration examples: - enabled: true max_followups: 3 properties: enabled: type: boolean description: Enable no-show recovery mode examples: - true example: true max_followups: type: number description: Maximum number of no-show follow-up emails (1-10) minimum: 1 maximum: 10 examples: - 3 example: 3 fallback_sending_accounts: type: object examples: - accounts: [] tag_ids: [] properties: accounts: type: array items: type: string format: email examples: - sender@example.com example: sender@example.com tag_ids: type: array items: type: string examples: - 01a0206f-ab5d-7a94-b390-0e6f97c9db87 example: 01a0206f-ab5d-7a94-b390-0e6f97c9db87 example: accounts: [] tag_ids: [] example: enabled: true max_followups: 3 trigger_on_labels_enabled: type: boolean examples: - false description: >- Whether to activate the agent only for specific interest labels example: false trigger_on_labels: type: array items: type: number examples: - 1 example: 1 examples: - - 1 - -1 description: Array of interest_status values to trigger the agent on example: - 1 - -1 trigger_on_labels_mode: type: string enum: - include - exclude examples: - include description: >- Whether to include or exclude the selected labels. Defaults to include. example: include monthly_credit_budget: type: - number - 'null' minimum: 1 examples: - 1000 description: Monthly AI credit budget for this agent (null = unlimited) example: 1000 followup_business_days_only: type: boolean examples: - true description: >- Whether to send follow-up emails only on business days (Mon-Fri) example: true - type: object description: Deliverability Agent payload additionalProperties: false properties: integrations: type: object additionalProperties: false description: Configurations for Deliverability Agent app integrations properties: slack: anyOf: - type: object additionalProperties: false properties: connection_id: type: string description: Slack app connection ID enabled: type: boolean description: >- Whether Slack notifications are enabled for this Deliverability Agent. connection_name: type: string description: >- Deprecated. Kept only so previously stored values round-trip. channel_id: type: string description: >- Deprecated. Kept only so previously stored values round-trip. channel_name: type: string description: >- Deprecated. Kept only so previously stored values round-trip. - type: 'null' type: type: - 'null' - number description: Type of the AI Agent enum: - 1 - 2 - 3 - 4 - 6 - 7 - 8 - 9 - 10 x-enumDescriptions: '1': Inbox Manager Agent '2': Sales Development Representative Agent '3': Deliverability Agent '4': Affiliate Agent '6': Lead Finder Agent '7': Recruiting Agent '8': Investment Agent '9': User Research Agent '10': Partnership Agent example: 1 timestamp_created: type: string description: Timestamp when the AI agent was created readOnly: true example: '2026-08-20T18:29:44.413Z' timestamp_updated: type: string description: Timestamp when the AI agent was updated readOnly: true example: '2026-08-20T18:29:44.413Z' status: type: number description: Status of the AI Agent enum: - -1 - 0 - 1 x-enumDescriptions: '0': Inactive '1': Active '-1': Trial Expired example: 1 is_auto_created: type: - 'null' - boolean description: Whether the AI agent was auto-created example: false created_by: type: - 'null' - string description: User ID who created the AI agent readOnly: true format: uuid example: 01a0206f-ab5d-7a94-b390-0e74994e2dba description: type: - 'null' - string description: Description of the AI agent readOnly: true example: Optional agent description required: - id - organization_id - name - payload - timestamp_created - timestamp_updated - status additionalProperties: false securitySchemes: ApiKeyAuth: type: http scheme: bearer ````