Documentation

Overview

Interact with Paladin programmatically via the REST API

Base URL#

All API requests are made to:

text
https://app.paladin.northmanngrp.com/api/v1

Versioning#

The current API version is v1. The version is included in the URL path.

Request format#

All request bodies must be sent as JSON with the Content-Type: application/json header.

bash
curl -X POST https://app.paladin.northmanngrp.com/api/v1/workflow/create/definition \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"name": "My Agent", "workflow_definition": {}}'

Response format#

All responses are JSON. Successful responses return the relevant resource object. Error responses follow a consistent shape:

json
{
  "detail": "Error message describing what went wrong"
}

Health check#

Verify the API is reachable before making requests.

bash
curl https://app.paladin.northmanngrp.com/api/v1/health

How to use this reference#

Use this page as the entry point for the related API endpoints. Open the endpoint-specific page when you need the exact method, path, request body, response schema, and OpenAPI details.

Implementation checklist#

  1. Start with the overview table to choose the correct endpoint.
  2. Confirm authentication and organization scope before calling the endpoint from code.
  3. Test with a small request first, then inspect the response and error handling path.