REST ClientFabricAI Agents

get

View as MarkdownOpen in Claude

Retrieve a single AI agent resource.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of an AI Agent.

Response

idstringRequiredformat: "uuid"
Unique ID of the AIAgent.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the AIAgent Fabric Resource
typeenumRequired
Type of the Fabric Resource
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
ai_agentobjectRequired
AIAgent data.

Response Example

Response
{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Support Assistant",
  "type": "ai_agent",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:25:00Z",
  "ai_agent": {
    "prompt": {
      "text": "You are a helpful customer support assistant."
    },
    "agent_id": "a87db7ed-8ebe-42e4-829f-8ba5a4152f54",
    "name": "Support Assistant"
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
const agent = await client.fabric.aiAgents.get("agent-id");
console.log(`AI Agent: ${agent.display_name}, ID: ${agent.id}`);