Access Rules
Access Tokens
Apps
Attributes
Authentication
- POSTAuthenticate a user based on a Stytch session token (B2B version)
- POSTRegister a user based on a Stytch session token (B2B)
- POSTReport whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side (B2B)
- POSTAuthenticate a user based on a Stytch session token
- POSTRegister a user based on a Stytch session token
- POSTReport whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side
Company
Company Marketing Information
Compute Pools
Connections
Contracts
Data Planes
Data Shops
Data Streams
- POSTCreate a data-stream.
- GETGet a data-stream by its id.
- PUTUpdate a data-stream.
- POSTFetch many data-streams
- GETGet all data-streams for a company.
- GETGet all data-streams for a company given a search expression.
- GETGets the data-stream for a given company and slug.
- GETGet schema
- GETGet all data-streams for the given company and its data-shop hostname.
- GETFind data-streams for the given company and its data-shop hostname and the given search expression.
- GETGet all data-streams for a company given a sales channel
- GETFind data-streams for the given company and a sales-channel and the given search expression.
- GETFind data-streams available on the data-streams-market.
Datasets
- GETGet datasets
- PUTUpdate a dataset
- POSTCreate a dataset
- GETGet a dataset
- PUTUpdate a dataset
- DELDelete a dataset
- PUTActivate a dataset
- POSTActivate a datasetdeprecated
- POSTTruncate a dataset
- GETSample a dataset
- DELDelete a sample
- GETGet admin info for a dataset
- GETSample a dataset (Admin)
- POSTUpdate a dataset's partition spec
- POSTPreview snapshot expirations
- PUTUpsert retention policies for a dataset
- POSTRequest Dataset Sample
- GETSampled Mappings
- POSTSuggest mappings
- GETGet dataset statistics
- GETGet detailed statistics
- PUTCreate or Update detailed statistics
- POSTSubmit recalculation
- POSTIngest a file
- GETFiles added
- GETFind snapshots
- GETMetrics
- GETMetrics
- GETGet Metrics Configuration
- PUTPut Metrics Configuration
- DELDisable configuration
- PUTDerive the configuration
- POSTEnable configuration
- GETFind files
- POSTIssue file download url
- PUTUpdate the materialized view refresh configuration
- POSTCreate a refresh schedule for an existing materialized view
- DELArchive the materialized view refresh configuration
- POSTRun a materialized view refresh now
Destinations
Encryption Materials
Installations
Mappings
Model Inference
Payment Methods
Permissions
Products
Profiles
Queries
Schema Inference
Schema Presets
Subscriptions
- GETGet subscriptions
- POSTCreate a subscription
- GETGet cost forecasts
- POSTCreate a cost forecast
- GETGet a cost forecast
- POSTGet matches
- GETGet a subscription
- PUTUpdate a subscription
- DELDelete a subscription
- POSTActivate a subscription
- POSTCancel a subscription
- POSTCheckout a subscription
- GETGet subscription cost forecasts
- POSTCreate a cost forecast for a subscription
- GETGet deliveries
- POSTGet a delivered file
- GETGet subscription matches
- GETGet schema
Uploads
Webhooks
Whoami
Schedule a workflow
Copy
Ask AI
curl --request POST \
--url https://api-dev.narrative.io/workflows/{workflow_id}/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"trigger_immediately": false
}
'Copy
Ask AI
{
"run_id": "b7e3f1a2-4c5d-6e7f-8a9b-0c1d2e3f4a5b"
}Workflows
Schedule a workflow
Create a schedule for a workflow based on the cron expression defined in its specification.
The workflow specification must contain a schedule section.
Optionally, the workflow can also be triggered immediately by setting trigger_immediately to true.
POST
/
workflows
/
{workflow_id}
/
schedule
Schedule a workflow
Copy
Ask AI
curl --request POST \
--url https://api-dev.narrative.io/workflows/{workflow_id}/schedule \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"trigger_immediately": false
}
'Copy
Ask AI
{
"run_id": "b7e3f1a2-4c5d-6e7f-8a9b-0c1d2e3f4a5b"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier for a workflow.
Body
application/json
If true, the workflow will also be triggered immediately after scheduling.
Example:
false
Response
The workflow was scheduled successfully.
The run ID if the workflow was triggered immediately after scheduling.
Example:
"b7e3f1a2-4c5d-6e7f-8a9b-0c1d2e3f4a5b"
Was this page helpful?
⌘I