INinstantly
AIInboxManager

Get an AI Inbox Manager guidance

Changed on

Retrieve a single guidance of an AI Inbox Manager.

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

get/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/ai-agents/inbox-manager/{id}/guidances/{guidance_id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:01a19e6f-7b1c-7bec-adb7-652a8072c6fe

AI Inbox Manager ID

guidance_idstring uuid required
Example:01a19e6f-7b1c-7bec-adb7-652b1b497507

Guidance ID

Response

The requested guidance

idstring uuid required

Unique identifier for the AI agent guidance

organization_idstring uuid required

Organization ID

agent_idstring uuid required

Associated AI Agent ID

labelstring required

Label of the AI agent guidance

instructionstring required

Instruction text for the AI agent guidance. Should be empty string for BASICS category.

status1 | 0 required

Status of the AI agent guidance

category0 | 1 | 2 | 3 | 4 required

Category of the AI agent guidance

timestamp_createdstring required

Timestamp when the AI agent guidance was created

timestamp_updatedstring required

Timestamp when the AI agent guidance was updated

Example response

{
  "id": "01a19e6f-3fa6-764e-95b5-fb11d459a557",
  "organization_id": "01a19e6f-3fa6-764e-95b5-fb129cb23598",
  "agent_id": "01a19e6f-3fa6-764e-95b5-fb13cc89db87",
  "label": "Test AI Agent Guidance",
  "instruction": "This is an AI agent guidance instruction",
  "status": 1,
  "category": 1,
  "basic_guidance_options": {
    "tone": "professional",
    "length": "standard"
  },
  "timestamp_created": "2026-11-02T22:44:13.350Z",
  "timestamp_updated": "2026-11-02T22:44:13.350Z"
}

Changes