INinstantly
AIDeliverabilityAgent

Get AI Deliverability Agent state

Changed on

Get the live state of an AI Deliverability Agent: current activity, schedule, latest run summary, and the activity feed.

Requires one of the following scopes: ai_agents:read, ai_agents:all, all:read, all:all

get/api/v2/ai-agents/deliverability/{id}/state

Request

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

Path parameters

idstring uuid required
Example:01a19e6f-7efd-75d1-a285-413774268b6f

AI Deliverability Agent ID. Call GET /api/v2/ai-agents/deliverability and use the returned agent.id value to retrieve the workspace default agent ID.

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 for the activity feed items.

Response

The live state of the agent

Example response

{
  "current_activity": {
    "active": {
      "id": "01a19e6f-7efd-75d1-a285-413774268b6f",
      "organization_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
      "agent_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
      "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:44:29.565Z",
      "timestamp_updated": "2026-11-02T22:44:29.565Z",
      "queued_at": "2026-11-02T22:44:29.565Z",
      "started_at": "2026-11-02T22:44:29.565Z",
      "completed_at": "2026-11-02T22:44:29.565Z",
      "expires_at": "2026-11-02T22:44:29.565Z",
      "sub_messages": [
        {
          "id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "organization_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "agent_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "activity_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "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:44:29.565Z",
          "timestamp_updated": "2026-11-02T22:44:29.565Z",
          "completed_at": "2026-11-02T22:44:29.565Z"
        }
      ]
    },
    "queued": [
      {
        "id": "01a19e6f-7efd-75d1-a285-413774268b6f",
        "organization_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
        "agent_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
        "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:44:29.565Z",
        "timestamp_updated": "2026-11-02T22:44:29.565Z",
        "queued_at": "2026-11-02T22:44:29.565Z",
        "started_at": "2026-11-02T22:44:29.565Z",
        "completed_at": "2026-11-02T22:44:29.565Z",
        "expires_at": "2026-11-02T22:44:29.565Z"
      }
    ],
    "completed_summary": {
      "count": 4,
      "retention_days": 30,
      "last_completed_at": "2026-11-02T22:44:29.565Z"
    }
  },
  "schedule": {
    "next_run_at": "2026-11-02T22:44:29.565Z"
  },
  "run_summary": {
    "latest": {
      "cycle_id": "campaign",
      "status": "completed",
      "started_at": "2026-11-02T22:44:29.565Z",
      "completed_at": "2026-11-02T22:44:29.565Z",
      "total_checks": 8,
      "completed_checks": 8,
      "healthy_count": 6,
      "needs_attention_count": 2,
      "checks": [
        {
          "activity_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "activity_code": "check_workspace_settings",
          "status": "completed",
          "outcome": "healthy",
          "completed_at": "2026-11-02T22:44:29.565Z"
        }
      ],
      "feed_items": [
        {
          "id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "organization_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "agent_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
          "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:44:29.565Z",
          "timestamp_updated": "2026-11-02T22:44:29.565Z",
          "completed_at": "2026-11-02T22:44:29.565Z",
          "dismissed_at": "2026-11-02T22:44:29.565Z",
          "expires_at": "2026-11-02T22:44:29.565Z"
        }
      ]
    },
    "trend": [
      {
        "cycle_id": "01956fbd-0eb1-72db-a565-82977a586084",
        "completed_at": "2026-11-02T22:44:29.565Z",
        "score": 86,
        "total_checks": 8,
        "healthy_count": 6,
        "needs_attention_count": 2
      }
    ]
  },
  "activity_feed": {
    "items": [
      {
        "id": "01a19e6f-7efd-75d1-a285-413774268b6f",
        "organization_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
        "agent_id": "01a19e6f-7efd-75d1-a285-413774268b6f",
        "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:44:29.565Z",
        "timestamp_updated": "2026-11-02T22:44:29.565Z",
        "completed_at": "2026-11-02T22:44:29.565Z",
        "dismissed_at": "2026-11-02T22:44:29.565Z",
        "expires_at": "2026-11-02T22:44:29.565Z"
      }
    ],
    "next_starting_after": "01a19e6f-7efd-75d1-a285-41387b2542d2"
  }
}

Changes

  • e8adcfd8ae95Revision 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

  • 89f7767b369dRevision 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