Skip to content

by startups.studio

by Startups.Studio

Product What you sell Product Dataset

Dataset.refresh

POST /{namespace}/datasets/{dataset}/refresh

Refresh re-reads a Dataset’s Sources now instead of on schedule, and records what changed.

Noun: Dataset
Mode: do
Event: Dataset.refreshed

You, to your agent

Refresh the latest dataset.

curl -X POST https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB/refresh \
  -H "Authorization: Bearer $SB_TOKEN"

npx startup-builder do Dataset.refresh --data '{"dataset":"dataset_UDQXk0KsJB"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Dataset.refresh({ dataset: 'dataset_UDQXk0KsJB' })"
  }
}

import { $ } from 'startup-builder'

const dataset = await $.Dataset.refresh({ dataset: 'dataset_UDQXk0KsJB' })

Inputs

Input	Type	Required	Description
`dataset`	Dataset	required	The Dataset.
`source`	Source		One Source to read; absent, every Source.

Outputs

Output	Type	Required	Description
`dataset`	Dataset	required	The Dataset, with `refreshedAt` set.

Effects

Fact	Value
Action class	None: no approval rule names it, so it runs within its seat's Permissions and Limits
Stakes	The Startup's own records only
Door	Two-way: it runs at once
Modes	`try` previews it and stores nothing; `send` returns a pending Action; `do` (default) waits for the result
Idempotent	Only with a key: a repeat with the same `Idempotency-Key` and input returns the first Action, the same key with other input is refused with `409`, and a repeat without a key runs again
Undo	Action.undo reverses it
Emits	`Dataset.refreshed`
Performed by	The Data Engineer

Never overwrites: each changed value keeps the one it replaced, and a read with at returns either.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.
`dataset` is missing, or is not a dataset	`invalid-input`	Send `dataset` as a dataset, then call it again.	None.
The `Idempotency-Key` was sent before with another operation or other input	`idempotency-mismatch`	Send a new key for new input; reuse a key only to retry the same request.	None.

When it waits

Gate	Default
Decision class	Low: two-way, no delay window
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval, which a Human answers: the owner of record, or a Human they named to approve for the Founder seat. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

To retry, send the same Idempotency-Key: the retry returns the first Action and runs nothing twice. A new key runs the call again.

Dataset.list

Previous

Dataset.update

Next