API ReferenceAutomations
Create an automation from a recipe
Creates a draft from a recipe (GET /v1/automation-recipes) with its blanks filled from values. Blanks left out stay empty and must be filled (in the app or with PATCH) before switching it on.
Authorization
api-key AuthorizationBearer <token>
Workspace API key (nim_live_...)
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/automations/from-recipe" \ -H "Content-Type: application/json" \ -d '{ "recipeId": "weekly-planning-reminder" }'{ "id": "9d2f4b1a-6c3e-4f8a-b5d7-1e0a2c4b6d8f", "name": "Monday planning reminder", "description": "string", "status": "DRAFT", "pausedReason": "CHANNEL_REMOVED", "managedBy": null, "trigger": { "type": "trigger.schedule", "summary": "On a schedule (0 9 * * 1 UTC)" }, "steps": [ { "id": "notify", "type": "action.notify", "name": "Send notification", "summary": "message: Time to plan the week" } ], "graph": { "nodes": [ { "id": "notify", "type": "action.notify", "name": "Remind the team", "position": { "x": 420, "y": 200 }, "params": {} } ], "edges": [ { "id": "e1", "source": "trigger", "target": "notify", "sourceHandle": "main" } ] }, "tags": [ "planning" ], "version": 1, "activateInApp": false, "lastRunAt": "string", "nextRunAt": "string", "createdAt": "2026-10-29T09:00:00.000Z", "updatedAt": "2026-10-29T09:00:00.000Z", "appUrl": "https://app.nimply.io/workspace/8b2e5821-…/automations/9d2f4b1a-…"}Empty
Empty
Empty