Recordings

Capture user workflows from a browser (or any client you build), upload the events + screenshots, and let SOPFlow's AI pipeline draft SOP steps. Powers the SOPFlow Chrome extension; same surface is open to your own clients.

Lifecycle

1. create — get a recording id and the session starts.
2. uploadEvents — POST batches as the user interacts (max 100 per call).
3. screenshot — multipart POST for any sequence number.
4. finalize — server flips status to processing and runs the AI pipeline.
5. getStatus — poll until ready (or failed); generated steps are ready.
6. importToSOP — convert selected drafts into sop_steps.

{
  "result": {
    "data": {
      "recordingId": "31ab37ce-dce6-4590-a640-b175a1454055"
    }
  }
}

{ "result": { "data": { "inserted": 5 } } }

{ "objectKey": "recording_screenshots/<org>/<rec>/0.webp", "sizeBytes": 12480 }

{ "result": { "data": { "status": "processing", "jobId": "..." } } }

{
  "result": {
    "data": {
      "recording": {
        "id": "31ab37ce-...",
        "status": "ready",
        "eventCount": 42,
        "screenshotCount": 18,
        "durationMs": 65234
      },
      "generatedSteps": [
        {
          "id": "...",
          "stepNumber": 1,
          "title": "Navigate to the Login page",
          "description": "Open the SOPFlow login URL.",
          "screenshotKey": "recording_screenshots/<org>/<rec>/0.webp",
          "sourceEventIds": ["..."]
        }
      ]
    }
  }
}

{ "result": { "data": { "createdSteps": [{ "id": "...", "title": "..." }] } } }

Provisioning a key for your client

For server-to-server use, mint an API key in Settings → API keys with the read + write scopes and keep it on your trusted server. Never embed a shared service key in public browser code.

For browser extensions and desktop clients that act on behalf of an end-user, use the post-OAuth bridge:

{ "result": { "data": { "key": "sk_live_…", "prefix": "sk_live_abcd" } } }

End-to-end example

# 1. Create a new recording session
curl -X POST https://sopflow.io/trpc/recording.create \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"chrome_extension"}'

# 2. Stream events as you capture them (max 100 per call)
curl -X POST https://sopflow.io/trpc/recording.uploadEvents \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "recordingId":"<from step 1>",
    "events":[
      {"sequenceNumber":0,"eventType":"click","url":"https://example.com",
       "pageTitle":"Home","target":{"cssSelector":"button.cta",
       "elementType":"BUTTON","textContent":"Sign in"},"timestamp":1730000000000}
    ]
  }'

# 3. Optionally POST a screenshot for any sequenceNumber
curl -X POST \
  https://sopflow.io/api/v1/recordings/<id>/screenshot/0 \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -F "file=@frame.webp;type=image/webp"

# 4. Finalize — kicks off the AI pipeline asynchronously
curl -X POST https://sopflow.io/trpc/recording.finalize \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"recordingId":"<id>","durationMs":65000}'

# 5. Poll for the result (status flips to "ready")
curl "https://sopflow.io/trpc/recording.getStatus?input=%7B%22recordingId%22%3A%22<id>%22%7D" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

Notes

• Privacy is the client's responsibility. The server stores whatever eventData.value you send. The Chrome extension masks password fields and credit-card autocomplete fields before they leave the page; if you build your own client, do the same. The pipeline does a regex sweep for cards / SSNs / emails as a last-line defense, but don't rely on it.
• Rate limits. tRPC requests are subject to the general API limit (300 requests per minute per IP), not the REST per-key budgets. Batch up to 100 events per call and handle 429 responses.
• Restart recovery. If the API restarts mid-processing, the recording is auto-marked failed on the next boot. Call recording.reprocess to retry.