Quick Start

Getting Started with Synergy

Up and running in 5 minutes

2 Working with Assets

Upload Files

Upload files via the dashboard or API:

  • Dashboard: Drag & drop files or click to browse
  • API: POST to /api/v1/assets with multipart/form-data
JPEG PNG TIFF PSD PDF AI EPS TTF/OTF

Automatic Metadata Extraction

Synergy automatically extracts rich metadata:

Images

Dimensions, DPI, color space (RGB/CMYK), ICC profile

PDFs

Page count, dimensions, fonts, PDF/X compliance

Fonts

Family, weight, style, glyph count

3 Creating Pipelines

Pipelines transform data between systems without code. Connect REST APIs, SOAP services, and print equipment.

Quick Example: JSON to XML

POST /api/v1/pipelines
{
  "name": "JSON to XML Converter",
  "config": {
    "trigger": { "type": "http", "method": "POST", "path": "/convert" },
    "blocks": [
      { "id": "1", "type": "parse_json", "config": {} },
      { "id": "2", "type": "to_xml", "config": { "rootElement": "data" } },
      { "id": "3", "type": "return_response", "config": {} }
    ],
    "connections": [
      { "from": "1", "to": "2" },
      { "from": "2", "to": "3" }
    ]
  }
}

Available Block Types

Category Blocks
Parse parse_json, parse_xml, parse_jdf
Transform map_fields, validate, filter_fields, merge_data
Generate to_json, to_xml, to_jdf
Forward forward_rest, forward_soap, forward_jdf

4 API Authentication

Get Your API Key

  1. Log in to your dashboard
  2. Navigate to Settings → API Keys
  3. Click "Create API Key"
  4. Copy your key (starts with syn_)

Using Your API Key

curl https://your-domain.railway.app/api/v1/assets \
  -H "Authorization: Bearer syn_your_api_key_here"
Keep your API keys secure! Never commit them to version control or share them publicly.

Ready to get started?

Create Your Free Account