Get Agent API Reference

Serverhttps://api.pinnacle.sh/

Retrieve details of an RCS agent by its ID.

Returns the agent's configuration including display name, description, logo, hero image, contact information, and other settings.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

agentIdstring

The RCS agent ID (must be prefixed with agent_).

Match

^agent_.*

Example

"agent_abc123def456"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.rcs.getAgent("agent_abc123def456");

Responses

{  "id": "agent_abc123def456",  "type": "TEST",  "serviceId": "acme-support_agent",  "carrierLaunches": {    "ATT": "NOT_LAUNCHED",    "TMOBILE": "LAUNCHED",    "VERIZON": "PENDING",    "OTHERS": "NOT_LAUNCHED"  },  "details": {    "name": "Acme Support",    "description": "Get help with your Acme orders and account",    "iconUrl": "https://example.com/logo.png",    "heroUrl": "https://example.com/hero.png",    "color": "#FF6B00",    "phones": [      {        "phone": "+14155550123",        "label": "Support"      }    ],    "emails": [      {        "email": "support@example.com",        "label": "Support"      }    ],    "websites": [      {        "url": "https://example.com",        "label": "Website"      }    ],    "privacyUrl": "https://example.com/privacy",    "termsUrl": "https://example.com/terms",    "isConversational": true,    "agentUseCase": "MULTI_USE"  }}

Get Agent

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`