Access Rules
Access Tokens
Agent Conversations
App Invites
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)
- POSTExchange a user token for a token scoped to a different company
- 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
- GETList data planes
- POSTCreate a data plane
- GETGet a data plane by ID
- DELArchive a data plane
- POSTData plane heartbeat
- POSTTrigger a health check
- PUTReplace the collaborators on a data plane
- PUTAdd a collaborator to a data plane
- DELRemove a collaborator from a data plane
- PUTSet the default compute pool for a data plane
- DELClear the default compute pool for a data plane
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.
Dataset Configuration
Dataset Mappings
Dataset Refresh
Dataset Samples
Dataset Statistics
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
- GETGet admin info for a dataset
- POSTUpdate a dataset's partition spec
- GETGet dataset statistics
- GETGet detailed statistics
- PUTCreate or Update detailed statistics
- POSTSubmit recalculation
- POSTIngest a file
- GETMetrics
- GETMetrics
- GETGet Metrics Configuration
- PUTPut Metrics Configuration
- DELDisable configuration
- PUTDerive the configuration
- POSTEnable configuration
- GETList connector interfaces compatible with a dataset
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
Replace the collaborators on a data plane
curl --request PUT \
--url https://api-dev.narrative.io/data-planes/{data_plane_id}/collaborators \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participants": {},
"manage_compute_pools": {}
}
'Data Planes
Replace the collaborators on a data plane
Overwrites the entire collaborators object on the data plane, setting both participants (who may
use the data plane) and manage_compute_pools (which companies may create / edit / archive compute
pools on it). Mirrors the whole-object PUT pattern used by attributes.
The granular per-company PUT/DELETE /data-planes/{data_plane_id}/collaborators/{collaborator_company_id}
endpoints continue to work for incremental mutation of participants; this endpoint is the only way
to set manage_compute_pools.
PUT
/
data-planes
/
{data_plane_id}
/
collaborators
Replace the collaborators on a data plane
curl --request PUT \
--url https://api-dev.narrative.io/data-planes/{data_plane_id}/collaborators \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"participants": {},
"manage_compute_pools": {}
}
'Documentation Index
Fetch the complete documentation index at: https://docs.narrative.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Response
Collaborators replaced
Was this page helpful?
⌘I