Skip to main content
POST
Connect Magicline Connect API

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
studio_id
string
required

Numeric studio ID supplied by your studio operator.

Pattern: ^[1-9][0-9]{0,18}$
connect_api_base_url
string<uri>
required

Official https://.api.magicline.com/connect/v1 URL. No API key is needed.

name
string
default:magicline_connect

Unique tool name, using letters, numbers and underscores.

trainer_mode
enum<string>
default:studio_default

Trainer preference. Studio default follows studio rules and permits the caller to choose only when allowed. Without a trainer requires studio permission.

Available options:
studio_default,
with_trainer,
without_trainer
studio_ids
string[]

Optional enabled studio IDs. Includes studio_id automatically. Use discovered IDs. Open API multi-studio mode requires a shared proxy key; native per-studio keys remain separate.

Maximum array length: 500
Pattern: ^[1-9][0-9]{0,18}$

Response

Created. Secret values are masked.

data
object
required

A reusable tool of the account. Secret values inside config (auth values, header values) are always masked as •••.