# Narrative I/O Knowledge Base

## Docs

- [API Keys](https://docs.narrative.io/account-settings/api-keys.md): Create, manage, and secure API keys for authenticating requests to the Narrative API
- [SSO Configuration](https://docs.narrative.io/account-settings/sso.md): Configure SAML 2.0 single sign-on for your Narrative I/O organization
- [Create a new Access Rule](https://docs.narrative.io/api-reference/access-rules/create-a-new-access-rule.md): Creates a new access rule based on the provided NQL query.
- [Delete an access rule](https://docs.narrative.io/api-reference/access-rules/delete-an-access-rule.md): Access rule deletion cannot be undone.
- [Get all accessible Access Rules (V2)](https://docs.narrative.io/api-reference/access-rules/get-all-accessible-access-rules-v2.md): Get all accessible Access Rules.
- [Get an Access Rule by id (V2)](https://docs.narrative.io/api-reference/access-rules/get-an-access-rule-by-id-v2.md): Get an access rule.
- [Get an Access Rule by name (V2)](https://docs.narrative.io/api-reference/access-rules/get-an-access-rule-by-name-v2.md): Get an access rule by name and company slug.
- [Update an Access Rule by id (V2)](https://docs.narrative.io/api-reference/access-rules/update-an-access-rule-by-id-v2.md): Update an access rule.
- [Create a System Access Token](https://docs.narrative.io/api-reference/access-tokens/create-a-system-access-token.md): Create a System Access Token
- [Delete a System Access Token](https://docs.narrative.io/api-reference/access-tokens/delete-a-system-access-token.md): Delete a System Access Token
- [Get a System Access Token by id](https://docs.narrative.io/api-reference/access-tokens/get-a-system-access-token-by-id.md): Get a System Access Token by id
- [List System Access Tokens](https://docs.narrative.io/api-reference/access-tokens/list-system-access-tokens.md): List System Access Tokens
- [Update a System Access Token](https://docs.narrative.io/api-reference/access-tokens/update-a-system-access-token.md): Update a System Access Token
- [Delivery Commands](https://docs.narrative.io/api-reference/app-api/delivery-commands.md): Lists delivery commands this app has access to.
- [Delivery Files](https://docs.narrative.io/api-reference/app-api/delivery-files.md): Lists delivery files for a particular delivery command.
- [Download file](https://docs.narrative.io/api-reference/app-api/download-file.md): Generates a download url for a particular delivery file
- [Activate an app invite](https://docs.narrative.io/api-reference/app-invites/activate-an-app-invite.md): Activates an app invite, changing its status from `pending` to `active`.
- [Archive an app invite](https://docs.narrative.io/api-reference/app-invites/archive-an-app-invite.md): Archives an app invite by its ID.
- [Create an app invite](https://docs.narrative.io/api-reference/app-invites/create-an-app-invite.md): Creates a new app invite for a company.
- [Get an app invite](https://docs.narrative.io/api-reference/app-invites/get-an-app-invite.md): Returns a specific app invite by its ID.
- [Get app invite by code](https://docs.narrative.io/api-reference/app-invites/get-app-invite-by-code.md): Returns a public view of an app invite by its invite code.
- [List app invites](https://docs.narrative.io/api-reference/app-invites/list-app-invites.md): Returns all app invites for the authenticated company and app.
- [Get Data instance](https://docs.narrative.io/api-reference/apps/get-data-instance.md)
- [Get Schema](https://docs.narrative.io/api-reference/apps/get-schema.md)
- [Get Schema](https://docs.narrative.io/api-reference/apps/get-schema-1.md)
- [Lists apps](https://docs.narrative.io/api-reference/apps/lists-apps.md)
- [Lists profiles](https://docs.narrative.io/api-reference/apps/lists-profiles.md)
- [Post Data instance](https://docs.narrative.io/api-reference/apps/post-data-instance.md): Submitting (create or update) data for a profile.
- [Publish app event](https://docs.narrative.io/api-reference/apps/publish-app-event.md): Create a new webhook subscription for the authenticated company.
- [Put Schema](https://docs.narrative.io/api-reference/apps/put-schema.md): Submitting (create or update) JSON Schema (2019-09 version) for an app.
- [Update a slug](https://docs.narrative.io/api-reference/apps/update-a-slug.md): Slug can be changed (from NULL) just once.
- [Create an attribute](https://docs.narrative.io/api-reference/attributes/create-an-attribute.md): Create a new attribute.
- [Delete an attribute](https://docs.narrative.io/api-reference/attributes/delete-an-attribute.md): Permanently removes an attribute from the platform.
- [Get an attribute](https://docs.narrative.io/api-reference/attributes/get-an-attribute.md)
- [Get attribute references.](https://docs.narrative.io/api-reference/attributes/get-attribute-references.md)
- [Get attributes](https://docs.narrative.io/api-reference/attributes/get-attributes.md): Return all attributes.
- [Request or refresh an OAuth token](https://docs.narrative.io/api-reference/auth/request-or-refresh-an-oauth-token.md): # /oauth/token # Requests or refreshes the OAuth Token.
- [Authenticate a user based on a Stytch session token](https://docs.narrative.io/api-reference/authentication/authenticate-a-user-based-on-a-stytch-session-token.md): Authenticate the user based on the Stytch session token, and return the user information, and API Access Token. The Stych session token can be obtained from a Magic Links or OAuth token thanks to the registration status API.
- [Authenticate a user based on a Stytch session token (B2B version)](https://docs.narrative.io/api-reference/authentication/authenticate-a-user-based-on-a-stytch-session-token-b2b-version.md): Authenticate the user based on the Stytch session token, and return the user information, and API Access Token.
- [Exchange a user token for a token scoped to a different company](https://docs.narrative.io/api-reference/authentication/exchange-a-user-token-for-a-token-scoped-to-a-different-company.md): Exchange the current user access token for a new token scoped to the specified company. The user can only exchange their token to be scoped to another company to which they belong.
- [Register a user based on a Stytch session token](https://docs.narrative.io/api-reference/authentication/register-a-user-based-on-a-stytch-session-token.md): Register the user based on the Stytch session token and name/company name, and return the the created user id. The Stych session token can be obtained from a Magic Links or OAuth token thanks to the registration status API.
- [Register a user based on a Stytch session token (B2B)](https://docs.narrative.io/api-reference/authentication/register-a-user-based-on-a-stytch-session-token-b2b.md): Register the user based on the Stytch session token and name/company name, and return the the created user id. The Stych session token can be obtained from a Magic Links or OAuth token thanks to the registration status API.
- [Report whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side](https://docs.narrative.io/api-reference/authentication/report-whether-the-user-associatd-to-a-stytch-oauth-or-magic-links-token-has-been-fully-registered-on-narrative-side.md): Report whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side. Provides a Stytch session token that can be used to access the login and register APIs.
- [Report whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side (B2B)](https://docs.narrative.io/api-reference/authentication/report-whether-the-user-associatd-to-a-stytch-oauth-or-magic-links-token-has-been-fully-registered-on-narrative-side-b2b.md): Report whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side. Provides a Stytch session token that can be used to access the login and register APIs.
- [Get dataset storage billing](https://docs.narrative.io/api-reference/billings/get-dataset-storage-billing.md): Get dataset storage billings paginated.
- [Get dataset storage billing for company](https://docs.narrative.io/api-reference/billings/get-dataset-storage-billing-for-company.md): Get dataset storage billings for a company id paginated. Company id is extracted from token.
- [Get a presigned URL to upload company logo](https://docs.narrative.io/api-reference/companies/get-a-presigned-url-to-upload-company-logo.md): Sending a file to Narrative is a two step process. This endpoint allows you to request an `upload_url` which can be used in a `PUT` request to upload the file. For example, once you have received an `upload_url` you could use it as follows:
- [Lists Company Domains](https://docs.narrative.io/api-reference/companies/lists-company-domains.md): # /companies/{company_id}/domains
- [Get all data-streams provider companies](https://docs.narrative.io/api-reference/company-marketing-information/get-all-data-streams-provider-companies.md): Returns all the companies providing data-stream market offers.
- [Get marketing details on a company](https://docs.narrative.io/api-reference/company-marketing-information/get-marketing-details-on-a-company.md): Returns the marketing detailed information on a company.
- [Returns the company and user associated with the token](https://docs.narrative.io/api-reference/company-marketing-information/returns-the-company-and-user-associated-with-the-token.md): Returns the company and user associated with the token.
- [Delete (archive) a company](https://docs.narrative.io/api-reference/company/delete-archive-a-company.md)
- [Get a company](https://docs.narrative.io/api-reference/company/get-a-company.md)
- [Get a company](https://docs.narrative.io/api-reference/company/get-a-company-1.md)
- [Update a company](https://docs.narrative.io/api-reference/company/update-a-company.md): Update the company. Please note that "slug" could be changed only once (from null to some value). Lack of slug (in the request) considered as change to null and passes validation if current value is null too. Status can be changed from pending to active but not in the opposite direction.
- [Update a user](https://docs.narrative.io/api-reference/company/update-a-user.md)
- [Archive a compute pool](https://docs.narrative.io/api-reference/compute-pools/archive-a-compute-pool.md): Archive the specified compute pool owned by the authenticated company.
- [Create a compute pool](https://docs.narrative.io/api-reference/compute-pools/create-a-compute-pool.md): Create a new compute pool owned by the authenticated company.
- [Get a compute pool by ID](https://docs.narrative.io/api-reference/compute-pools/get-a-compute-pool-by-id.md): Retrieve a specific compute pool accessible to the authenticated company.
- [List compute pools](https://docs.narrative.io/api-reference/compute-pools/list-compute-pools.md): Retrieve all compute pools accessible to the authenticated company.
- [Update a compute pool](https://docs.narrative.io/api-reference/compute-pools/update-a-compute-pool.md): Update an existing compute pool owned by the authenticated company.
- [Archive a connection](https://docs.narrative.io/api-reference/connections/archive-a-connection.md)
- [Creates a connection](https://docs.narrative.io/api-reference/connections/creates-a-connection.md)
- [Returns a connection](https://docs.narrative.io/api-reference/connections/returns-a-connection.md)
- [Searches for connections from a given dataset id](https://docs.narrative.io/api-reference/connections/searches-for-connections-from-a-given-dataset-id.md)
- [Create contract](https://docs.narrative.io/api-reference/contracts/create-contract.md): Create a new contract with rates
- [Get active contract](https://docs.narrative.io/api-reference/contracts/get-active-contract.md): Return active contract with details for a company id.
- [Get active contract for company](https://docs.narrative.io/api-reference/contracts/get-active-contract-for-company.md): Return active contract with details for a company id. Company id is extracted from token.
- [Get contract](https://docs.narrative.io/api-reference/contracts/get-contract.md): Return single contract with details by id and revision.
- [Get contracts](https://docs.narrative.io/api-reference/contracts/get-contracts.md): Get contracts with details paginated.
- [Get contracts for company](https://docs.narrative.io/api-reference/contracts/get-contracts-for-company.md): Return all contract with details for a company id. Company id is extracted from token.
- [Get rates for active contract](https://docs.narrative.io/api-reference/contracts/get-rates-for-active-contract.md): Return all rates for a active contract for company_id
- [Update Contract](https://docs.narrative.io/api-reference/contracts/update-contract.md): Update active contract for a company
- [Add a collaborator to a data plane](https://docs.narrative.io/api-reference/data-planes/add-a-collaborator-to-a-data-plane.md): Grants the specified company access to the given data plane.
- [Archive a data plane](https://docs.narrative.io/api-reference/data-planes/archive-a-data-plane.md): Archive the specified data plane owned by the authenticated company.
- [Clear the default compute pool for a data plane](https://docs.narrative.io/api-reference/data-planes/clear-the-default-compute-pool-for-a-data-plane.md): Removes the default compute pool setting from this data plane.
- [Create a data plane](https://docs.narrative.io/api-reference/data-planes/create-a-data-plane.md): Create a new data plane owned by the authenticated company.
- [Data plane heartbeat](https://docs.narrative.io/api-reference/data-planes/data-plane-heartbeat.md): Send a heartbeat to update the last active timestamp of the data plane.
- [Get a data plane by ID](https://docs.narrative.io/api-reference/data-planes/get-a-data-plane-by-id.md): Retrieve a specific data plane owned or shared with the authenticated company.
- [List data planes](https://docs.narrative.io/api-reference/data-planes/list-data-planes.md): Retrieve all data planes accessible to the authenticated company.
- [Remove a collaborator from a data plane](https://docs.narrative.io/api-reference/data-planes/remove-a-collaborator-from-a-data-plane.md): Revokes the specified company's access to the given data plane.
- [Set the default compute pool for a data plane](https://docs.narrative.io/api-reference/data-planes/set-the-default-compute-pool-for-a-data-plane.md): Sets the specified compute pool as the default for this data plane. The compute pool must exist, be active, belong to the same company, and be associated with this data plane.
- [Trigger a health check](https://docs.narrative.io/api-reference/data-planes/trigger-a-health-check.md): Enqueue a health check job for the specified data plane. Optionally target a specific compute pool. Returns the created job.
- [Create a data-shop.](https://docs.narrative.io/api-reference/data-shops/create-a-data-shop.md): Create a new data-shop.
- [Fetch many data-shops](https://docs.narrative.io/api-reference/data-shops/fetch-many-data-shops.md): Fetch many data-shops, given their `ids`.
- [Get a data-shop by its host name.](https://docs.narrative.io/api-reference/data-shops/get-a-data-shop-by-its-host-name.md): Gets the data-shop given its host name.
- [Get a data-shop by its id.](https://docs.narrative.io/api-reference/data-shops/get-a-data-shop-by-its-id.md): Gets the data-shop given its uuid.
- [Get all data-shops for a company.](https://docs.narrative.io/api-reference/data-shops/get-all-data-shops-for-a-company.md): Gets all data-shops belonging to a company or empty if non exist.
- [Update a data-shop.](https://docs.narrative.io/api-reference/data-shops/update-a-data-shop.md): Update a new data-shop.
- [Create a data-stream.](https://docs.narrative.io/api-reference/data-streams/create-a-data-stream.md): Create a new data-stream.
- [Fetch many data-streams](https://docs.narrative.io/api-reference/data-streams/fetch-many-data-streams.md): Fetch many data-streams, given their `ids`.
- [Find data-streams available on the data-streams-market.](https://docs.narrative.io/api-reference/data-streams/find-data-streams-available-on-the-data-streams-market.md): Gets all data-streams available on the data-streams-market matching the given search expression.
- [Find data-streams for the given company and a sales-channel and the given search expression.](https://docs.narrative.io/api-reference/data-streams/find-data-streams-for-the-given-company-and-a-sales-channel-and-the-given-search-expression.md): Gets all data-streams belonging to a company, filtered for the sales-channel and the given search expression.
- [Find data-streams for the given company and its data-shop hostname and the given search expression.](https://docs.narrative.io/api-reference/data-streams/find-data-streams-for-the-given-company-and-its-data-shop-hostname-and-the-given-search-expression.md): Gets all data-streams belonging to a company, filtered for the hostname and the given search expression.
- [Get a data-stream by its id.](https://docs.narrative.io/api-reference/data-streams/get-a-data-stream-by-its-id.md): Gets the data-stream given its uuid.
- [Get all data-streams for a company.](https://docs.narrative.io/api-reference/data-streams/get-all-data-streams-for-a-company.md): Gets all data-streams belonging to a company or empty if non exist.
- [Get all data-streams for a company given a sales channel](https://docs.narrative.io/api-reference/data-streams/get-all-data-streams-for-a-company-given-a-sales-channel.md): Gets all data-streams belonging to a company, given a sales channel.
- [Get all data-streams for a company given a search expression.](https://docs.narrative.io/api-reference/data-streams/get-all-data-streams-for-a-company-given-a-search-expression.md): Gets all data-streams belonging to a company and the given search expression.
- [Get all data-streams for the given company and its data-shop hostname.](https://docs.narrative.io/api-reference/data-streams/get-all-data-streams-for-the-given-company-and-its-data-shop-hostname.md): Gets all data-streams belonging to a company, filtered for the hostname.
- [Get schema](https://docs.narrative.io/api-reference/data-streams/get-schema.md): Retrieve schema for deliveries from this data stream.
- [Gets the data-stream for a given company and slug.](https://docs.narrative.io/api-reference/data-streams/gets-the-data-stream-for-a-given-company-and-slug.md): Gets the data-stream for a given company and slug
- [Update a data-stream.](https://docs.narrative.io/api-reference/data-streams/update-a-data-stream.md): Update a new data-stream.
- [Preview snapshot expirations](https://docs.narrative.io/api-reference/dataset-configuration/preview-snapshot-expirations.md): Preview snapshot expirations given a retention policy.
- [Upsert retention policies for a dataset](https://docs.narrative.io/api-reference/dataset-configuration/upsert-retention-policies-for-a-dataset.md): Accepts either a legacy payload (snapshot-only) or the unified v1 policy object. The response is always returned in the unified v1 shape with a `compat.mode` indicating whether the server interpreted the request as legacy or v1. **Row TTL clock default:** If `row_ttl.enabled=true` and `row_ttl.clock…
- [Files added](https://docs.narrative.io/api-reference/dataset-files/files-added.md): Lists files added by a snapshot
- [Find files](https://docs.narrative.io/api-reference/dataset-files/find-files.md): Lists snapshots and associated files
- [Find snapshots](https://docs.narrative.io/api-reference/dataset-files/find-snapshots.md): Lists snapshots and associated files
- [Issue file download url](https://docs.narrative.io/api-reference/dataset-files/issue-file-download-url.md): Retrieve the download URL for a file
- [Suggest mappings](https://docs.narrative.io/api-reference/dataset-mappings/suggest-mappings.md): Schedule the execution of a mappings suggestion job for a given dataset, using the Rosetta Stone API (Snowflake data plane only).
- [Archive the materialized view refresh configuration](https://docs.narrative.io/api-reference/dataset-refresh/archive-the-materialized-view-refresh-configuration.md)
- [Create a refresh schedule for an existing materialized view](https://docs.narrative.io/api-reference/dataset-refresh/create-a-refresh-schedule-for-an-existing-materialized-view.md): Creates new request for request derivation
- [Run a materialized view refresh now](https://docs.narrative.io/api-reference/dataset-refresh/run-a-materialized-view-refresh-now.md)
- [Update the materialized view refresh configuration](https://docs.narrative.io/api-reference/dataset-refresh/update-the-materialized-view-refresh-configuration.md): Creates new request for request derivation
- [Delete a sample](https://docs.narrative.io/api-reference/dataset-samples/delete-a-sample.md): Deletes a sample of rows from a dataset.
- [Request Dataset Sample](https://docs.narrative.io/api-reference/dataset-samples/request-dataset-sample.md): Request a dataset sample job with pre-compiled SQL (for non-Narrative Data Planes only)
- [Sample a dataset](https://docs.narrative.io/api-reference/dataset-samples/sample-a-dataset.md): Get a sample of rows from a dataset as JSON.
- [Sample a dataset (Admin)](https://docs.narrative.io/api-reference/dataset-samples/sample-a-dataset-admin.md): Get a sample of rows from a dataset as JSON.
- [Sampled Mappings](https://docs.narrative.io/api-reference/dataset-samples/sampled-mappings.md): Returns sampled dataset after attribute mapping for a given `mapping_id`
- [Disable Statistics Configuration](https://docs.narrative.io/api-reference/dataset-statistics/disable-statistics-configuration.md): Disable the statistics configuration. Statistics will no longer be computed.
- [Get Statistics Configuration](https://docs.narrative.io/api-reference/dataset-statistics/get-statistics-configuration.md): Retrieve the current statistics configuration for a dataset.
- [Put Statistics Configuration](https://docs.narrative.io/api-reference/dataset-statistics/put-statistics-configuration.md): Create or update the statistics configuration for a dataset. Replaces any existing configuration.
- [Activate a dataset](https://docs.narrative.io/api-reference/datasets/activate-a-dataset.md): Activates a dataset.
- [Activate a dataset](https://docs.narrative.io/api-reference/datasets/activate-a-dataset-1.md): Activates a dataset.
- [Create a dataset](https://docs.narrative.io/api-reference/datasets/create-a-dataset.md): Create or register a new dataset.
- [Create or Update detailed statistics](https://docs.narrative.io/api-reference/datasets/create-or-update-detailed-statistics.md): Create or Update detailed statistics. Detailed statistics are collected for datasets belonging to the Narrative Data Plane, but uploading these stats is necessary for non-Narrative data planes, since Narrative does not have access to the data to compute these statistics.
- [Delete a dataset](https://docs.narrative.io/api-reference/datasets/delete-a-dataset.md): Permanently removes a dataset from the platform.
- [Derive the configuration](https://docs.narrative.io/api-reference/datasets/derive-the-configuration.md): Creates new request for request derivation
- [Disable configuration](https://docs.narrative.io/api-reference/datasets/disable-configuration.md): Disable configuration, metrics won't be calculated
- [Enable configuration](https://docs.narrative.io/api-reference/datasets/enable-configuration.md): Enable configuration if it exists
- [Get a dataset](https://docs.narrative.io/api-reference/datasets/get-a-dataset.md)
- [Get admin info for a dataset](https://docs.narrative.io/api-reference/datasets/get-admin-info-for-a-dataset.md): Get a dataset including information about the backing [Iceberg table](http://iceberg.apache.org/).
- [Get dataset statistics](https://docs.narrative.io/api-reference/datasets/get-dataset-statistics.md): Return summary statistics for all ingestion snapshots for a given dataset. For datasets with "incremental" updates, each snapshot defines a new incremental upload of data. For datasets with "overwrite" updates, each snapshot overwrites the previous data. `all_records` query parameter is here because…
- [Get datasets](https://docs.narrative.io/api-reference/datasets/get-datasets.md): Return all datasets belonging to the authenticated company.
- [Get detailed statistics](https://docs.narrative.io/api-reference/datasets/get-detailed-statistics.md): Get statistics for each column.
- [Get Metrics Configuration](https://docs.narrative.io/api-reference/datasets/get-metrics-configuration.md): Put new version of configuration.
- [Ingest a file](https://docs.narrative.io/api-reference/datasets/ingest-a-file.md): After uploading a file to Narrative via the `upload` API, you can then have the file can then be ingested into a dataset.
- [Metrics](https://docs.narrative.io/api-reference/datasets/metrics.md): Lists metrics for a dataset
- [Metrics](https://docs.narrative.io/api-reference/datasets/metrics-1.md): Metrics for a snapshot
- [Put Metrics Configuration](https://docs.narrative.io/api-reference/datasets/put-metrics-configuration.md): Put new version of configuration.
- [Submit recalculation](https://docs.narrative.io/api-reference/datasets/submit-recalculation.md): Run recalculation for the dataset.
- [Truncate a dataset](https://docs.narrative.io/api-reference/datasets/truncate-a-dataset.md): Truncates a dataset.
- [Update a dataset](https://docs.narrative.io/api-reference/datasets/update-a-dataset.md): Update existing dataset.
- [Update a dataset](https://docs.narrative.io/api-reference/datasets/update-a-dataset-1.md): Update a pending or active dataset.
- [Update a dataset's partition spec](https://docs.narrative.io/api-reference/datasets/update-a-datasets-partition-spec.md): Update the partition specification of the [Iceberg table](http://iceberg.apache.org/) backing the dataset.
- [Creates a destination](https://docs.narrative.io/api-reference/destinations/creates-a-destination.md)
- [Get a destination by id](https://docs.narrative.io/api-reference/destinations/get-a-destination-by-id.md)
- [Removes the destination from a subscription](https://docs.narrative.io/api-reference/destinations/removes-the-destination-from-a-subscription.md)
- [Search destinations for a profile](https://docs.narrative.io/api-reference/destinations/search-destinations-for-a-profile.md)
- [Search destinations for a subscription](https://docs.narrative.io/api-reference/destinations/search-destinations-for-a-subscription.md)
- [Updates the values of the quick settings](https://docs.narrative.io/api-reference/destinations/updates-the-values-of-the-quick-settings.md)
- [Archive a connection](https://docs.narrative.io/api-reference/encryption-materials/archive-a-connection.md)
- [Create an encryption material](https://docs.narrative.io/api-reference/encryption-materials/create-an-encryption-material.md): Create an encryption material
- [List encryption materials](https://docs.narrative.io/api-reference/encryption-materials/list-encryption-materials.md): List encryption materials
- [Create an installation](https://docs.narrative.io/api-reference/installations/create-an-installation.md): Creates a new installation for an app.
- [Delete an installation](https://docs.narrative.io/api-reference/installations/delete-an-installation.md): Deletes an installation by its ID.
- [Get current installation info](https://docs.narrative.io/api-reference/installations/get-current-installation-info.md): Returns information about the installation associated with the current authentication token.
- [List installations](https://docs.narrative.io/api-reference/installations/list-installations.md): Returns all installations for the authenticated company.
- [Get a job](https://docs.narrative.io/api-reference/jobs/get-a-job.md): This endpoint retrieves all details associated with a specific job ID from the jobs table.
- [Get jobs](https://docs.narrative.io/api-reference/jobs/get-jobs.md): Returns a list of jobs associated with the specified company, including job ID, job type, timestamp information, and results.
- [Accept a mapping](https://docs.narrative.io/api-reference/mappings/accept-a-mapping.md): Accept a `system` proposed mapping, i.e. move it from the `status` of `pending` to `active`.
- [Create a global mapping](https://docs.narrative.io/api-reference/mappings/create-a-global-mapping.md): Create a new global mapping.
- [Create a private mapping](https://docs.narrative.io/api-reference/mappings/create-a-private-mapping.md): Create a private mapping.
- [Create a system mapping](https://docs.narrative.io/api-reference/mappings/create-a-system-mapping.md): Create a `system` mapping.
- [Delete a mapping](https://docs.narrative.io/api-reference/mappings/delete-a-mapping.md): Mapping deletion cannot be undone.
- [Get mapping](https://docs.narrative.io/api-reference/mappings/get-mapping.md): Return a specific mapping based on its id.
- [Get mapping preview](https://docs.narrative.io/api-reference/mappings/get-mapping-preview.md): Returns sampled dataset after attribute mapping for a given `mapping_id`
- [Get mappings](https://docs.narrative.io/api-reference/mappings/get-mappings.md): Return all mappings, both private and global.
- [Get mappings for a company](https://docs.narrative.io/api-reference/mappings/get-mappings-for-a-company.md): Return all private mappings related to a specific company based on its id
- [Get system mappings](https://docs.narrative.io/api-reference/mappings/get-system-mappings.md): Return all `system` mappings.
- [Promote a mapping](https://docs.narrative.io/api-reference/mappings/promote-a-mapping.md): Promote a `private` mapping, i.e. create a new mapping taht is available globally.
- [Test Mapping](https://docs.narrative.io/api-reference/mappings/test-mapping.md): Returns sampled dataset after attribute mapping for a given mapping.
- [Update a mapping](https://docs.narrative.io/api-reference/mappings/update-a-mapping.md): Update the definition of a mapping between an attribute and a dataset.
- [Run model inference](https://docs.narrative.io/api-reference/model-inference/run-model-inference.md): Create a job to perform an LLM call. Supported on both AWS and Snowflake data planes.
- [Archive a model](https://docs.narrative.io/api-reference/models/archive-a-model.md)
- [Get a model](https://docs.narrative.io/api-reference/models/get-a-model.md): Returns a single model by its ID.
- [Get models](https://docs.narrative.io/api-reference/models/get-models.md): Returns a paginated list of models accessible to the authenticated company.
- [Update a model](https://docs.narrative.io/api-reference/models/update-a-model.md): Updates an existing model.
- [Get the result of a NQL forecast](https://docs.narrative.io/api-reference/nql/get-the-result-of-a-nql-forecast.md): This endpoint is used to poll forecast result after it's ran.
- [Run a NQL Query](https://docs.narrative.io/api-reference/nql/run-a-nql-query.md): The run endpoint in the NQL API allows users to execute their NQL queries. This endpoint processes the query and performs the specified operations within the specified data plane. Depending on the NQL provided, the run endpoint can create materialized views or generate forecasts.
- [Validate an NQL query](https://docs.narrative.io/api-reference/nql/validate-an-nql-query.md): The validate endpoint in the NQL API allows users to verify the syntax and structure of their NQL queries before executing them. This ensures that the queries are correctly formatted and will not cause errors when passing through the /run endpoint. The primary goal of using the validate endpoint is…
- [Creates a new setup intent](https://docs.narrative.io/api-reference/payment-methods/creates-a-new-setup-intent.md): # /payment-methods/credit-card/setup-intent
- [Deletes a payment method](https://docs.narrative.io/api-reference/payment-methods/deletes-a-payment-method.md): # /payment-methods/{payment_method_id}
- [Returns payment methods for company](https://docs.narrative.io/api-reference/payment-methods/returns-payment-methods-for-company.md): # /payment-methods
- [Sets a valid SetupIntent as the primary payment method](https://docs.narrative.io/api-reference/payment-methods/sets-a-valid-setupintent-as-the-primary-payment-method.md): # /payment-methods/credit-card/setup-intent/{setup_intent_id}
- [Create a permission](https://docs.narrative.io/api-reference/permissions/create-a-permission.md): Create a new permission
- [Attach permission to product](https://docs.narrative.io/api-reference/products/attach-permission-to-product.md): Attaches given permission to a given product
- [Create a product](https://docs.narrative.io/api-reference/products/create-a-product.md): Create a new product.
- [Get product](https://docs.narrative.io/api-reference/products/get-product.md): Return single product
- [Get products](https://docs.narrative.io/api-reference/products/get-products.md): Get products paginated
- [Update product](https://docs.narrative.io/api-reference/products/update-product.md): Update product by sku.
- [Archives a profile](https://docs.narrative.io/api-reference/profiles/archives-a-profile.md): Archiving prevents using the profile again in the future.
- [Creates an app profile](https://docs.narrative.io/api-reference/profiles/creates-an-app-profile.md): The profile will be assigned a unique identifier upon creation. New profiles are "disabled" and should be activated after creation.
- [Disables a profile](https://docs.narrative.io/api-reference/profiles/disables-a-profile.md): Only profiles that are enabled will be considered when delivering subscriptions.
- [Enables a profile](https://docs.narrative.io/api-reference/profiles/enables-a-profile.md): Only profiles that are enabled will be considered when delivering subscriptions.
- [Returns app profiles](https://docs.narrative.io/api-reference/profiles/returns-app-profiles.md)
- [Returns profile with {profile_id}](https://docs.narrative.io/api-reference/profiles/returns-profile-with-.md)
- [Updates an existing app profile](https://docs.narrative.io/api-reference/profiles/updates-an-existing-app-profile.md)
- [Create a query](https://docs.narrative.io/api-reference/queries/create-a-query.md): Any number of properties can be updated on the same request. If a property is not sent on the payload, the value won't be updated.
- [Deletes a query](https://docs.narrative.io/api-reference/queries/deletes-a-query.md): Deletes a query
- [Get a query by id](https://docs.narrative.io/api-reference/queries/get-a-query-by-id.md): Get a query.
- [Get accessible queries](https://docs.narrative.io/api-reference/queries/get-accessible-queries.md): Get all accessible queries.
- [Updates a query](https://docs.narrative.io/api-reference/queries/updates-a-query.md): Updates a query
- [Create bucket](https://docs.narrative.io/api-reference/resources/create-bucket.md): Create an AWS S3 bucket inside Narrative's AWS account assigned to the authenticated company.
- [Get buckets](https://docs.narrative.io/api-reference/resources/get-buckets.md): Return the AWS S3 buckets assigned to the authenticated company.
- [Update access type](https://docs.narrative.io/api-reference/resources/update-access-type.md): Update access type to the bucket. Pay attention, that bucket-owner-full-control ACL is strictly required for "bucket_policy" type of access. Also, bucket should be whitelisted for mutation. All buckets created by creation endpoint are mutable by default. Buckets created before 2023 could be immutabl…
- [Infer the dataset schema of a file passed by multipart file.](https://docs.narrative.io/api-reference/schema-inference/infer-the-dataset-schema-of-a-file-passed-by-multipart-file.md)
- [Create a private schema preset.](https://docs.narrative.io/api-reference/schema-presets/create-a-private-schema-preset.md): Create a private schema preset owned by the authenticated account. Only members of the same organization are able to see this schema preset.
- [Create a public schema preset.](https://docs.narrative.io/api-reference/schema-presets/create-a-public-schema-preset.md): Create a **public** schema preset available platform wide. This endpoint is only available to administrators.
- [Delete a schema preset by its id.](https://docs.narrative.io/api-reference/schema-presets/delete-a-schema-preset-by-its-id.md): Archive (soft delete) a specific schema preset given its id. The schema preset will not be visible from that point forward.
- [Detail information on a schema preset by its id.](https://docs.narrative.io/api-reference/schema-presets/detail-information-on-a-schema-preset-by-its-id.md): Returns detailed information on a specific schema preset given its id.
- [Returns all available schema presets.](https://docs.narrative.io/api-reference/schema-presets/returns-all-available-schema-presets.md): List the schema presets that are publicly available and the ones owned by the authenticated account.
- [Returns all publicly available schema presets.](https://docs.narrative.io/api-reference/schema-presets/returns-all-publicly-available-schema-presets.md): List the schema presets that are publicly available.
- [Activate a subscription](https://docs.narrative.io/api-reference/subscriptions/activate-a-subscription.md): Activation will result in charges to your company's payment method.
- [Cancel a subscription](https://docs.narrative.io/api-reference/subscriptions/cancel-a-subscription.md): A cancelled subscription cannot be reactivated.
- [Checkout a subscription](https://docs.narrative.io/api-reference/subscriptions/checkout-a-subscription.md): Checkout creates and activates a subscription in a single API call.
- [Create a cost forecast](https://docs.narrative.io/api-reference/subscriptions/create-a-cost-forecast.md): Create an estimate of the "cost" of servicing a set of subscription constraints.
- [Create a cost forecast for a subscription](https://docs.narrative.io/api-reference/subscriptions/create-a-cost-forecast-for-a-subscription.md): Create a cost forecast for a subscription, taking into account data already processed for the subscription.
- [Create a subscription](https://docs.narrative.io/api-reference/subscriptions/create-a-subscription.md): Subscriptions created using this endpoint are left in the `pending` state and require activation.
- [Delete a subscription](https://docs.narrative.io/api-reference/subscriptions/delete-a-subscription.md): Subscription deletion cannot be undone.
- [Get a cost forecast](https://docs.narrative.io/api-reference/subscriptions/get-a-cost-forecast.md): Get a cost forecast by id.
- [Get a delivered file](https://docs.narrative.io/api-reference/subscriptions/get-a-delivered-file.md): Retrieve a AWS S3 presigned URL to download a file delivered as part of a subscription.
- [Get a subscription](https://docs.narrative.io/api-reference/subscriptions/get-a-subscription.md): Get a subscription by id.
- [Get cost forecasts](https://docs.narrative.io/api-reference/subscriptions/get-cost-forecasts.md): Return all cost forecasts belonging to the authenticated company.
- [Get deliveries](https://docs.narrative.io/api-reference/subscriptions/get-deliveries.md): Retrieve metadata about files containing data purchased as part of the subscription.
- [Get matches](https://docs.narrative.io/api-reference/subscriptions/get-matches.md): Retrieve datasets matching a set of subscription constraints.
- [Get schema](https://docs.narrative.io/api-reference/subscriptions/get-schema.md): Retrieve schema for deliveries from this subscription.
- [Get subscription cost forecasts](https://docs.narrative.io/api-reference/subscriptions/get-subscription-cost-forecasts.md): Retrieve cost forecasts for a subscription.
- [Get subscription matches](https://docs.narrative.io/api-reference/subscriptions/get-subscription-matches.md): Retrieve datasets matching a subscription's constraints.
- [Get subscriptions](https://docs.narrative.io/api-reference/subscriptions/get-subscriptions.md): Return all subscriptions belonging to the authenticated company.
- [Update a subscription](https://docs.narrative.io/api-reference/subscriptions/update-a-subscription.md): Update a subscription
- [Upload a file](https://docs.narrative.io/api-reference/uploads/upload-a-file.md): Sending a file to Narrative is a two step process. This endpoint allows you to request an `upload_url` which can be used in a `PUT` request to upload the file.
- [Create a usage event](https://docs.narrative.io/api-reference/usage/create-a-usage-event.md): Create a usage event to charge a customer for their use of a product.
- [Archives a view](https://docs.narrative.io/api-reference/views/archives-a-view.md): Archives a view
- [Create a view](https://docs.narrative.io/api-reference/views/create-a-view.md): Any number of properties can be updated on the same request. If a property is not sent on the payload, the value won't be updated.
- [Get a view by id](https://docs.narrative.io/api-reference/views/get-a-view-by-id.md): Get a view.
- [Get accessible views](https://docs.narrative.io/api-reference/views/get-accessible-views.md): Get all accessible views.
- [Updates a view](https://docs.narrative.io/api-reference/views/updates-a-view.md): Updates a view
- [Archive a webhook subscription](https://docs.narrative.io/api-reference/webhooks/archive-a-webhook-subscription.md): Archive the specified webhook subscription.
- [Create a webhook subscription](https://docs.narrative.io/api-reference/webhooks/create-a-webhook-subscription.md): Create a new webhook subscription for the authenticated company.
- [Get a webhook subscription by ID](https://docs.narrative.io/api-reference/webhooks/get-a-webhook-subscription-by-id.md): Retrieve a specific webhook subscription.
- [List webhook subscriptions](https://docs.narrative.io/api-reference/webhooks/list-webhook-subscriptions.md): Get all webhook subscriptions for the authenticated company.
- [Get a current user](https://docs.narrative.io/api-reference/whoami/get-a-current-user.md)
- [Archive a workflow](https://docs.narrative.io/api-reference/workflows/archive-a-workflow.md): Archive a workflow. This terminates any active schedule and running execution, then marks the workflow as archived in the database.
- [Cancel a specific workflow run](https://docs.narrative.io/api-reference/workflows/cancel-a-specific-workflow-run.md): Request cancellation of a specific workflow execution identified by its run ID. This is the recommended method for cancelling workflow executions, as it guarantees that only the intended execution is cancelled. Unlike cancelling by workflow ID alone, this avoids a race condition where:   1. A reques…
- [Cancel a workflow execution](https://docs.narrative.io/api-reference/workflows/cancel-a-workflow-execution.md): Request cancellation of the currently running execution of a workflow.
- [Create a workflow](https://docs.narrative.io/api-reference/workflows/create-a-workflow.md): Create a new workflow from a YAML specification. The specification is parsed and validated before the workflow is persisted.
- [Get a workflow](https://docs.narrative.io/api-reference/workflows/get-a-workflow.md): Retrieve a workflow by its ID. Only workflows owned by the authenticated company are accessible.
- [List workflow runs](https://docs.narrative.io/api-reference/workflows/list-workflow-runs.md): List execution runs for a workflow. Returns a paginated list of runs with their status, start time, and close time.
- [List workflows](https://docs.narrative.io/api-reference/workflows/list-workflows.md): List all active workflows for the authenticated company.
- [Remove a workflow schedule](https://docs.narrative.io/api-reference/workflows/remove-a-workflow-schedule.md): Delete the schedule for a workflow. This stops future scheduled executions from being created but does not cancel any currently running workflow execution.
- [Schedule a workflow](https://docs.narrative.io/api-reference/workflows/schedule-a-workflow.md): Create a schedule for a workflow based on the cron expression defined in its specification. The workflow specification must contain a `schedule` section.
- [Trigger a workflow](https://docs.narrative.io/api-reference/workflows/trigger-a-workflow.md): Trigger an immediate execution of a workflow. Returns the run ID of the new execution.
- [App Invites](https://docs.narrative.io/concepts/apps/app-invites.md): How invite links enable third parties to connect accounts without Narrative authentication
- [Data Flow](https://docs.narrative.io/concepts/architecture/data-flow.md): How data moves through the Narrative platform during queries and collaboration
- [Query Processing](https://docs.narrative.io/concepts/architecture/query-processing.md): How NQL queries are compiled, dispatched, and executed across the platform
- [Sample Data](https://docs.narrative.io/concepts/architecture/sample-data.md): Understand how data samples cross from data planes to the control plane, and the governance implications
- [Security Model](https://docs.narrative.io/concepts/architecture/security-model.md): Understand how Narrative protects your data through architecture, access controls, and operational practices
- [CCPA](https://docs.narrative.io/concepts/compliance/ccpa.md): Understanding the California Consumer Privacy Act and California Privacy Rights Act
- [GDPR](https://docs.narrative.io/concepts/compliance/gdpr.md): Understanding the General Data Protection Regulation and its requirements for personal data processing
- [Sub-processors](https://docs.narrative.io/concepts/compliance/sub-processors.md): Third-party service providers that process data on behalf of Narrative
- [Audience Studio](https://docs.narrative.io/concepts/data-activation/audience-studio.md): Build, filter, and deliver audiences to advertising platforms using a guided builder
- [Data Activation](https://docs.narrative.io/concepts/data-activation/overview.md): Deliver audience data from Narrative to advertising and marketing platforms
- [Data Collaboration Platforms](https://docs.narrative.io/concepts/data-collaboration-platforms.md): How the convergence of big data infrastructure, specialized talent, and data scarcity led to a new category of software for acquiring and sharing data
- [IP Addresses](https://docs.narrative.io/concepts/data-formats/ip-addresses.md): Understanding IP address formats, types, and their role in data collaboration
- [Location Data](https://docs.narrative.io/concepts/data-formats/location-data.md): Understanding location polygons, geospatial formats, and how to work with geographic data
- [Unix Time](https://docs.narrative.io/concepts/data-formats/unix-time.md): Understanding Unix timestamps and how Narrative uses them for data collaboration
- [Addressability Expansion](https://docs.narrative.io/concepts/identifiers/addressability.md): Improving media activation reach by appending additional identifiers to existing identity graph records
- [Data Onboarding](https://docs.narrative.io/concepts/identifiers/data-onboarding.md): Translating offline customer data for digital activation
- [Graph Enrichment](https://docs.narrative.io/concepts/identifiers/graph-enrichment.md): Strengthening identity graph structure with third-party linkage data for improved person-level and household-level resolution
- [Graph Studio](https://docs.narrative.io/concepts/identifiers/graph-studio.md): Build identity graphs from your first-party and third-party data using a guided, visual builder
- [ID Mapping](https://docs.narrative.io/concepts/identifiers/id-mapping.md): Connecting identifiers across devices, channels, and platforms
- [Identifier Types](https://docs.narrative.io/concepts/identifiers/id-types.md): Understanding the categories of identifiers used in data collaboration
- [Identity Graphs](https://docs.narrative.io/concepts/identifiers/identity-graph.md): How connected components and graph structure unify identifiers into person-level and household-level profiles
- [Mobile Advertising IDs](https://docs.narrative.io/concepts/identifiers/mobile-ad-ids.md): Understanding IDFA, GAID, and how mobile device identifiers work
- [Identifiers in Data Collaboration](https://docs.narrative.io/concepts/identifiers/overview.md): Understanding how identifiers enable privacy-preserving data matching across organizations
- [UID2 (Unified ID 2.0)](https://docs.narrative.io/concepts/identifiers/uid2.md): A privacy-preserving identifier for cross-platform data collaboration
- [Concepts](https://docs.narrative.io/concepts/index.md): Understand how Narrative I/O works—the architecture, primitives, and design decisions behind the platform
- [Data Privacy in Model Inference](https://docs.narrative.io/concepts/model-inference/data-privacy.md): How Model Inference keeps your data secure within your infrastructure
- [Model Inference](https://docs.narrative.io/concepts/model-inference/overview.md): Run AI-powered operations within your data plane using hosted LLMs
- [Structured Output](https://docs.narrative.io/concepts/model-inference/structured-output.md): How JSON Schema ensures predictable, typed responses from Model Inference
- [Chunking](https://docs.narrative.io/concepts/nql/chunking.md): How NQL splits large queries into time-based segments for stability and cost efficiency
- [NQL Design Philosophy](https://docs.narrative.io/concepts/nql/design-philosophy.md): Why Narrative created a purpose-built query language for data collaboration
- [Incremental View Maintenance](https://docs.narrative.io/concepts/nql/incremental-view-maintenance.md): How NQL optimizes materialized view refreshes by updating only changed data
- [Understanding JOIN Performance](https://docs.narrative.io/concepts/nql/join-performance.md): How query planners optimize JOIN operations and why certain patterns cause problems
- [Materialized Views](https://docs.narrative.io/concepts/nql/materialized-views.md): How materialized views work in NQL and when to use them
- [Query Templates](https://docs.narrative.io/concepts/nql/query-templates.md): Reusable query patterns with configurable placeholders
- [NQL vs SQL](https://docs.narrative.io/concepts/nql/sql-comparison.md): Understanding how NQL extends and differs from standard SQL
- [Type System](https://docs.narrative.io/concepts/nql/type-system.md): How NQL handles types across different database engines
- [Access Rules](https://docs.narrative.io/concepts/primitives/access-rules.md): Control who can access your data, what they can query, and what it costs
- [Compute Pools](https://docs.narrative.io/concepts/primitives/compute-pools.md): Understand how compute pools control resource allocation for query execution within a data plane
- [Control Plane](https://docs.narrative.io/concepts/primitives/control-plane.md): Understand how Narrative orchestrates data collaboration across data planes
- [Data Planes](https://docs.narrative.io/concepts/primitives/data-planes.md): Understand where your data lives and is processed in the Narrative platform
- [Dataset Retention Policies](https://docs.narrative.io/concepts/primitives/dataset-retention-policies.md): Understand how retention policies manage your data lifecycle and automatic cleanup
- [Dataset Statistics](https://docs.narrative.io/concepts/primitives/dataset-statistics.md): Understand how column-level metrics describe your data and power platform features
- [Datasets](https://docs.narrative.io/concepts/primitives/datasets.md): Understand how datasets store, organize, and protect your data in Narrative
- [Execution Context](https://docs.narrative.io/concepts/primitives/execution-context.md): Understand how data plane, compute pool, database, and schema combine to determine where and how platform operations run
- [Confidence Scoring](https://docs.narrative.io/concepts/rosetta-stone/confidence-scoring.md): How AI evaluates mapping quality and generates confidence scores
- [How Rosetta Stone Works](https://docs.narrative.io/concepts/rosetta-stone/how-it-works.md): The mechanics of attributes, mappings, and automatic schema normalization
- [The Normalization Model](https://docs.narrative.io/concepts/rosetta-stone/normalization-model.md): How Rosetta Stone structures attributes, types, and validations
- [Rosetta Stone Overview](https://docs.narrative.io/concepts/rosetta-stone/overview.md): How Narrative enables data collaboration across organizations with different schemas
- [API Key Permissions](https://docs.narrative.io/concepts/security/api-key-permissions.md): Understand how scoped permissions control what API keys can do and protect your resources
- [Data Pseudonymization](https://docs.narrative.io/concepts/security/data-pseudonymization.md): How Narrative uses hashed identifiers to enable privacy-preserving data collaboration
- [Hashing](https://docs.narrative.io/concepts/security/hashing.md): Understanding cryptographic hash functions and their role in data protection
- [Narrative ID](https://docs.narrative.io/concepts/security/narrative-id.md): Per-partner pseudonymous identifiers for privacy-safe data collaboration
- [Personally Identifiable Information (PII)](https://docs.narrative.io/concepts/security/pii.md): Understanding PII, regulatory definitions, and how to handle it in data collaboration
- [Single Sign-On (SSO)](https://docs.narrative.io/concepts/security/sso.md): Understand how SSO works with Narrative I/O and why it matters for enterprise security
- [Webhooks](https://docs.narrative.io/concepts/webhooks/overview.md): How webhooks deliver push-based notifications for job state changes
- [Workflow Orchestration](https://docs.narrative.io/concepts/workflows/workflow-orchestration.md): How workflows automate multi-step data pipelines and relate to the jobs system
- [Cookbooks](https://docs.narrative.io/cookbooks/index.md): Complete, working examples for real-world use cases
- [Data Enrichment with AI_COMPLETE](https://docs.narrative.io/cookbooks/nql/ai-enrichment.md): Enrich records with AI-generated attributes using in-query LLM inference
- [Common Query Patterns](https://docs.narrative.io/cookbooks/nql/common-queries.md): Copy-paste NQL patterns for everyday data tasks
- [Complex Join Patterns](https://docs.narrative.io/cookbooks/nql/complex-joins.md): Advanced join recipes for multi-dataset scenarios
- [Geospatial POI Joins](https://docs.narrative.io/cookbooks/nql/geospatial-poi-joins.md): Join datasets on point of interest geometries using ST_Intersects
- [Performance Patterns](https://docs.narrative.io/cookbooks/nql/performance-patterns.md): Optimization recipes for faster, more efficient NQL queries
- [Batch Processing with Model Inference](https://docs.narrative.io/cookbooks/sdk/batch-inference-patterns.md): Process large volumes of data efficiently using inference
- [Automating Data Enrichment with Model Inference](https://docs.narrative.io/cookbooks/sdk/model-inference-automation.md): Build a pipeline that enriches dataset records using AI inference
- [Automating Data Workflows](https://docs.narrative.io/cookbooks/sdk/typescript-automation.md): Build an automated data pipeline using the TypeScript SDK
- [Auto-generating Dataset Descriptions](https://docs.narrative.io/cookbooks/use-cases/ai-dataset-descriptions.md): Use Model Inference to automatically generate human-readable dataset descriptions
- [Demographic Enrichment](https://docs.narrative.io/cookbooks/use-cases/demographic-enrichment.md): Enrich customer lists with age and gender data using identity matching and automated refresh
- [Evaluating Identity Data Providers](https://docs.narrative.io/cookbooks/use-cases/identity-provider-evaluation.md): A structured framework for choosing between graph enrichment and addressability expansion providers and measuring their incremental value
- [IP Address to MAID Enrichment](https://docs.narrative.io/cookbooks/use-cases/maid-enrichment.md): Resolve IP addresses to mobile advertising IDs using Rosetta Stone for cross-device targeting and mobile campaign activation
- [Converting Natural Language to CRON](https://docs.narrative.io/cookbooks/use-cases/natural-language-to-cron.md): Use Model Inference to translate human-readable schedules into CRON expressions
- [Retail Competitive Intelligence](https://docs.narrative.io/cookbooks/use-cases/retail-collaboration.md): Build audience segments from competitor store visitors using location data, frequency analysis, and purchase history enrichment
- [Create an Account](https://docs.narrative.io/getting-started/create-account.md): Sign up for Narrative I/O and set up your workspace
- [Evaluate Your Mappings](https://docs.narrative.io/getting-started/evaluate-mappings.md): Use AI to assess and improve your schema mappings
- [Write Your First Query](https://docs.narrative.io/getting-started/first-nql-query.md): Create a filtered dataset using Query Builder in Data Studio
- [Normalize with Rosetta Stone](https://docs.narrative.io/getting-started/normalize-data.md): Map your data to a standard schema for seamless collaboration
- [Upload Your Data](https://docs.narrative.io/getting-started/upload-data.md): Add your first dataset to Narrative I/O
- [Structuring Audiences for Activation](https://docs.narrative.io/guides/activation/audience-strategies.md): Strategies for organizing your datasets to deliver audiences to advertising platforms
- [Building an audience](https://docs.narrative.io/guides/audience-studio/building-an-audience.md): Create a targeted audience from your data and deliver it to advertising platforms using Audience Studio
- [Using Narrative ID](https://docs.narrative.io/guides/collaboration/using-narrative-id.md): Encode and translate identifiers for privacy-safe data collaboration
- [Managing Data Subject Requests](https://docs.narrative.io/guides/compliance/managing-dsrs.md): Submit and process opt-out and deletion requests to comply with GDPR, CCPA, and other privacy regulations
- [Ad Account Access Issues](https://docs.narrative.io/guides/connectors/meta/ad-account-access.md): Resolve issues where you can see an ad account but cannot select it when creating a Meta Connector profile
- [Migrate to Compute Pools](https://docs.narrative.io/guides/data-planes/migrate-to-compute-pools.md): Map your Snowflake virtual warehouses to Narrative Compute Pools to use multiple warehouses for different job types
- [Install the Snowflake Native App](https://docs.narrative.io/guides/data-planes/snowflake-native-app-installation.md): Set up a customer-hosted data plane in your Snowflake environment
- [Building an identity graph](https://docs.narrative.io/guides/graph-studio/building-an-identity-graph.md): Create an identity graph from your first-party data using Graph Studio
- [Guides](https://docs.narrative.io/guides/index.md): Step-by-step instructions for common tasks in Narrative I/O
- [Hashing PII for Upload](https://docs.narrative.io/guides/ingestion/hashing-pii.md): Prepare email addresses and phone numbers for upload by hashing them with MD5, SHA-1, and SHA-256
- [Creating Materialized Views](https://docs.narrative.io/guides/nql/creating-materialized-views.md): Pre-compute and cache query results for improved performance
- [Filtering and Transforming Data](https://docs.narrative.io/guides/nql/filtering-transforming.md): Select columns, filter rows, and transform data with NQL
- [Incremental Upserts with MERGE ON](https://docs.narrative.io/guides/nql/incremental-upserts.md): Update existing records and insert new ones during materialized view refreshes
- [Joining Datasets](https://docs.narrative.io/guides/nql/joining-datasets.md): Combine data from multiple datasets using JOINs
- [Query Optimization](https://docs.narrative.io/guides/nql/query-optimization.md): Write faster, more efficient NQL queries
- [Avoid OR in JOIN Clauses](https://docs.narrative.io/guides/nql/query-optimization/avoid-or-in-join.md): Restructure OR conditions into single-key joins for dramatically better query performance
- [NQL Troubleshooting](https://docs.narrative.io/guides/nql/troubleshooting.md): Diagnose and resolve common NQL query errors
- [Cross-Data Plane Query Errors](https://docs.narrative.io/guides/nql/troubleshooting/cross-data-plane-queries.md): Resolve errors when queries reference data across multiple data planes
- [Unsupported Type Errors](https://docs.narrative.io/guides/nql/troubleshooting/unsupported-type-error.md): Resolve errors when NQL queries use unsupported data types or operations
- [Using Query Templates](https://docs.narrative.io/guides/nql/using-query-templates.md): Create and use reusable queries with configurable placeholders
- [Configuring dataset statistics](https://docs.narrative.io/guides/platform/configuring-dataset-statistics.md): Choose which column-level metrics to compute, set refresh schedules, and add per-field overrides from the dataset details page
- [Configuring dataset retention policies](https://docs.narrative.io/guides/platform/configuring-retention-policies.md): Add, edit, and manage retention policies from the dataset details page to automate data lifecycle cleanup
- [Using the Context Selector](https://docs.narrative.io/guides/platform/using-the-context-selector.md): Choose your data plane, compute pool, database, and schema to control where queries execute and what data is visible
- [Accepting AI Mapping Suggestions](https://docs.narrative.io/guides/rosetta-stone/accepting-ai-suggestions.md): Review, accept, and reject AI-generated mapping recommendations
- [Creating Normalized Attributes](https://docs.narrative.io/guides/rosetta-stone/creating-normalized-attributes.md): Best practices for designing and proposing Rosetta Stone attributes
- [Handling Edge Cases](https://docs.narrative.io/guides/rosetta-stone/edge-cases.md): Solutions for complex mapping scenarios and unusual data patterns
- [Managing Mapping Evaluations](https://docs.narrative.io/guides/rosetta-stone/managing-evaluations.md): Run AI evaluations, filter by confidence, and understand mapping quality
- [Mapping Schemas](https://docs.narrative.io/guides/rosetta-stone/mapping-schemas.md): Create mappings between your data schema and Rosetta Stone attributes
- [Validating Mappings](https://docs.narrative.io/guides/rosetta-stone/validating-mappings.md): Test and verify your schema mappings before production use
- [SDK Authentication](https://docs.narrative.io/guides/sdk/authentication.md): Configure API key authentication for the Narrative TypeScript SDK
- [Choosing the Right Model](https://docs.narrative.io/guides/sdk/choosing-inference-models.md): Select the appropriate model based on task complexity, speed, and cost
- [Error Handling](https://docs.narrative.io/guides/sdk/error-handling.md): Handle errors gracefully when using the Narrative TypeScript SDK
- [Executing NQL Queries](https://docs.narrative.io/guides/sdk/executing-queries.md): Run, validate, and compile NQL queries using the TypeScript SDK
- [SDK Guides](https://docs.narrative.io/guides/sdk/index.md): Step-by-step instructions for common SDK tasks
- [Managing Datasets](https://docs.narrative.io/guides/sdk/managing-datasets.md): Create, read, update, and delete datasets using the TypeScript SDK
- [Running Model Inference](https://docs.narrative.io/guides/sdk/running-model-inference.md): Submit inference requests to hosted LLMs using the TypeScript SDK
- [Using Structured Output](https://docs.narrative.io/guides/sdk/structured-inference-output.md): Define JSON Schema to get predictable, typed responses from model inference
- [Tracking Job Status](https://docs.narrative.io/guides/sdk/tracking-jobs.md): Monitor asynchronous jobs and handle completion events
- [Uploading Data](https://docs.narrative.io/guides/sdk/uploading-data.md): Upload files to Narrative datasets using the TypeScript SDK
- [Secret Sharing](https://docs.narrative.io/guides/tools/secret-sharing.md): Send sensitive information through one-time-use encrypted links
- [Subscribing to Notifications](https://docs.narrative.io/guides/webhooks/subscribing-to-notifications.md): Create and manage webhook subscriptions to receive push notifications for job state changes
- [Automating Multi-Step Pipelines](https://docs.narrative.io/guides/workflows/workflow-orchestration.md): Define and run multi-step data workflows that execute automatically based on task dependencies
- [Materialized View Syntax](https://docs.narrative.io/nql/commands/create-materialized-view.md): Complete reference for CREATE MATERIALIZED VIEW statement
- [DELETE](https://docs.narrative.io/nql/commands/delete.md): Reference for the DELETE statement
- [EXPLAIN](https://docs.narrative.io/nql/commands/explain.md): Reference for the EXPLAIN statement to forecast query results
- [SQL Commands](https://docs.narrative.io/nql/commands/index.md): Reference for NQL statement types and command syntax
- [INSERT](https://docs.narrative.io/nql/commands/insert.md): Reference for the INSERT statement
- [Query Template Syntax](https://docs.narrative.io/nql/commands/query-templates.md): Complete reference for query template placeholders and structure
- [SELECT](https://docs.narrative.io/nql/commands/select.md): Reference for the SELECT statement and all its clauses
- [UPDATE](https://docs.narrative.io/nql/commands/update.md): Reference for the UPDATE statement
- [Data Types](https://docs.narrative.io/nql/data-types.md): Primitive and complex types supported in NQL
- [Aggregate Functions](https://docs.narrative.io/nql/functions/aggregate-functions.md): GROUP BY computations: COUNT, SUM, AVG, MIN, MAX, and more
- [AI & ML Functions](https://docs.narrative.io/nql/functions/ai-functions.md): LLM inference and custom model predictions: AI_COMPLETE, CALL_MODEL_FUNCTION
- [Array & Map Functions](https://docs.narrative.io/nql/functions/array-map-functions.md): Collection operations: SIZE, ELEMENT_AT, ARRAY_POSITION, FILTER, TRANSFORM, and more
- [Conditional Functions](https://docs.narrative.io/nql/functions/conditional-functions.md): Conditional logic: IF, COALESCE, NULLIF, CASE
- [Date & Time Functions](https://docs.narrative.io/nql/functions/date-time-functions.md): Temporal operations: DATE_TRUNC, DATE_ADD, FORMAT_TIMESTAMP, and more
- [Geospatial Functions](https://docs.narrative.io/nql/functions/geospatial-functions.md): Geographic calculations: ST_GeoHash, ST_Distance, and more
- [Functions](https://docs.narrative.io/nql/functions/index.md): Overview of built-in and Narrative-specific functions in NQL
- [Narrative Functions](https://docs.narrative.io/nql/functions/narrative-functions.md): Platform-specific functions: DELTA, budget functions, and more
- [Numeric Functions](https://docs.narrative.io/nql/functions/numeric-functions.md): Math operations: ROUND, ABS, CEIL, FLOOR, SQRT, and more
- [String Functions](https://docs.narrative.io/nql/functions/string-functions.md): Text manipulation functions: UPPER, LOWER, CONCAT, SUBSTRING, TRIM, and more
- [Window Functions](https://docs.narrative.io/nql/functions/window-functions.md): Ranking and analytics: ROW_NUMBER, RANK, LAG, LEAD, and more
- [Explicit Column Selection](https://docs.narrative.io/nql/general/explicit-columns.md): Why NQL requires explicit column lists instead of wildcards
- [Reserved Keywords](https://docs.narrative.io/nql/general/reserved-keywords.md): Keywords that require quoting when used as identifiers
- [NQL Syntax](https://docs.narrative.io/nql/general/syntax.md): Overview of NQL statement types and general grammar
- [NQL Reference](https://docs.narrative.io/nql/index.md): Complete reference documentation for Narrative Query Language
- [Operators](https://docs.narrative.io/nql/operators.md): Comparison, logical, arithmetic, and special operators in NQL
- [Dataset Statistics Reference](https://docs.narrative.io/reference/architecture/dataset-statistics.md): Complete reference for dataset statistics: available metrics, type compatibility, configuration schema, and validation errors
- [Missing Required Default Statistics](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/defaults-missing-enabled-stats.md): The defaults object must include enabled_stats because there is no parent scope to inherit from
- [Conflicting Distinct Count Methods](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/distinct-conflict.md): approx_count_distinct and count_distinct cannot both be enabled in the same stat set
- [Duplicate Field Names](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/duplicate-field-names.md): The same field name appears more than once in a namespace fields array
- [Duplicate Property Paths](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/duplicate-property-paths.md): The same property path appears more than once in a properties array
- [Duplicate Statistics](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/duplicate-stats.md): The same stat name appears more than once in an enabled_stats list
- [Empty Namespace Configuration](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/empty-namespace.md): A namespace must have at least one of scope or fields
- [Empty Node Configuration](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/empty-node-config.md): A nested node or property must have at least one configuration field
- [Empty Properties List](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/empty-properties.md): The properties array must not be empty — if present, it must contain at least one entry
- [Empty Scope Configuration](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/empty-scope-config.md): A scope must have at least one of enabled_stats or meaningful stat_options
- [Histogram Options Without Histogram Enabled](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/histogram-options-without-stat.md): Histogram options were provided but the histogram stat is not in the resolved stat set
- [Invalid Cron Expression](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/invalid-cron-expression.md): The cron_expression value is not a valid cron expression
- [Invalid Histogram Bin Count](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/invalid-max-bins.md): The max_bins value for histogram options is outside the allowed range [2, 100000]
- [Mixed Primitive and Non-Primitive Configuration](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/mixed-node-config.md): A node cannot mix primitive fields (enabled_stats/stat_options) with non-primitive fields (self/properties/items)
- [Conflicting Object and Array Configuration](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/properties-and-items-conflict.md): A non-primitive node cannot have both properties and items — it is either an object or an array
- [Too Many Histograms](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/too-many-histograms.md): The configuration enables histogram on more primitive leaves than the platform allows
- [Type Validation Error](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/type-validation-error.md): The statistics configuration is incompatible with the dataset schema or Rosetta Stone attribute types
- [Unsupported Statistics for Container Node](https://docs.narrative.io/reference/architecture/dataset-statistics/errors/unsupported-self-stats.md): Only null_value_count is supported for non-primitive self configs
- [Job Types](https://docs.narrative.io/reference/architecture/job-types.md): Reference for the different types of jobs coordinated between control plane and data planes
- [Pricing](https://docs.narrative.io/reference/billing/pricing.md): Service fees, pricing models, and usage calculation for Narrative
- [Amazon S3 Connector](https://docs.narrative.io/reference/connectors/amazon-s3.md): Deliver data files to your Amazon S3 bucket
- [Google DV360 Connector](https://docs.narrative.io/reference/connectors/google-dv360.md): Deliver audience data to Google Display & Video 360
- [Connectors](https://docs.narrative.io/reference/connectors/index.md): Reference documentation for Narrative connectors and destination platforms
- [Magnite Connector](https://docs.narrative.io/reference/connectors/magnite.md): Deliver audience segments to Magnite SSP
- [Meta Custom Audiences Connector](https://docs.narrative.io/reference/connectors/meta.md): Deliver custom audiences to Facebook and Instagram advertising
- [Meta Conversions API Connector](https://docs.narrative.io/reference/connectors/meta-conversions-api.md): Send conversion events to Meta for ad attribution and campaign optimization
- [Pinterest Connector](https://docs.narrative.io/reference/connectors/pinterest.md): Deliver custom audiences to Pinterest for ad targeting
- [PubMatic Connector](https://docs.narrative.io/reference/connectors/pubmatic.md): Deliver audience segments to PubMatic for programmatic advertising
- [The Trade Desk Connector](https://docs.narrative.io/reference/connectors/the-trade-desk.md): Deliver audience data to The Trade Desk for programmatic advertising
- [TikTok Connector](https://docs.narrative.io/reference/connectors/tiktok.md): Deliver custom audiences to TikTok Ads Manager
- [Yahoo DSP Connector](https://docs.narrative.io/reference/connectors/yahoo-dsp.md): Deliver audience data to Yahoo DSP for programmatic advertising
- [Access Rule, Table, or View Already Exists](https://docs.narrative.io/reference/errors/access-rule-name-conflict.md): Resolve HTTP 409 naming conflicts when creating access rules, datasets, or views
- [Dataset Schema Incompatible with Connector](https://docs.narrative.io/reference/errors/dataset-schema-connector-incompatible.md): Resolve HTTP 400 schema validation failures when connecting datasets to connectors
- [Error Reference](https://docs.narrative.io/reference/errors/index.md): Common API error responses and how to resolve them
- [Glossary](https://docs.narrative.io/reference/glossary.md): Definitions for terms and concepts used throughout Narrative I/O
- [Reference](https://docs.narrative.io/reference/index.md): Complete reference documentation for NQL syntax, UI components, and terminology
- [Data Collection Endpoint](https://docs.narrative.io/reference/integrations/data-collection-endpoint.md): Reference for the HTTPS-based data collection endpoint used to ingest identifiers and custom data into Narrative
- [Snowflake Native App](https://docs.narrative.io/reference/integrations/snowflake-native-app.md): Reference documentation for the Snowflake Native App data plane operator
- [JSON Schema Reference](https://docs.narrative.io/reference/model-inference/json-schema-reference.md): Supported JSON Schema features for Model Inference structured output
- [Supported Models](https://docs.narrative.io/reference/model-inference/supported-models.md): Available models for Model Inference and their specifications
- [Attribute Types](https://docs.narrative.io/reference/rosetta-stone/attribute-types.md): Complete reference for Rosetta Stone attribute type definitions
- [Attributes Interface](https://docs.narrative.io/reference/rosetta-stone/attributes-ui.md): Reference for the Rosetta Stone Attributes listing and Create Attribute pages
- [Normalized Datasets Interface](https://docs.narrative.io/reference/rosetta-stone/normalized-datasets-ui.md): Reference for the Normalized Datasets listing and detail pages
- [Transformation Functions](https://docs.narrative.io/reference/rosetta-stone/transformation-functions.md): Functions available for mapping transformation expressions
- [SDKs](https://docs.narrative.io/reference/sdks/index.md): Official SDKs for programmatic access to Narrative I/O
- [API Modules](https://docs.narrative.io/reference/sdks/typescript/api-modules.md): Reference for all TypeScript SDK API modules
- [Configuration](https://docs.narrative.io/reference/sdks/typescript/configuration.md): Configuration options for the Narrative TypeScript SDK
- [TypeScript SDK](https://docs.narrative.io/reference/sdks/typescript/index.md): Reference documentation for the Narrative TypeScript SDK
- [Model Inference API](https://docs.narrative.io/reference/sdks/typescript/model-inference-api.md): Complete reference for Model Inference SDK methods and types
- [Permissions](https://docs.narrative.io/reference/security/permissions.md): Complete reference for all API key permission resources and their available access levels
- [Classifier Studio interface](https://docs.narrative.io/reference/ui/classifier-studio.md): Reference for the Classifier Studio UI for training classification models on your data
- [LLM Studio Interface](https://docs.narrative.io/reference/ui/llm-studio.md): Reference for the LLM Studio UI for training and fine-tuning AI models
- [Prompt Studio Interface](https://docs.narrative.io/reference/ui/prompt-studio.md): Reference for the Prompt Studio UI for creating fine-tuning-ready datasets
- [Webhook Event Reference](https://docs.narrative.io/reference/webhooks/event-reference.md): Complete field reference for webhook subscriptions, event payloads, and supported enum values
- [Workflow Specification Syntax](https://docs.narrative.io/reference/workflows/specification-syntax.md): Complete reference for the workflow YAML specification format and supported tasks
- [Task Reference](https://docs.narrative.io/reference/workflows/tasks.md): Complete reference for supported workflow tasks and their parameters

## OpenAPI Specs

- [openapi](https://docs-cdn.narrative.io/api-reference/main/openapi.json)