Servers Playground How we check Add a server Log in

SAGOT

Working · 1.5 s

com.sagots/sagotv0.2.0 Domain verified

AI voice agents that place and answer phone calls, with transcripts and outcomes.

Communication AI & Agents

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://sagots.com/mcp

Authorization (optional)

Optional: a SAGOT API key as 'Bearer <key>'. Without it, assistants sign in with OAuth 2.1.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

access_info

Read public registration availability (closed alpha is the default) and whether the caller's session or credential is valid (signedIn).

This tool takes no arguments.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

SAGOT MCP server | mcptry

SAGOT

Working · 1.5 s

com.sagots/sagotv0.2.0 Domain verified

AI voice agents that place and answer phone calls, with transcripts and outcomes.

Communication AI & Agents

Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://sagots.com/mcp

Authorization (optional)

Optional: a SAGOT API key as 'Bearer <key>'. Without it, assistants sign in with OAuth 2.1.

Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.

Tool list from our last check. Connect live to refresh it.

access_info

Read public registration availability (closed alpha is the default) and whether the caller's session or credential is valid (signedIn).

This tool takes no arguments.

This tool isn't marked read-only, so it may change something on the server or in an account you connected.

I understand, run it anyway

Tools (136)

access_info

Read public registration availability (closed alpha is the default) and whether the caller's session or credential is valid (signedIn).

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

account_acceptTerms

Signed-in session only: accept the current Terms of Service, Data Processing Addendum and Privacy Notice (version from account.me termsVersion). Records the version and time on your account.

Argument	Type	Description
version*	string	The termsVersion you accept (see account.me).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "version"
  ],
  "properties": {
    "version": {
      "type": "string",
      "maxLength": 20,
      "description": "The termsVersion you accept (see account.me)."
    }
  }
}

account_delete

Signed-in session only: delete your own SAGOT account after confirming your password. Refused while you own a workspace (transfer ownership or delete it first) or hold a SAGOT staff role. Removes you from every workspace, revokes your sessions and API keys and anonymises your account; your email can register again.

Argument	Type	Description
password*	string	Your current password, to confirm it is you.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1,
      "description": "Your current password, to confirm it is you."
    }
  }
}

account_login

SAGOT account.login. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
code	string	Two-step sign-in: the 6-digit authenticator code or a recovery code.
email*	string
password*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 20,
      "minLength": 6,
      "description": "Two-step sign-in: the 6-digit authenticator code or a recovery code."
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "password": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1
    }
  }
}

account_logout

SAGOT account.logout. Uses the same authorization and validation as website, API and CLI.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

account_me

SAGOT account.me. Uses the same authorization and validation as website, API and CLI.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

account_mfaDisable

Signed-in session only: turn two-step sign-in off with your password and a current code or recovery code. SAGOT staff cannot use the platform console without it.

Argument	Type	Description
code*	string
password*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "password",
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 20,
      "minLength": 6
    },
    "password": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1
    }
  }
}

account_mfaEnable

Signed-in session only: confirm a 6-digit code from the authenticator app to turn two-step sign-in on. Returns 10 one-time recovery codes once; store them safely. Sign-in then needs a code (account.login code).

Argument	Type	Description
code*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 20,
      "minLength": 6
    }
  }
}

account_mfaRecoveryCodes

Signed-in session only: replace all recovery codes after confirming a current code. Returns the 10 new codes once.

Argument	Type	Description
code*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 20,
      "minLength": 6
    }
  }
}

account_mfaSetup

Signed-in session only: start turning on two-step sign-in. Confirms your password and returns a new authenticator secret and otpauth:// URI (scan as a QR code). Nothing changes until account.mfaEnable confirms a code.

Argument	Type	Description
password*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "maxLength": 128,
      "minLength": 1
    }
  }
}

account_register

SAGOT account.register. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
name*	string
email*	string
password*	string
acceptTerms*	boolean	Must be true: you accept the current Terms of Service (/terms), Data Processing Addendum (/data-processing) and Privacy Notice (/privacy).
invitationToken	string
memberInvitationToken	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "email",
    "password",
    "acceptTerms"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "password": {
      "type": "string",
      "maxLength": 128,
      "minLength": 12
    },
    "acceptTerms": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: you accept the current Terms of Service (/terms), Data Processing Addendum (/data-processing) and Privacy Notice (/privacy)."
    },
    "invitationToken": {
      "type": "string",
      "maxLength": 100,
      "minLength": 32
    },
    "memberInvitationToken": {
      "type": "string",
      "maxLength": 100,
      "minLength": 32
    }
  }
}

actions_list

SAGOT actions.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

actions_reconcile

Query the owning system about an uncertain action. Does not repeat the business write.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_create

SAGOT agents.create. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
persona*	object
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "persona"
  ],
  "properties": {
    "persona": {
      "type": "object",
      "required": [
        "name",
        "instructions",
        "greeting",
        "handoffOwner"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "offer": {
          "type": "string",
          "default": "",
          "maxLength": 12000
        },
        "voice": {
          "enum": [
            "Aoede",
            "Sulafat",
            "Kore",
            "Puck",
            "Charon",
            "Fenrir"
          ],
          "type": "string",
          "default": "Sulafat"
        },
        "greeting": {
          "type": "string",
          "maxLength": 1000,
          "minLength": 1
        },
        "language": {
          "type": "string",
          "default": "English and Filipino",
          "maxLength": 100,
          "minLength": 2
        },
        "knowledge": {
          "type": "string",
          "default": "",
          "maxLength": 12000
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1
          },
          "default": [],
          "maxItems": 30
        },
        "handoffOwner": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "instructions": {
          "type": "string",
          "maxLength": 12000,
          "minLength": 10
        },
        "integrationId": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "integrationIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "maxItems": 20,
          "description": "Selected action connections. An explicit empty list removes all; overrides legacy integrationId."
        },
        "inboundGreeting": {
          "type": "string",
          "default": "",
          "maxLength": 1000
        }
      }
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_get

SAGOT agents.get. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_list

SAGOT agents.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_pause

SAGOT agents.pause. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_publish

Publish a validated draft for new calls. Active calls keep their original snapshot.

Argument	Type	Description
id*	string
revision*	integer
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "revision"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_retire

SAGOT agents.retire. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
version*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "version": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_rollback

Point new calls to a previous published version.

Argument	Type	Description
id*	string
version*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "version"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "version": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_save

SAGOT agents.save. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
persona*	object
revision*	integer
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "revision",
    "persona"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "persona": {
      "type": "object",
      "required": [
        "name",
        "instructions",
        "greeting",
        "handoffOwner"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "offer": {
          "type": "string",
          "default": "",
          "maxLength": 12000
        },
        "voice": {
          "enum": [
            "Aoede",
            "Sulafat",
            "Kore",
            "Puck",
            "Charon",
            "Fenrir"
          ],
          "type": "string",
          "default": "Sulafat"
        },
        "greeting": {
          "type": "string",
          "maxLength": 1000,
          "minLength": 1
        },
        "language": {
          "type": "string",
          "default": "English and Filipino",
          "maxLength": 100,
          "minLength": 2
        },
        "knowledge": {
          "type": "string",
          "default": "",
          "maxLength": 12000
        },
        "questions": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 500,
            "minLength": 1
          },
          "default": [],
          "maxItems": 30
        },
        "handoffOwner": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1
        },
        "instructions": {
          "type": "string",
          "maxLength": 12000,
          "minLength": 10
        },
        "integrationId": {
          "anyOf": [
            {
              "type": "string",
              "format": "uuid",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
            },
            {
              "type": "null"
            }
          ],
          "default": null
        },
        "integrationIds": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "maxItems": 20,
          "description": "Selected action connections. An explicit empty list removes all; overrides legacy integrationId."
        },
        "inboundGreeting": {
          "type": "string",
          "default": "",
          "maxLength": 1000
        }
      }
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

agents_test

Validate the current draft and its integration. This is configuration validation, not a voice-quality score. Use a draft SIP call to hear the result.

Argument	Type	Description
id*	string
revision*	integer
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "revision"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

artifacts_delete

SAGOT artifacts.delete. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

artifacts_export

SAGOT artifacts.export. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

assistants_authorize

Signed-in session only: allow (with a workspaceId) or deny an AI assistant's request to use SAGOT. Allowing gives that assistant the listed scopes in one workspace — never admin, never more than your role — and returns redirectTo, the address to send the browser back to.

Argument	Type	Description
allow*	boolean
request*	object
workspaceId	string	Workspace the assistant may use; required to allow.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "request",
    "allow"
  ],
  "properties": {
    "allow": {
      "type": "boolean"
    },
    "request": {
      "type": "object",
      "required": [
        "response_type",
        "client_id",
        "redirect_uri"
      ],
      "properties": {
        "scope": {
          "type": "string",
          "maxLength": 500
        },
        "state": {
          "type": "string",
          "maxLength": 2000
        },
        "resource": {
          "type": "string",
          "maxLength": 500
        },
        "client_id": {
          "type": "string",
          "maxLength": 500,
          "minLength": 1
        },
        "redirect_uri": {
          "type": "string",
          "maxLength": 2000,
          "minLength": 1
        },
        "response_type": {
          "type": "string",
          "maxLength": 40
        },
        "code_challenge": {
          "type": "string",
          "maxLength": 200
        },
        "code_challenge_method": {
          "type": "string",
          "maxLength": 20
        }
      }
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Workspace the assistant may use; required to allow."
    }
  }
}

assistants_clients_create

Signed-in session only: create an OAuth client ID and secret for an assistant that asks for them, such as Gemini Enterprise (redirect https://vertexaisearch.cloud.google.com/oauth-redirect). The secret is returned once. People who sign in through it still choose their own workspace.

Argument	Type	Description
name*	string
redirectUris*	array

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "redirectUris"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "redirectUris": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri",
        "maxLength": 2000
      },
      "maxItems": 10,
      "minItems": 1
    }
  }
}

assistants_clients_list

Signed-in session only: OAuth client IDs you created for assistants, with their redirect addresses.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

assistants_clients_revoke

Signed-in session only: revoke an OAuth client ID you created; assistants using it can no longer sign in or refresh tokens.

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    }
  }
}

assistants_list

Signed-in session only: AI assistants connected to your account through OAuth, with workspace, scopes, when connected and last used.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

assistants_preview

Check an OAuth authorization request from an AI assistant (Claude, ChatGPT, Gemini or any MCP client) before consent: returns the assistant's name, the address it returns to, the scopes requested in plain words, or the problem with the request.

Argument	Type	Description
request*	object

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "request"
  ],
  "properties": {
    "request": {
      "type": "object",
      "required": [
        "response_type",
        "client_id",
        "redirect_uri"
      ],
      "properties": {
        "scope": {
          "type": "string",
          "maxLength": 500
        },
        "state": {
          "type": "string",
          "maxLength": 2000
        },
        "resource": {
          "type": "string",
          "maxLength": 500
        },
        "client_id": {
          "type": "string",
          "maxLength": 500,
          "minLength": 1
        },
        "redirect_uri": {
          "type": "string",
          "maxLength": 2000,
          "minLength": 1
        },
        "response_type": {
          "type": "string",
          "maxLength": 40
        },
        "code_challenge": {
          "type": "string",
          "maxLength": 200
        },
        "code_challenge_method": {
          "type": "string",
          "maxLength": 20
        }
      }
    }
  }
}

assistants_revoke

Signed-in session only: disconnect an AI assistant. Its access and refresh tokens stop working immediately; it must ask again to reconnect.

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

billing_get

The workspace's prepaid balance for calls on SAGOT numbers (PHP centavos): balance (paid top-ups + SAGOT credits − charges), reserved for calls in progress, available, this month's spend and the optional monthly cap (policy monthlySpendLimitCentavos, null = none), recent top-ups, the proposed rate per country and whether card top-ups are offered. Other line types are not paid from the balance.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

billing_topUp

Admin only, never an assistant: start a card payment (Stripe Checkout) that adds amountCentavos (₱500–₱50,000) to the prepaid balance. Returns `checkoutUrl`; give it to the person to pay. The balance rises when Stripe confirms the payment. Fails PAYMENTS_UNAVAILABLE when this deployment takes no payments.

Argument	Type	Description
workspaceId*	string
amountCentavos*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "amountCentavos"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "amountCentavos": {
      "type": "integer",
      "maximum": 5000000,
      "minimum": 50000
    }
  }
}

calls_approve

Signed-in session only (a person, not an API key or assistant): approve a call an AI assistant asked for (status awaiting_approval). Eligibility is checked again and the call is queued.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

calls_cancel

Cancel a queued or active call. On a finished call with a scheduled automatic retry, cancels that retry instead.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

calls_create

Queue one call with an agent to a contact. Give `task` for what this one call must achieve (the personal starter agent follows it). During the alpha a line only calls its test numbers, unless it is a SAGOT number line in live mode. Calls on SAGOT numbers reserve their maximum cost from the prepaid balance (BALANCE_TOO_LOW, SPEND_LIMIT_REACHED, COUNTRY_NOT_SUPPORTED). When an AI assistant connected by OAuth asks for a call and the policy's assistantCallApproval is on (default), the call is created with status awaiting_approval and nothing dials until a person approves it on the website: tell them, and give them the returned approvalUrl. It is canceled if not approved within 24 hours. Then read the result with calls.get.

Argument	Type	Description
task	string	What this one call must achieve, in plain words — e.g. 'Ask for a table for 4 on Friday 18 Oct at 7pm under Cruz; 7–8pm is fine; no deposit.' Given to the agent beneath its instructions.
draft	boolean
lineId	string
agentId*	string
contactId*	string
workspaceId*	string
idempotencyKey*	string

calls_decline

Signed-in session only: decline a call an AI assistant asked for. It is canceled and its reserved budget released.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

calls_get

SAGOT calls.get. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

calls_list

SAGOT calls.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

calls_recording

Get recording availability and authenticated audio URL. Fetch that URL with the same bearer credential to play/download Ogg audio; CLI supports --output file. Older unrecorded calls have no audio.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_cancel

SAGOT campaigns.cancel. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_get

SAGOT campaigns.get. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_list

SAGOT campaigns.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_pause

SAGOT campaigns.pause. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_preview

Inspect eligible contacts, exclusion reasons and the maximum reserved cost without dialing.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_resume

SAGOT campaigns.resume. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

campaigns_save

SAGOT campaigns.save. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id	string
name*	string
lineId	any
agentId*	string
revision	integer
contactIds*	array
workspaceId*	string
budgetCentavos*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "name",
    "agentId",
    "contactIds",
    "budgetCentavos"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "lineId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "agentId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "contactIds": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid",
        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
      },
      "maxItems": 500,
      "minItems": 1
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "budgetCentavos": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": 1
    }
  }
}

campaigns_start

SAGOT campaigns.start. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_erase

Admins: permanently erase one person's personal data from this workspace — by contact id or by phone number (destination), including inbound callers who are not contacts. Removes the contact, its activity history, and every call's recording, transcript, outcome, number and linked action/handoff content. Calls keep only time, status, duration and cost. Refused while a call with them is active or one of their actions is unresolved. With doNotCall (always, if they had opted out) a one-way fingerprint of the number keeps them from being called or answered again. Use for data-subject erasure requests; download the audit first if you need to answer an access request.

Argument	Type	Description
id	string	The contact to erase. Give this or destination, not both.
doNotCall	boolean	Keep the number on this workspace's do-not-call list as a one-way fingerprint. Always kept when the contact had opted out.
destination	any	Erase by number, e.g. an inbound caller who is not a contact.
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "The contact to erase. Give this or destination, not both."
    },
    "doNotCall": {
      "type": "boolean",
      "default": false,
      "description": "Keep the number on this workspace's do-not-call list as a one-way fingerprint. Always kept when the contact had opted out."
    },
    "destination": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^(?:[a-zA-Z0-9_-]{1,64}|sip:[a-zA-Z0-9_.-]{1,64}@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63})$",
          "maxLength": 320
        },
        {
          "type": "string",
          "pattern": "^\\+[1-9][0-9]{6,14}$"
        }
      ],
      "description": "Erase by number, e.g. an inbound caller who is not a contact."
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_export

Export the contact's retained evidence as a readable Markdown or structured JSON audit snapshot. Export is logged; it does not create recordings or recover deleted content.

Argument	Type	Description
id*	string
format	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "format": {
      "enum": [
        "markdown",
        "json"
      ],
      "type": "string",
      "default": "markdown"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_history

Review all retained calls, conversations, outcomes, actions, follow-ups and activity for one contact across agents in this workspace. Missing or deleted evidence is labeled.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_import

SAGOT contacts.import. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
contacts*	array
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "contacts"
  ],
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "name",
          "externalRef",
          "destination",
          "source",
          "eligibility"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "source": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "destination": {
            "anyOf": [
              {
                "type": "string",
                "pattern": "^(?:[a-zA-Z0-9_-]{1,64}|sip:[a-zA-Z0-9_.-]{1,64}@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63})$",
                "maxLength": 320
              },
              {
                "type": "string",
                "pattern": "^\\+[1-9][0-9]{6,14}$"
              }
            ]
          },
          "eligibility": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          },
          "externalRef": {
            "type": "string",
            "maxLength": 200,
            "minLength": 1
          }
        }
      },
      "maxItems": 500,
      "minItems": 1
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_list

SAGOT contacts.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_suppress

Permanently suppress this contact from new calls in this workspace.

Argument	Type	Description
id*	string
reason*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "reason"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "reason": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

contacts_update

SAGOT contacts.update. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
name*	string
source*	string
revision*	integer
eligibility*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "revision",
    "name",
    "source",
    "eligibility"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "source": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "eligibility": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

credentials_create

SAGOT credentials.create. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
name*	string
scopes*	array
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "name",
    "scopes"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "scopes": {
      "type": "array",
      "items": {
        "enum": [
          "read",
          "configure",
          "publish",
          "call",
          "admin"
        ],
        "type": "string"
      },
      "minItems": 1
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

credentials_list

SAGOT credentials.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

credentials_revoke

SAGOT credentials.revoke. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

events_list

SAGOT events.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

events_replay

Retry delivery of this event with its original event ID.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

handoffs_list

SAGOT handoffs.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

handoffs_update

SAGOT handoffs.update. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
owner*	string
status*	string
revision*	integer
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "revision",
    "status",
    "owner"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "owner": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "status": {
      "enum": [
        "accepted",
        "resolved",
        "canceled"
      ],
      "type": "string"
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

integrations_disconnect

SAGOT integrations.disconnect. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

integrations_get

SAGOT integrations.get. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

integrations_list

SAGOT integrations.list. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
limit	integer
cursor	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "cursor": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

integrations_save

SAGOT integrations.save. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
id	string
mode*	string
name*	string
secret	string
endpoint	string
revision	integer
actionName	string
description	string	When the agent should use this action and what it accomplishes.
workspaceId*	string
eventEndpoint	string
requiredFields	array

integrations_test

Exercise the connector with a test payload. Sandbox never writes to an external product.

Argument	Type	Description
id*	string
payload	object
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "payload": {
      "type": "object",
      "default": {},
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

invitations_create

Platform operators only: issue an email-bound, single-use private invitation. Returns the token once; share privately. Does not send email. Replaces prior unused invitations for that email.

Argument	Type	Description
email*	string
expiresInDays	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "expiresInDays": {
      "type": "integer",
      "default": 7,
      "maximum": 30,
      "minimum": 1
    }
  }
}

invitations_list

Platform operators only: list invitation states without tokens, newest first.

Argument	Type	Description
limit	integer
offset	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    }
  }
}

invitations_revoke

Platform operators only: revoke an unused invitation. Existing accounts are unaffected.

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_clearAlert

Clear this line's telco warning after fixing the cause (for example topping up the gateway SIM). Held automatic retries and campaigns on this line resume. An answered call also clears it.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_confirmNumber

SAGOT number lines, admin only: check the code sent by lines.verifyNumber and add the number to the line's test numbers. A wrong or expired code fails VERIFICATION_FAILED; send a new one.

Argument	Type	Description
id*	string
code*	string
number*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "number",
    "code"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "code": {
      "type": "string",
      "pattern": "^[0-9]{4,10}$"
    },
    "number": {
      "type": "string",
      "pattern": "^\\+[1-9][0-9]{6,14}$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_create

Add a phone line from an offered provider. Adding never dials. The first line becomes the default for new calls and campaigns. Lines start in test mode: only the line's test numbers can be called. A `gateway` line (your own computer + phone) returns a one-time `pairing.code` (30 minutes) that the SAGOT gateway app exchanges for its own credential; the code is shown only once. A `twilio` line connects your own Twilio account: pass accountSid, apiKeySid, apiKeySecret (a Standard API key; write-only) and the numbers to attach (lines.twilioNumbers lists them). SAGOT creates an Elastic SIP Trunk, a credential list, an origination URL and attaches the numbers in your account, records every object it created and removes exactly those when the line is deleted. Twilio bills the calls to your account. A `sagot` line (SAGOT number, one per workspace) calls from SAGOT's shared numbers and is paid from the workspace's prepaid balance (billing.get shows rates); it can't receive calls. Add its test numbers with lines.verifyNumber and lines.confirmNumber.

Argument	Type	Description
edge	string
name	string
numbers	array
callerId	string
provider*	string
apiKeySid	string
isDefault	boolean

lines_delete

Remove a phone line. Refused while it has active calls. For a Twilio line SAGOT first deletes the trunk, credentials and origination URL it created in your account and detaches your numbers (the numbers stay yours). Finished calls keep their history; scheduled retries on it are skipped. Another line becomes the default if needed.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_get

Read one phone line with its live health and warning.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_list

List this workspace's phone lines (provider, default, mode, test numbers, ring window, live health, inbound answering, telco warning) and the providers this deployment offers. Secrets are never returned.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_test

Check a line's readiness without dialing: provider offered, health, test numbers. Use calls.create with lineId for a real test call.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

lines_twilioNumbers

Check a Twilio Standard API key (accountSid, apiKeySid, apiKeySecret) and list the account's voice-capable numbers and whether Twilio is reachable. Changes nothing and stores nothing. Use it before lines.create with provider twilio.

Argument	Type	Description
apiKeySid*	string
accountSid*	string
workspaceId*	string
apiKeySecret*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "accountSid",
    "apiKeySid",
    "apiKeySecret"
  ],
  "properties": {
    "apiKeySid": {
      "type": "string",
      "pattern": "^SK[0-9a-f]{32}$"
    },
    "accountSid": {
      "type": "string",
      "pattern": "^AC[0-9a-f]{32}$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "apiKeySecret": {
      "type": "string",
      "maxLength": 200,
      "minLength": 16
    }
  }
}

lines_update

Rename a line, make it the default, choose the published inboundAgentId that answers its callers (gateway lines; null stops answering), set testNumbers (customer gateway and Twilio lines), rotatePairing to issue a new pairing code and sign the paired device out, or capacity (Twilio lines: concurrent calls 1–10; phone gateways, SAGOT numbers and shared routes carry one call). The deployment also caps concurrent calls overall. On a SAGOT number line testNumbers can only remove numbers (add them with lines.verifyNumber). `carrierRate` {amountPerMinute, currency, increment minute|second} (null clears) records what your carrier charges on lines whose provider doesn't report prices (phone gateway SIM): calls then show an estimated carrier cost. Twilio lines report Twilio's actual price instead; SAGOT number lines include telecom in SAGOT's charge. `mode: "live"` (admin, not an assistant) lets a SAGOT number line call any number in a supported country once SAGOT has turned live calling on; otherwise it fails LIVE_MODE_UNAVAILABLE.

Argument	Type	Description
id*	string
mode	string
name	string
capacity	integer
revision*	integer
isDefault	boolean
carrierRate	any

lines_verifyNumber

SAGOT number lines, admin only (never an assistant): send a verification code to a phone number the person owns, by SMS (default) or a voice call (`channel: "call"`). Then call lines.confirmNumber with the code. Verified numbers can be called in test mode.

Argument	Type	Description
id*	string
number*	string
channel	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "number"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "number": {
      "type": "string",
      "pattern": "^\\+[1-9][0-9]{6,14}$"
    },
    "channel": {
      "enum": [
        "sms",
        "call"
      ],
      "type": "string",
      "default": "sms"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

members_accept

Signed-in account session only: accept a member invitation issued to this account's email and join the workspace with its role.

Argument	Type	Description
token*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 100,
      "minLength": 32
    }
  }
}

members_invite

Admins: invite an email to this workspace with a role, optionally limited to agentIds (viewer/editor/operator only). SAGOT emails the invitation when email is configured; the one-time link path (/join#member=…) is also returned once as a fallback. The invitee signs in or creates an account with that email. Only the owner can invite admins. Re-inviting an email replaces its earlier pending invitation.

Argument	Type	Description
role*	string
email*	string
agentIds	any
workspaceId*	string
expiresInDays	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "email",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "viewer",
        "editor",
        "operator",
        "admin"
      ],
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "agentIds": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "maxItems": 200,
          "minItems": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "expiresInDays": {
      "type": "integer",
      "default": 7,
      "maximum": 30,
      "minimum": 1
    }
  }
}

members_list

List the people in this workspace with their roles (viewer, editor, operator, admin, owner). Admins also see invitations and their status; tokens are never shown.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

members_preview

Public: show what a member invitation link grants (workspace, inviter, role, invited email, status) before accepting.

Argument	Type	Description
token*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "token"
  ],
  "properties": {
    "token": {
      "type": "string",
      "maxLength": 100,
      "minLength": 32
    }
  }
}

members_remove

Admins remove a member; any member may remove themselves to leave. The owner cannot be removed. Their sessions and API keys stop working in this workspace immediately.

Argument	Type	Description
accountId*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "accountId"
  ],
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

members_revoke

Admins: revoke a pending member invitation by id so its link stops working.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

members_transfer

Owner only, signed-in session: make another member the owner. You become an admin; any agent limit on them is removed. The new owner is emailed.

Argument	Type	Description
accountId*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "accountId"
  ],
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

members_update

Admins: change a member's role and, with agentIds, limit a viewer/editor/operator to selected agents (null = all agents). Takes effect on their next request, including their API keys. The owner's role cannot change; only the owner grants or removes admin.

Argument	Type	Description
role*	string
agentIds	any
accountId*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "accountId",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "viewer",
        "editor",
        "operator",
        "admin"
      ],
      "type": "string"
    },
    "agentIds": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uuid",
            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
          },
          "maxItems": 200,
          "minItems": 1
        },
        {
          "type": "null"
        }
      ]
    },
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_access_end

Platform staff only (account session). End your own pending request or active support access early.

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_access_list

Platform staff only (account session). Your support access requests and grants with status (pending, active, denied, expired, ended — withdrawn or revoked) and expiry.

Argument	Type	Description
limit	integer
offset	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    }
  }
}

platform_access_request

Platform staff only (account session). Requires support. Ask a workspace's owner and admins for read-only support access for 1–72 hours, with a reason they see. Nothing is accessible until they approve.

Argument	Type	Description
hours	integer
reason*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "reason"
  ],
  "properties": {
    "hours": {
      "type": "integer",
      "default": 4,
      "maximum": 72,
      "minimum": 1
    },
    "reason": {
      "type": "string",
      "maxLength": 500,
      "minLength": 3
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_accounts_get

Platform staff only (account session). One account: workspaces with roles, platform role, active sessions and API keys count, suspension.

Argument	Type	Description
accountId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "accountId"
  ],
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_accounts_list

Platform staff only (account session). Every account with email, name, created time, workspaces, platform role and suspension. Search by email or name.

Argument	Type	Description
limit	integer
query	string
offset	integer
status	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "query": {
      "type": "string",
      "maxLength": 200
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "status": {
      "enum": [
        "active",
        "suspended"
      ],
      "type": "string"
    }
  }
}

platform_accounts_reactivate

Platform staff only (account session). Requires manage. Allow the account to sign in again. Revoked sessions and API keys stay revoked; the person signs in again and creates new keys.

Argument	Type	Description
accountId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "accountId"
  ],
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_accounts_suspend

Platform staff only (account session). Requires manage. Suspend an account: its sessions and API keys stop working and sign-in is refused until reactivated. You cannot suspend yourself or a platform owner.

Argument	Type	Description
reason*	string
accountId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "accountId",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 500,
      "minLength": 3
    },
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_audit_list

Platform staff only (account session). Append-only log of platform actions and staff reads under support access, newest first; filter by actorId, targetId or operation.

Argument	Type	Description
limit	integer
offset	integer
actorId	string
targetId	string
operation	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "actorId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "targetId": {
      "type": "string",
      "maxLength": 200
    },
    "operation": {
      "type": "string",
      "maxLength": 100
    }
  }
}

platform_blocklist_add

Platform staff only (account session). Requires manage. Add a number to the platform do-not-call list: no workspace can call it; queued calls to it are canceled. Customers see only that the number is on SAGOT's do-not-call list.

Argument	Type	Description
number*	string
reason*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "number",
    "reason"
  ],
  "properties": {
    "number": {
      "type": "string",
      "pattern": "^\\+[1-9][0-9]{6,14}$"
    },
    "reason": {
      "type": "string",
      "maxLength": 500,
      "minLength": 3
    }
  }
}

platform_blocklist_list

Platform staff only (account session). SAGOT's platform do-not-call list.

Argument	Type	Description
limit	integer
offset	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    }
  }
}

platform_blocklist_remove

Platform staff only (account session). Requires manage. Remove a number from the platform do-not-call list.

Argument	Type	Description
number*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "number"
  ],
  "properties": {
    "number": {
      "type": "string",
      "pattern": "^\\+[1-9][0-9]{6,14}$"
    }
  }
}

platform_calls_list

Platform staff only (account session). Call metadata across workspaces, newest first: workspace, direction, line, status, outcome, duration, charge. Numbers are masked; no transcripts or recordings.

Argument	Type	Description
limit	integer
since	string
offset	integer
status	string
outcome	string
workspaceId	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "since": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "status": {
      "type": "string",
      "maxLength": 40
    },
    "outcome": {
      "type": "string",
      "maxLength": 40
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_credits_grant

Platform staff only (account session). Requires billing. Credit a workspace (centavos, PHP) with a reason the customer sees. Credits are append-only; correct one with a negative amount.

Argument	Type	Description
reason*	string
workspaceId*	string
amountCentavos*	integer

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "amountCentavos",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 500,
      "minLength": 3
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "amountCentavos": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": -10000000
    }
  }
}

platform_credits_list

Platform staff only (account session). Credits granted, newest first; filter by workspaceId.

Argument	Type	Description
limit	integer
offset	integer
workspaceId	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_health

Platform staff only (account session). Health of the database, worker, media (LiveKit), email outbox and paired gateway devices, with the deployment's concurrent-call ceiling and current active calls. Read-only.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

platform_lines_list

Platform staff only (account session). Phone lines across workspaces with provider, mode, capacity, live health, telco warning and active calls. problems=true lists only lines that are unhealthy or have a warning. Never returns secrets.

Argument	Type	Description
limit	integer
offset	integer
problems	boolean
provider	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "problems": {
      "type": "boolean"
    },
    "provider": {
      "type": "string",
      "maxLength": 40
    }
  }
}

platform_overview

Platform staff only (account session). Platform totals: accounts, workspaces (active/suspended), calls today and in 30 days, connected minutes, active calls, charges, lines with problems, pending support requests and waitlist.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

platform_settings_get

Platform staff only (account session). Platform switches: managedLiveCalling (SAGOT number lines in live mode may call any number in a supported country) and whether payments and SAGOT numbers are configured on this deployment.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

platform_settings_update

Platform staff only (account session). Requires manage. Turn live calling from SAGOT numbers on or off for every workspace. Off: live-mode SAGOT lines call only their verified numbers again, effective before the next dial. Audited.

Argument	Type	Description
managedLiveCalling*	boolean	Let SAGOT number lines in live mode call any number in a supported country (phase 42).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "managedLiveCalling"
  ],
  "properties": {
    "managedLiveCalling": {
      "type": "boolean",
      "description": "Let SAGOT number lines in live mode call any number in a supported country (phase 42)."
    }
  }
}

platform_staff_grant

Platform staff only (account session). Requires the staff scope. Give an existing account (by email) a platform role. Owners grant any role; admins grant support or finance. Replaces the account's earlier platform role. Takes effect on the next request.

Argument	Type	Description
role*	string
email*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "email",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "owner",
        "admin",
        "support",
        "finance"
      ],
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    }
  }
}

platform_staff_list

Platform staff only (account session). People with a platform role (owner, admin, support, finance). Bootstrap owners come from the server configuration and cannot be revoked here.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

platform_staff_revoke

Platform staff only (account session). Requires the staff scope. Remove an account's platform role. Admins cannot revoke owners or admins; the last owner and bootstrap owners cannot be removed.

Argument	Type	Description
accountId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "accountId"
  ],
  "properties": {
    "accountId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_subprocessors_notify

Platform staff only (account session). Requires manage. Email every workspace owner (one email per person) that SAGOT will add or replace a sub-processor on effectiveOn — at least 30 days ahead, as the Data Processing Addendum promises — with how to object. Describe what changes, its purpose and location in change. Audited.

Argument	Type	Description
change*	string
effectiveOn*	string	YYYY-MM-DD, at least 30 days from today (UTC).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "change",
    "effectiveOn"
  ],
  "properties": {
    "change": {
      "type": "string",
      "maxLength": 1000,
      "minLength": 10
    },
    "effectiveOn": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "YYYY-MM-DD, at least 30 days from today (UTC)."
    }
  }
}

platform_usage

Platform staff only (account session). Usage for a month (YYYY-MM, default this month) per workspace: calls, connected minutes, charges, credits and net, with platform totals. Rates are proposed (docs/11); no payment is collected.

Argument	Type	Description
month	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "month": {
      "type": "string",
      "pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
    }
  }
}

platform_workspaces_get

Platform staff only (account session). One workspace: owner, members and roles, lines with health, agents, 30-day usage, calling policy summary, suspension, limits, credits and recent platform actions. No transcripts, recordings or contact details.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_workspaces_limits

Platform staff only (account session). Requires manage. Cap how many calls the workspace carries at once across all its lines (1–50, null = no workspace cap). Line capacity and the deployment ceiling still apply.

Argument	Type	Description
workspaceId*	string
maxConcurrentCalls*	any

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "maxConcurrentCalls"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "maxConcurrentCalls": {
      "anyOf": [
        {
          "type": "integer",
          "maximum": 50,
          "minimum": 1
        },
        {
          "type": "null"
        }
      ]
    }
  }
}

platform_workspaces_list

Platform staff only (account session). Every workspace with owner, members, lines, 30-day calls and charges, status and limits. Search by workspace name or owner email. No customer content.

Argument	Type	Description
limit	integer
query	string
offset	integer
status	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "query": {
      "type": "string",
      "maxLength": 200
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "status": {
      "enum": [
        "active",
        "suspended"
      ],
      "type": "string"
    }
  }
}

platform_workspaces_reactivate

Platform staff only (account session). Requires manage. Lift a workspace suspension. Calls canceled during the suspension stay canceled.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

platform_workspaces_suspend

Platform staff only (account session). Requires manage. Suspend a workspace with a reason shown to its members: they can still read and export, every other action fails WORKSPACE_SUSPENDED, queued outbound calls are canceled and inbound calls are not answered.

Argument	Type	Description
reason*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "maxLength": 500,
      "minLength": 3
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

policies_get

SAGOT policies.get. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

policies_update

SAGOT policies.update. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
policy*	object
revision*	integer
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "revision",
    "policy"
  ],
  "properties": {
    "policy": {
      "type": "object",
      "required": [
        "timezone",
        "startHour",
        "endHour",
        "weekdays",
        "maxAttempts",
        "maxSeconds",
        "budgetCentavos",
        "paused",
        "disclosure",
        "retentionDays"
      ],
      "properties": {
        "paused": {
          "type": "boolean"
        },
        "endHour": {
          "type": "integer",
          "maximum": 24,
          "minimum": 1
        },
        "timezone": {
          "type": "string"
        },
        "weekdays": {
          "type": "array",
          "items": {
            "type": "integer",
            "maximum": 6,
            "minimum": 0
          },
          "maxItems": 7,
          "minItems": 1
        },
        "autoRetry": {
          "type": "boolean",
          "default": true,
          "description": "Automatically call again after an unanswered or failed attempt, up to maxAttempts per contact."
        },
        "startHour": {
          "type": "integer",
          "maximum": 23,
          "minimum": 0
        },
        "disclosure": {
          "type": "string",
          "maxLength": 500,
          "minLength": 5,
          "description": "Spoken once after the person agrees to continue, before the main conversation. Not part of the greeting."
        },
        "maxSeconds": {
          "type": "integer",
          "maximum": 300,
          "minimum": 30
        },
        "maxAttempts": {
          "type": "integer",
          "maximum": 5,
          "minimum": 1
        },
        "recordAudio": {
          "type": "boolean",
          "default": true,
          "description": "Keep an audio recording of each call (phase 40-05). Off: no audio is stored; transcripts are still kept for retentionDays. The disclosure must still say the call is recorded or transcribed."
        },
        "retentionDays": {
          "type": "integer",
          "maximum": 90,
          "minimum": 1
        },
        "budgetCentavos": {
          "type": "integer",
          "maximum": 10000000,
          "minimum": 0
        },
        "retryDelayMinutes": {
          "type": "integer",
          "default": 15,
          "maximum": 1440,
          "minimum": 5,
          "description": "Wait before the first automatic retry; each further retry waits twice as long."
        },
        "assistantCallApproval": {
          "type": "boolean",
          "default": true,
          "description": "Calls that a connected AI assistant (OAuth, phase 41) asks for wait until a person approves them on the website. Admins can turn this off; assistants never can."
        },
        "monthlySpendLimitCentavos": {
          "anyOf": [
            {
              "type": "integer",
              "maximum": 10000000,
              "minimum": 0
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Optional cap on what calls on SAGOT numbers may cost per calendar month (UTC), in centavos (phase 42). null (default) = no cap: the prepaid balance is the limit. When set, a call whose maximum cost would pass it is refused."
        }
      }
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

routes_bind

Deprecated alias: add (if needed) and make default the line for this route; inboundAgentId as in lines.update.

Argument	Type	Description
route*	string
workspaceId*	string
inboundAgentId	any

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "route"
  ],
  "properties": {
    "route": {
      "enum": [
        "sip-test",
        "phone-gateway"
      ],
      "type": "string"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "inboundAgentId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}

routes_clearAlert

Deprecated alias of lines.clearAlert for the workspace's default line.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

routes_list

Deprecated alias of lines.list: offered routes with health and the workspace's default line as `bound`.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

support_approve

Workspace admins: approve a pending SAGOT support access request. The staff member gets read-only access for the requested hours, starting now. Nothing can be changed by staff.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

support_deny

Workspace admins: deny a pending SAGOT support access request.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

support_list

Workspace admins: SAGOT support access requests and grants for this workspace, with what staff read while access was active.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

support_revoke

Workspace admins: end active SAGOT support access immediately.

Argument	Type	Description
id*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

usage_get

SAGOT charges, reservations and credits for the workspace (PHP centavos, by line and per call in `ledger`), plus phone carrier costs (phase 44): `carrierCosts` totals per currency, `carrierPendingCalls` still waiting for the provider's price, per line `carrierCosts` and `carrierCostTracking` (provider = Twilio's actual price, line_rate = your rate on the line, included = in SAGOT's charge, not_tracked), and per call `carrierCost`. Carrier costs are billed by your carrier, not SAGOT.

Argument	Type	Description
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId"
  ],
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

waitlist_delete

Platform operators only: permanently remove an applicant's waitlist information. Does not delete their account or invitations.

Argument	Type	Description
id*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

waitlist_join

Request alpha participation with contact consent. Does not create an account or send email.

Argument	Type	Description
name*	string
email*	string
company	string
consent*	boolean
useCase	string
website	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name",
    "email",
    "consent"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1
    },
    "email": {
      "type": "string",
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
      "maxLength": 254
    },
    "company": {
      "type": "string",
      "default": "",
      "maxLength": 160
    },
    "consent": {
      "type": "boolean",
      "const": true
    },
    "useCase": {
      "type": "string",
      "default": "",
      "maxLength": 1000
    },
    "website": {
      "type": "string",
      "default": "",
      "maxLength": 500
    }
  }
}

waitlist_list

Platform operators only: review the alpha queue, oldest first, with status and pagination.

Argument	Type	Description
limit	integer
offset	integer
status	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 100,
      "minimum": 1
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0
    },
    "status": {
      "enum": [
        "waiting",
        "contacted",
        "invited",
        "admitted",
        "closed"
      ],
      "type": "string"
    }
  }
}

waitlist_update

Platform operators only: mark an applicant waiting, contacted or closed.

Argument	Type	Description
id*	string
status*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "id",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "status": {
      "enum": [
        "waiting",
        "contacted",
        "closed"
      ],
      "type": "string"
    }
  }
}

workspaces_create

SAGOT workspaces.create. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
kind	string	personal: calling hours 9–20 every day and a published agent that calls businesses for you (phase 41-02).
name*	string
timezone	string	IANA time zone for calling hours, e.g. America/New_York.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "name"
  ],
  "properties": {
    "kind": {
      "enum": [
        "team",
        "personal"
      ],
      "type": "string",
      "default": "team",
      "description": "personal: calling hours 9–20 every day and a published agent that calls businesses for you (phase 41-02)."
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "timezone": {
      "type": "string",
      "maxLength": 100,
      "description": "IANA time zone for calling hours, e.g. America/New_York."
    }
  }
}

workspaces_delete

Owner only, signed-in session: permanently delete this workspace and everything in it — agents, contacts, calls, recordings, transcripts, lines, API keys and members' access. confirmName must equal the workspace name. Refused while calls are active or a Twilio line exists (delete it first so SAGOT removes what it created in your Twilio account). Cannot be undone; backups expire within about 31 days.

Argument	Type	Description
confirmName*	string	The workspace's exact current name, to confirm.
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "confirmName"
  ],
  "properties": {
    "confirmName": {
      "type": "string",
      "maxLength": 200,
      "description": "The workspace's exact current name, to confirm."
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

workspaces_list

SAGOT workspaces.list. Uses the same authorization and validation as website, API and CLI.

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

workspaces_region

Owner only, signed-in session: choose where AI providers process this workspace's call audio and text — "eu" (European Union) or "us" (United States). No call starts until a region is chosen. Choosing it means accepting this statement: "I am the owner of this workspace. I have chosen this processing region myself and confirm it meets the data protection laws, contracts and customer commitments that apply to this workspace and the people it calls. SAGOT processes call audio and text in the region I choose and is not responsible for the consequences of choosing a region that does not meet those obligations." Applies to calls queued after the change.

Argument	Type	Description
region*	string
workspaceId*	string
acceptResponsibility*	boolean	Must be true: the owner accepts processingRegionStatement (see the description).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "region",
    "acceptResponsibility"
  ],
  "properties": {
    "region": {
      "enum": [
        "eu",
        "us"
      ],
      "type": "string"
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "acceptResponsibility": {
      "type": "boolean",
      "const": true,
      "description": "Must be true: the owner accepts processingRegionStatement (see the description)."
    }
  }
}

workspaces_update

SAGOT workspaces.update. Uses the same authorization and validation as website, API and CLI.

Argument	Type	Description
name*	string
workspaceId*	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "workspaceId",
    "id",
    "revision"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "mode": {
      "enum": [
        "test",
        "live"
      ],
      "type": "string"
    },
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "capacity": {
      "type": "integer",
      "maximum": 10,
      "minimum": 1
    },
    "revision": {
      "type": "integer",
      "maximum": 9007199254740991,
      "exclusiveMinimum": 0
    },
    "isDefault": {
      "type": "boolean",
      "const": true
    },
    "carrierRate": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "amountPerMinute",
            "currency"
          ],
          "properties": {
            "currency": {
              "type": "string",
              "pattern": "^[A-Z]{3}$"
            },
            "increment": {
              "enum": [
                "minute",
                "second"
              ],
              "type": "string",
              "default": "minute"
            },
            "amountPerMinute": {
              "type": "number",
              "maximum": 100000,
              "minimum": 0
            }
          }
        },
        {
          "type": "null"
        }
      ]
    },
    "testNumbers": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^\\+[1-9][0-9]{6,14}$"
      },
      "maxItems": 20
    },
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "rotatePairing": {
      "type": "boolean",
      "const": true
    },
    "inboundAgentId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}