Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pam.ai/llms.txt

Use this file to discover all available pages before exploring further.

PAM agents are managed voice and SMS agents that you can use from the API with a stable agentSlug. Use an agent slug when PAM has provided one for a supported workflow, such as recall outreach or retention follow-up. Your API key determines attribution, billing, and webhook routing.

Agent Selection

Conversation create requests must include exactly one of:
  • agentSlug — a stable slug for a PAM-managed agent.
  • agentId — a specific agent UUID.
Prefer agentSlug when you use a PAM-managed agent in an external integration.
{
  "agentSlug": "recall-sms",
  "toNumber": "+15555550199",
  "fromNumber": "+15555550123"
}

Available Agents

Recall Voice Agent

Use recall-voice to call customers about a service recall. Required dynamic variables:
VariableDescription
customerNameCustomer name the agent can use during the call.
dealershipNameDealership or business name the agent represents.
recallIdRecall identifier, such as 24V-123.
{
  "agentSlug": "recall-voice",
  "toNumber": "+15555550199",
  "fromNumber": "+15555550123",
  "dynamicVariables": {
    "customerName": "Ada",
    "dealershipName": "PAM Motors",
    "recallId": "24V-123"
  }
}

Recall SMS Agent

Use recall-sms to start an SMS conversation about a service recall. Required dynamic variables:
VariableDescription
customerNameCustomer name the agent can use in replies.
dealershipNameDealership or business name the agent represents.
recallIdRecall identifier, such as 24V-123.
{
  "agentSlug": "recall-sms",
  "toNumber": "+15555550199",
  "fromNumber": "+15555550123",
  "welcomeMessage": "Hi Ada, this is PAM Motors following up on your service recall.",
  "dynamicVariables": {
    "customerName": "Ada",
    "dealershipName": "PAM Motors",
    "recallId": "24V-123"
  }
}

Phone Numbers

Provide fromNumber on every call or SMS conversation that uses a PAM-managed agent.
{
  "agentSlug": "recall-voice",
  "toNumber": "+15555550199",
  "fromNumber": "+15555550123"
}
For custom agents with a configured phone number, PAM uses the number configured on the agent. If you send fromNumber with that type of agent, it is ignored.

Opening SMS Copy

PAM-managed SMS agents also require welcomeMessage. This is the exact first SMS body sent to the customer.
{
  "agentSlug": "recall-sms",
  "toNumber": "+15555550199",
  "fromNumber": "+15555550123",
  "welcomeMessage": "Hi Ada, this is PAM Motors following up on your service recall."
}
Generate or select the opening message in your application, then pass the resolved copy when creating the SMS conversation.

Dynamic Variables

Use dynamicVariables for values the agent should know during the conversation, such as customer name, dealership name, appointment details, or recall identifiers.
{
  "dynamicVariables": {
    "customerName": "Ada",
    "dealershipName": "PAM Motors",
    "recallId": "24V-123"
  }
}
Variables are strings. Keep sensitive internal-only values out of dynamicVariables unless PAM has explicitly configured the agent to use them safely.

Webhook Routing

Webhook delivery is scoped to the organization associated with your API key. When a conversation event fires, PAM routes it using the conversation’s organization, the pinned agent version, and the event type.