Skip to the page

Activepieces

Add live web data to an Activepieces flow and start a flow for every record SpecStream delivers. Each value arrives with the page it was read from and when.

SpecStream for ActivepiecesAutomation

What you need

  • An Activepieces platform where you are an admin and can install pieces from npm.
  • A SpecStream account and the API key you make in step 2.
  1. 1. Install the piece

    In Activepieces, open Platform admin, then Pieces, then Install piece. Choose npm and enter @specstream/piece-specstream. SpecStream is now a piece you can add to any flow.

  2. 2. Create an API key

    Go to Agents & API in SpecStream, switch to the API keys tab, and use Create API key.

    Build the key up from what your flows do. Read account and balance is the base, because the piece reads your account when you connect. Add Read results and their sources for Get List Results and the triggers. Add Read saved requests, Create and edit requests, Prepare work and follow-ups, and Authorize paid work for Find a List.

    A trigger registers a webhook on your account, so the key can't be tied to one project. A flow spends only inside the key's Total spending limit, when you set one. It also spends inside the account limit, which you set in Settings under Usage and billing.

    SpecStream displays the key once, when you create it. Put it somewhere you can reach it before you close the window.

  3. 3. Connect with your key

    Add a SpecStream step, create a connection, and paste the key into API Key. Activepieces tests it on save and reports Invalid API Key. when SpecStream turns it down.

  4. 4. Add Find a List to a flow

    Drop Find a List into a flow and fill in What to Find, Number of Results, which starts at 25, and Maximum Price (USD).

    SpecStream reads and prices the request. The run starts if the most it can cost is at or below your maximum. If it is higher, the step fails with the price and nothing is spent.

    While the run is still going, the step returns list_id, status, request, number_of_results, maximum_price_usd, and list_link. Run Key, 8 to 128 characters, names one run: a second step with the same key gets the run already started. Left empty, identical requests in the same UTC hour share a run, so a retried step never buys twice.

  5. 5. Read a list with Get List Results

    Give Get List Results the list's ID, which starts with fnd_. It returns status (running, completed, partial, failed, canceled, or expired), number_of_rows, list_link, and rows. Each row is a flat object keyed by column. Reading is free, and one call returns up to 100 rows.

  6. 6. Start a flow for every record

    New Row in a Finished List runs the flow once for every row when any list on your account finishes, including lists started by Find a List, in the workspace, or by an agent.

    New or Changed Row in a Watched List runs it once for each new or changed row when a monitored list is read again. A watched list is a list with a monitor: click Keep it current on it in SpecStream, choose a cadence, and save with Start monitor.

    Enabling a flow with either trigger registers a webhook with SpecStream, and disabling it removes the webhook. Testing a trigger loads rows from your newest finished list, or a sample row when you have none.

What arrives

A trigger run and each entry in rows share one shape.

FieldWhat it holds
idThe record's ID, prefixed with its list ID.
list_id, list_linkThe record's list and a link to open it.
positionWhere the record sits in the list.
Column fieldsOne per column, keyed by the column's label.
source_urlThe page where the first value in the record was read.
checked_atThe time that page was read.

Other endpoints

Custom API Call sends an authenticated request to any path on https://api.specstream.ai, such as /v1/me, or to a full HTTPS address on that host. Redirects are not followed, so the key never travels beyond SpecStream. The API reference lists the endpoints.

Use it with AI steps

The piece describes each action for AI agents in your platform. Find a List is marked as spending money from your balance and not safe to repeat. Get List Results is marked free and safe to repeat.

Limits and cost

The piece is free. Runs are paid from your SpecStream balance, only for the records that match, up to the maximum on the step. Balance, quotes, and billing shows how rates work.

Disconnect

Revoking the key in Agents & API cuts access at once, and removing the connection in Activepieces drops it on that side. Rows your flows already wrote to other apps stay where they landed. For help with the piece, email [email protected].

More

SpecStream for Activepieces covers what it does in Activepieces on one page. Every other tool has its guide in Connect your tools. You see the most a request can cost before it starts, and only the matches come out of your balance. Billing has the details. For help, email [email protected].