Documentation

Trigger an Outbound Call by API Trigger Node

Initiate an outbound call using an API Trigger node UUID

Trigger an Outbound Agent Run by API Trigger Node#

Start an outbound agent run using an API Trigger node UUID

Use this endpoint when you want to start an agent run through an API Trigger node.

The uuid comes from the API Trigger node in your agent. Add the node to your workflow and copy its auto-generated trigger_path.

Use workflow_run_id from the response to later retrieve run details, recordings, and transcripts.

Pass initial_context to inject runtime data as template variables into the agent's prompt. See Using initial context.

Pass telephony_configuration_id to route the call through a specific telephony configuration instead of your organization's default. The id is shown on each row in Telephony configurations (https://app.paladin.northmanngrp.com/telephony-configurations).

Quick reference#

Initiate an outbound call using an API Trigger node UUID. Send the request to POST /api/v1/public/agent/{uuid} on the Paladin API base URL.

Method	`POST`
Path	`/api/v1/public/agent/{uuid}`
Path parameters	uuid
Authentication	Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side.

Before you call#

Confirm you are using the production base URL shown in the API reference.
Make sure any path IDs belong to the same Paladin organization as the credential you are using.
Validate request bodies and required fields before sending production traffic.

Common error checks#

Use 401 or 403 responses to check credentials, organization scope, and permissions.
Use 404 responses to check whether the referenced resource exists in the current organization.
Use 422 responses to inspect missing or invalid request fields.

OpenAPI#

POST /api/v1/public/agent/{uuid}

openapi: 3.1.0
info:
  title: Paladin API
  description: API for the Paladin app
  version: 1.0.0
servers:
  - url: https://app.paladin.northmanngrp.com
    description: Production

security: []
paths:
  /api/v1/public/agent/{uuid}:
    post:
      tags:
        - main
      summary: Initiate Call
      description: |-
        Initiate a phone call against the published agent.

        Executes the workflow's currently released definition.
      operationId: initiate_call_api_v1_public_agent__uuid__post
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
            title: Uuid
        - name: X-API-Key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TriggerCallRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TriggerCallResponse'
        '404':
          description: Not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    TriggerCallRequest:
      properties:
        phone_number:
          type: string
          title: Phone Number
        initial_context:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Initial Context
        telephony_configuration_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Telephony Configuration Id
      type: object
      required:
        - phone_number
      title: TriggerCallRequest
      description: Request model for triggering a call via API
    TriggerCallResponse:
      properties:
        status:
          type: string
          title: Status
        workflow_run_id:
          type: integer
          title: Workflow Run Id
        workflow_run_name:
          type: string
          title: Workflow Run Name
      type: object
      required:
        - status
        - workflow_run_id
        - workflow_run_name
      title: TriggerCallResponse
      description: Response model for successful call initiation
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError