AdminStart the Workflows canary (non-prod)

Start the Workflows canary (non-prod)

Launches a harmless sleeping canary workflow so the engine can be exercised and the Workflows view has a running instance to observe/stop. Disabled in prod. Requires dual auth: X-Admin-API-Key + JWT.

curl -X POST "https://api.spkey.co/admin/workflows/canary?seconds=example_string&steps=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "success": true,
  "instanceId": "example_string",
  "seconds": 3.14,
  "steps": 3.14
}
POST
/admin/workflows/canary
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
query
secondsstring

Total seconds the canary should run (default: 60).

query
stepsstring

Number of sleep/progress steps to split the run into (default: 6).

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Query Parameters

secondsstring

Total seconds the canary should run (default: 60).

stepsstring

Number of sleep/progress steps to split the run into (default: 6).

Responses

successboolean
Required
instanceIdstring
Required
secondsnumber
Required
stepsnumber
Required