API Trigger

Overview

The API trigger exposes your workflow as a secure HTTP endpoint. Send JSON data to the endpoint and your workflow processes it immediately. API calls always execute against your latest deployment.

Configure Input Format

Add an Input Format field for each parameter. Runtime output keys mirror the schema and are also available under <api.input>.

- type: string
  name: userId
  value: demo-user # optional manual test value
- type: number
  name: maxTokens

Manual runs in the editor use the value column so you can test without sending a request. During execution the resolver populates both <api.userId> and <api.input.userId>.

Request Example

curl -X POST \
  https://sim.ai/api/workflows/WORKFLOW_ID/execute \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_KEY' \
  -d '{"userId":"demo-user","maxTokens":1024}'

Successful responses return the serialized execution result from the Executor. Errors surface validation, auth, or workflow failures.

Output Reference

If no Input Format is defined, the executor exposes the raw JSON at <api.input> only.