API integration guide

Transform API JSON before it reaches your app, database, or LLM

This page explains what the API can do. The docs page explains how to set it up.

Use Forge Json utilities and saved pipelines to clean, normalize, and prepare JSON inside backend jobs, ingestion workers, UI adapters, and LLM workflows.

What you can run with the Forge JSON API

Put a JSON transformation step between an external API and the app, database, analytics table, or LLM prompt that consumes the response.

Client -> API -> Forge JSON API -> Clean JSON -> UI / Database / LLM

Use utility execution when a packaged utility already matches the job. Use saved pipeline execution when your team has composed a reusable multi-step workflow.

Utility execution

Utilities run one packaged transformation by utility id. They are useful for cleanup, redaction, field selection, value mapping, and other common API response preparation tasks.

The endpoint shape is POST /api/v1/utilities/{utilityId}. Send the source JSON under inputs.primary and utility options under config.

curl -X POST "$BASE_URL/api/v1/utilities/schema.clean-json" \
  -H "Authorization: Bearer fje_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"inputs":{"primary":{"user":{"name":" Ada ","email":null}}},"config":{"trimStrings":true,"removeNulls":true}}'

Saved pipeline execution

Saved pipelines run the workflow you built in the pipeline editor. They are best when you need multiple connected steps, shared team logic, or an auditable transformation that should stay consistent across jobs.

The endpoint shape is POST /api/v1/pipelines/{pipelineId}/run. The pipeline id identifies the saved workflow, and inputs are mapped to the saved pipeline input nodes.

curl -X POST "$BASE_URL/api/v1/pipelines/pl_123/run" \
  -H "Authorization: Bearer fje_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"inputs":{"default":{"orders":[{"id":"A-100","total":"19.99"}]}}}'

Authentication overview

API requests use a Bearer API key. Keep keys in server-side environments, give each key only the permissions it needs, and rotate keys when an integration changes owners or deployment environments.

Utility calls require the utilities permission. Saved pipeline calls require the pipelines permission.

Complete setup guide

For API key creation, first-request setup, saved pipeline execution, and troubleshooting, use the docs as the source of truth.

Read the complete API setup guide.