AIDeliverabilityAgent

Get the default AI Deliverability Agent state

Changed on

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

get/api/v2/ai-agents/deliverability/state

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/deliverability/state
  • Auth
    HTTP bearer

Query parameters

limitinteger
Example:10

The number of items to return

starting_afterstring
Example:01956fbd-0eb1-72db-a565-82977a586084

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.

feed_filter'all' | 'todo' | 'done'
Example:all

Filter the activity feed items.

Response

Default Response

Example response

{
  "agent": {
    "id": "01a19e6d-50a9-79e8-8f91-951a76adc9d7",
    "organization_id": "01a19e6d-50a9-79e8-8f91-951b651b4747",
    "name": "Test AI Agent",
    "payload": {
      "campaign_id": "01a19e6d-50a9-79e8-8f91-951864a8ae03",
      "campaign_name": "Outbound US",
      "min_active_leads": 50,
      "on_exhaustion": "pause",
      "ai_enrichment_workflow": "custom:0198c2a4-3f1e-7000-8000-000000000000"
    },
    "type": 1,
    "timestamp_created": "2026-11-02T22:42:06.633Z",
    "timestamp_updated": "2026-11-02T22:42:06.633Z",
    "status": 1,
    "created_by": "01a19e6d-50a9-79e8-8f91-951cd6f29219",
    "description": "Optional agent description"
  },
  "current_activity": {
    "active": {
      "id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
      "organization_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
      "agent_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
      "cycle_id": "campaign",
      "activity_code": "check_workspace_settings",
      "status": "queued",
      "priority": 100,
      "subject_type": "campaign",
      "subject_id": "campaign",
      "subject_name": "campaign",
      "error_code": "campaign",
      "error_message": "campaign",
      "idempotency_key": "cycle:01956fbd-0eb1-72db-a565-82977a586084:check_workspace_settings",
      "timestamp_created": "2026-11-02T22:42:20.131Z",
      "timestamp_updated": "2026-11-02T22:42:20.131Z",
      "queued_at": "2026-11-02T22:42:20.131Z",
      "started_at": "2026-11-02T22:42:20.131Z",
      "completed_at": "2026-11-02T22:42:20.131Z",
      "expires_at": "2026-11-02T22:42:20.131Z",
      "sub_messages": [
        {
          "id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "organization_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "agent_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "activity_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "message_code": "checking_campaign",
          "status": "in_progress",
          "sort_order": 10,
          "subject_type": "campaign",
          "subject_id": "campaign",
          "subject_name": "campaign",
          "error_code": "campaign",
          "error_message": "campaign",
          "idempotency_key": "campaign:01956fbd-0eb1-72db-a565-82977a586084:copy_scan",
          "timestamp_created": "2026-11-02T22:42:20.131Z",
          "timestamp_updated": "2026-11-02T22:42:20.131Z",
          "completed_at": "2026-11-02T22:42:20.131Z"
        }
      ]
    },
    "queued": [
      {
        "id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
        "organization_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
        "agent_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
        "cycle_id": "campaign",
        "activity_code": "check_workspace_settings",
        "status": "queued",
        "priority": 100,
        "subject_type": "campaign",
        "subject_id": "campaign",
        "subject_name": "campaign",
        "error_code": "campaign",
        "error_message": "campaign",
        "idempotency_key": "cycle:01956fbd-0eb1-72db-a565-82977a586084:check_workspace_settings",
        "timestamp_created": "2026-11-02T22:42:20.131Z",
        "timestamp_updated": "2026-11-02T22:42:20.131Z",
        "queued_at": "2026-11-02T22:42:20.131Z",
        "started_at": "2026-11-02T22:42:20.131Z",
        "completed_at": "2026-11-02T22:42:20.131Z",
        "expires_at": "2026-11-02T22:42:20.131Z"
      }
    ],
    "completed_summary": {
      "count": 4,
      "retention_days": 30,
      "last_completed_at": "2026-11-02T22:42:20.131Z"
    }
  },
  "schedule": {
    "next_run_at": "2026-11-02T22:42:20.131Z"
  },
  "run_summary": {
    "latest": {
      "cycle_id": "campaign",
      "status": "completed",
      "started_at": "2026-11-02T22:42:20.131Z",
      "completed_at": "2026-11-02T22:42:20.131Z",
      "total_checks": 8,
      "completed_checks": 8,
      "healthy_count": 6,
      "needs_attention_count": 2,
      "checks": [
        {
          "activity_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "activity_code": "check_workspace_settings",
          "status": "completed",
          "outcome": "healthy",
          "completed_at": "2026-11-02T22:42:20.131Z"
        }
      ],
      "feed_items": [
        {
          "id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "organization_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "agent_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
          "source_activity_id": "campaign",
          "feed_code": "workspace_settings_recommendation",
          "kind": "recommendation",
          "status": "todo",
          "severity": "warning",
          "priority": 100,
          "subject_type": "campaign",
          "subject_id": "campaign",
          "subject_name": "campaign",
          "action_code": "campaign",
          "action_status": "campaign",
          "dedupe_key": "workspace_settings_recommendation:workspace:01956fbd-0eb1-72db-a565-82977a586084",
          "timestamp_created": "2026-11-02T22:42:20.131Z",
          "timestamp_updated": "2026-11-02T22:42:20.131Z",
          "completed_at": "2026-11-02T22:42:20.131Z",
          "dismissed_at": "2026-11-02T22:42:20.131Z",
          "expires_at": "2026-11-02T22:42:20.131Z"
        }
      ]
    },
    "trend": [
      {
        "cycle_id": "01956fbd-0eb1-72db-a565-82977a586084",
        "completed_at": "2026-11-02T22:42:20.131Z",
        "score": 86,
        "total_checks": 8,
        "healthy_count": 6,
        "needs_attention_count": 2
      }
    ]
  },
  "activity_feed": {
    "items": [
      {
        "id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
        "organization_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
        "agent_id": "01a19e6d-8563-790a-bd34-eea1802abfa7",
        "source_activity_id": "campaign",
        "feed_code": "workspace_settings_recommendation",
        "kind": "recommendation",
        "status": "todo",
        "severity": "warning",
        "priority": 100,
        "subject_type": "campaign",
        "subject_id": "campaign",
        "subject_name": "campaign",
        "action_code": "campaign",
        "action_status": "campaign",
        "dedupe_key": "workspace_settings_recommendation:workspace:01956fbd-0eb1-72db-a565-82977a586084",
        "timestamp_created": "2026-11-02T22:42:20.131Z",
        "timestamp_updated": "2026-11-02T22:42:20.131Z",
        "completed_at": "2026-11-02T22:42:20.131Z",
        "dismissed_at": "2026-11-02T22:42:20.131Z",
        "expires_at": "2026-11-02T22:42:20.131Z"
      }
    ],
    "next_starting_after": "01a19e6d-8563-790a-bd34-eea292acff49"
  }
}

Changes

    • info

      added subschema #1 subschema #2 to the // response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property allOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the // response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the // response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the // response property allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the // response property allOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the // response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the // response property anyOf list for the response status