Skip to content

by Startups.Studio

Core grammar Thing Collection

Collection.export

POST /{namespace}/collections/{collection}/export

Export writes a Collection’s records to a file or the Startup’s warehouse, once or on a schedule.

Noun: Collection
Mode: do
Event: Collection.exported

You, to your agent

Export the latest collection.

curl -X POST https://api.sb/tutorloop.com/collections/collection_1/export \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"Example to"}'

import { $ } from 'startup-builder'

const { file, collection } = await $.Collection.export({ collection: 'collection_1', to: 'Example to' })

npx startup-builder do Collection.export --json '{"collection":"collection_1","to":"Example to"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Collection.export({ collection: 'collection_1', to: 'Example to' })"
  }
}

Inputs

Input	Type	Required	Description
`collection`	Collection	required	The Collection to export.
`to`	`string`	required	A file format, or the warehouse Integration that receives it.
`cadence`	`string`		How often it repeats; omitted, it runs once.

Outputs

Output	Type	Required	Description
`file`	File		The exported File, for a one-time export.
`collection`	Collection	required	The Collection exported.

Effects

Emits Collection.exported.
Performed by the Data Engineer.
Two-way: it runs at once, in the try, send and do modes.
Masks fields the caller’s Permissions hide.

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.	Collection.export

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
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 from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Collection.delete

Previous Page

Collection.get

Next Page