Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hellofriday.ai/llms.txt

Use this file to discover all available pages before exploring further.

In this guide, you’ll trigger a Friday workflow from your application, stream its progress in real time, and optionally cancel it.

​
Prerequisites

  • Friday Studio installed and running
  • At least one space loaded with a signal configured
  • The daemon API is available at http://localhost:18080
Run curl http://localhost:18080/api/workspaces to see your loaded spaces and their IDs. Each space’s signals object shows what signals are available and what payload fields they expect.

​
Trigger a signal

Every workflow starts with a signal. Send a POST request with a payload and Friday runs the job.

​
Fire and wait

Send a POST and block until the job completes: 
curl -X POST http://localhost:18080/api/workspaces/{workspaceId}/signals/{signalId} \
  -H 'Content-Type: application/json' \
  -d '{"payload": {"key": "value"}}'
Response: 
{
  "message": "Signal completed",
  "status": "completed",
  "workspaceId": "my-space",
  "signalId": "my-signal",
  "sessionId": "sess_abc123"
}

​
Stream progress in real time

Add Accept: text/event-stream to receive a live SSE stream as the job executes: 
curl -N -X POST http://localhost:18080/api/workspaces/{workspaceId}/signals/{signalId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/event-stream' \
  -d '{"payload": {"key": "value"}}'
Event stream: 
data: {"type":"data-session-start","data":{"sessionId":"sess_abc123"}}

data: {"type":"text-delta","delta":"Fetching emails..."}

data: {"type":"job-complete","data":{"success":true,"sessionId":"sess_abc123","status":"completed"}}

data: [DONE]

​
Check run status

Use the sessionId from the trigger response to check on the run: 
curl http://localhost:18080/api/sessions/sess_abc123

​
Cancel a running job

If you need to stop a job mid-execution: 
curl -X DELETE http://localhost:18080/api/sessions/sess_abc123

​
Next steps

API reference

Full endpoint reference for every API operation.

Signals

Signal types, payload schemas, and webhook configuration.