--- title: "Get AI Deliverability Agent state" method: GET path: "/api/v2/ai-agents/deliverability/{id}/state" tags: ["AIDeliverabilityAgent"] --- # Get AI Deliverability Agent state `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 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` ## Path parameters - `id` string, uuid, required ## Query parameters - `limit` integer - `starting_after` string - `feed_filter` 'all' | 'todo' | 'done' ## Response `200` The live state of the agent - object - `current_activity` object, required - `active` object, nullable, required - `id` string, uuid, required - `organization_id` string, uuid, required - `agent_id` string, uuid, required - `cycle_id` string, nullable - `activity_code` string, required - `status` 'queued' | 'in_progress' | 'completed' | 'failed' | 'skipped' | 'cancelled', required - `priority` number, required - `subject_type` string, nullable - `subject_id` string, nullable - `subject_name` string, nullable - `payload` object, required - `result_payload` object, nullable - `error_code` string, nullable - `error_message` string, nullable - `idempotency_key` string, required - `timestamp_created` string, date-time, required - `timestamp_updated` string, date-time, required - `queued_at` string, date-time, nullable - `started_at` string, date-time, nullable - `completed_at` string, date-time, nullable - `expires_at` string, date-time, nullable - `sub_messages` object[], required - `id` string, uuid, required - `organization_id` string, uuid, required - `agent_id` string, uuid, required - `activity_id` string, uuid, required - `message_code` string, required - `status` 'queued' | 'in_progress' | 'completed' | 'failed', required - `sort_order` number, required - `subject_type` string, nullable - `subject_id` string, nullable - `subject_name` string, nullable - `payload` object, required - `result_payload` object, nullable - `error_code` string, nullable - `error_message` string, nullable - `idempotency_key` string, required - `timestamp_created` string, date-time, required - `timestamp_updated` string, date-time, required - `completed_at` string, date-time, nullable - `queued` object[], required - `id` string, uuid, required - `organization_id` string, uuid, required - `agent_id` string, uuid, required - `cycle_id` string, nullable - `activity_code` string, required - `status` 'queued' | 'in_progress' | 'completed' | 'failed' | 'skipped' | 'cancelled', required - `priority` number, required - `subject_type` string, nullable - `subject_id` string, nullable - `subject_name` string, nullable - `payload` object, required - `result_payload` object, nullable - `error_code` string, nullable - `error_message` string, nullable - `idempotency_key` string, required - `timestamp_created` string, date-time, required - `timestamp_updated` string, date-time, required - `queued_at` string, date-time, nullable - `started_at` string, date-time, nullable - `completed_at` string, date-time, nullable - `expires_at` string, date-time, nullable - `completed_summary` object, required - `count` number, required - `retention_days` number, required - `last_completed_at` string, date-time, nullable, required - `schedule` object, required - `next_run_at` string, date-time, nullable, required - `run_summary` object, required - `latest` object, required - `cycle_id` string, nullable, required - `status` 'running' | 'completed' | 'scheduled' | 'empty', required - `started_at` string, date-time, nullable, required - `completed_at` string, date-time, nullable, required - `total_checks` number, required - `completed_checks` number, required - `healthy_count` number, required - `needs_attention_count` number, required - `info_count` number, required - `failed_count` number, required - `checks` object[], required - `activity_id` string, uuid, required - `activity_code` string, required - `status` 'queued' | 'in_progress' | 'completed' | 'failed' | 'skipped' | 'cancelled', required - `outcome` 'healthy' | 'needs_attention' | 'info' | 'running' | 'queued' | 'failed' | 'skipped' | 'cancelled' | 'unknown', required - `completed_at` string, date-time, nullable, required - `feed_items` object[], required - `id` string, uuid, required - `organization_id` string, uuid, required - `agent_id` string, uuid, required - `source_activity_id` string, nullable - `feed_code` string, required - `kind` 'insight' | 'recommendation' | 'action', required - `status` 'todo' | 'done' | 'dismissed' | 'failed', required - `severity` 'info' | 'success' | 'warning' | 'critical', required - `priority` number, required - `subject_type` string, nullable - `subject_id` string, nullable - `subject_name` string, nullable - `payload` object, required - `result_payload` object, nullable - `action_code` string, nullable - `action_status` string, nullable - `action_payload` object, nullable - `dedupe_key` string, required - `timestamp_created` string, date-time, required - `timestamp_updated` string, date-time, required - `completed_at` string, date-time, nullable - `dismissed_at` string, date-time, nullable - `expires_at` string, date-time, nullable - `trend` object[], required - `cycle_id` string, required - `completed_at` string, date-time, required - `score` number, nullable, required - `total_checks` number, required - `healthy_count` number, required - `needs_attention_count` number, required - `info_count` number, required - `failed_count` number, required - `activity_feed` object, required - `items` object[], required - `id` string, uuid, required - `organization_id` string, uuid, required - `agent_id` string, uuid, required - `source_activity_id` string, nullable - `feed_code` string, required - `kind` 'insight' | 'recommendation' | 'action', required - `status` 'todo' | 'done' | 'dismissed' | 'failed', required - `severity` 'info' | 'success' | 'warning' | 'critical', required - `priority` number, required - `subject_type` string, nullable - `subject_id` string, nullable - `subject_name` string, nullable - `payload` object, required - `result_payload` object, nullable - `action_code` string, nullable - `action_status` string, nullable - `action_payload` object, nullable - `dedupe_key` string, required - `timestamp_created` string, date-time, required - `timestamp_updated` string, date-time, required - `completed_at` string, date-time, nullable - `dismissed_at` string, date-time, nullable - `expires_at` string, date-time, nullable - `next_starting_after` string, nullable ## Other responses - `401`: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) - `402`: This request cannot be fulfilled because the workspace does not have an active paid plan - `404`: The requested resource was not found - `429`: You have exceeded the rate limit. Please check the rate limit docs for more information. ## Changes - **2026-11-03** `bea714781ea4`: 2 info - added `subschema #1, subschema #2` to the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - removed `subschema #1, subschema #2` from the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - **2026-11-03** `3daaa5f6b0be`: 2 info - added `subschema #1, subschema #2` to the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - removed `subschema #1, subschema #2` from the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - **2026-11-03** `adcd5b3299da`: 2 info - added `subschema #1, subschema #2` to the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - removed `subschema #1, subschema #2` from the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - **2026-11-03** `406ab2c4f714`: 2 info - added `subschema #1, subschema #2` to the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - removed `subschema #1, subschema #2` from the `current_activity/active/anyOf[subschema #1]/` response property `allOf` list for the response status `200` - …earlier changes not shown [Operation history](https://skmtc.dev/instantly/apis/api-explorer/changes/api/v2/ai-agents/deliverability/:id/state/get.md) --- [API](https://skmtc.dev/instantly/apis/api-explorer.md) - [All operations](https://skmtc.dev/instantly/apis/api-explorer/llms.txt) - [OpenAPI document](https://skmtc.dev/instantly/apis/api-explorer/revisions/bea714781ea4?raw)