Get an agent

curl https://app.scalysis.com/api/v1/scripts/2207 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "script": {
    "id": 2207,
    "name": "COD Confirmation",
    "description": "",
    "contentVisible": "# IDENTITY\n- You are {{agent_name}}, a female agent from {{brand_name}}...",
    "language": "en",
    "voiceId": "scalysis-v3-priyanka-original",
    "initialGreeting": "Hello, kya meri baat {{customer_name}} se ho rahi hai?",
    "successCriteria": ["Confirmed", "Cancelled", "Callback Requested"],
    "otherCriteria": ["Voicemail", "Insufficient Talk"],
    "maxRetries": 2,
    "retryIntervalMinutes": 15,
    "knowledgeBook": { "ids": [1420] },
    "createdAt": "2026-10-12T06:30:00.000Z",
    "updatedAt": "2026-10-20T07:17:00.000Z"
  }
}

{ "success": false, "error": "Not found" }

Returns one agent. Use it to check the greeting, the outcomes it can report, or which {{variables}} you must send when calling.

Path

number

required

Agent ID from List agents.

curl https://app.scalysis.com/api/v1/scripts/2207 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "script": {
    "id": 2207,
    "name": "COD Confirmation",
    "description": "",
    "contentVisible": "# IDENTITY\n- You are {{agent_name}}, a female agent from {{brand_name}}...",
    "language": "en",
    "voiceId": "scalysis-v3-priyanka-original",
    "initialGreeting": "Hello, kya meri baat {{customer_name}} se ho rahi hai?",
    "successCriteria": ["Confirmed", "Cancelled", "Callback Requested"],
    "otherCriteria": ["Voicemail", "Insufficient Talk"],
    "maxRetries": 2,
    "retryIntervalMinutes": 15,
    "knowledgeBook": { "ids": [1420] },
    "createdAt": "2026-10-12T06:30:00.000Z",
    "updatedAt": "2026-10-20T07:17:00.000Z"
  }
}

{ "success": false, "error": "Not found" }

The example is shortened. The response has a few more settings fields.

Response

string

The agent’s instructions, as you see them in the dashboard. Hidden parts written by Scalysis AI are not returned.

string

The first line the agent says.

string[]

Outcomes from a real conversation. These are the values you get back as the call outcome.

string[]

Outcomes when no real conversation happened, like voicemail.

string

The agent’s voice.

number

Retry count saved on the agent. Campaigns use their own retry settings.

number

Minutes between retries saved on the agent.

object

Knowledge books attached to the agent.

Every {{name}} in contentVisible or initialGreeting must be sent when you call. Or use Prepare chat: it lists them for you.

curl https://app.scalysis.com/api/v1/scripts/2207 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "success": true,
  "script": {
    "id": 2207,
    "name": "COD Confirmation",
    "description": "",
    "contentVisible": "# IDENTITY\n- You are {{agent_name}}, a female agent from {{brand_name}}...",
    "language": "en",
    "voiceId": "scalysis-v3-priyanka-original",
    "initialGreeting": "Hello, kya meri baat {{customer_name}} se ho rahi hai?",
    "successCriteria": ["Confirmed", "Cancelled", "Callback Requested"],
    "otherCriteria": ["Voicemail", "Insufficient Talk"],
    "maxRetries": 2,
    "retryIntervalMinutes": 15,
    "knowledgeBook": { "ids": [1420] },
    "createdAt": "2026-10-12T06:30:00.000Z",
    "updatedAt": "2026-10-20T07:17:00.000Z"
  }
}

{ "success": false, "error": "Not found" }

Calls

Orders

Campaigns

Account

Agents

Agent chat

Tools

Path

Response

​Path

​Response

Path

Response