> ## 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. # Update a derivation rule > Update some fields of a derivation rule. Requires an `admin` grant on `attribute_derivations`, and only the company that owns a rule can change it. Only the fields present in the request change; a changed transformation runs the same validation as a creation. Set `fidelity_note` to `null` to clear it. A rule's source and target attributes cannot be changed — create a new rule instead. ## OpenAPI ````yaml https://docs-cdn.narrative.io/api-reference/main/openapi.json patch /derivations/{derivation_id} openapi: 3.1.1 info: contact: email: support@narrative.io name: Narrative Support url: https://www.narrative.io termsOfService: https://www.narrative.io/legal/terms-of-service x-logo: url: >- https://cdn.narrative.io/images/company-logos/prod/narrative-logo-text-white.svg backgroundColor: rgb(9, 34, 166) altText: Narrative Logo description: >- The [Narrative Data Collaboration Platform](https://app.narrative.io) API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The current version is a pre-release beta. It may result in unexpected behavior and there may be breaking changes in future releases up to the 1.0 release. title: Narrative Data Collaboration Platform API version: 2.4.x servers: - url: https://api-dev.narrative.io - url: https://api.narrative.io security: [] tags: - name: Access Rules description: >- Access rules let data providers control who can purchase their data and the terms of purchase. The `access-rules` API allows you to manage access rules for your datasets. Related guides: - [What is an access rule?](https://kb.narrative.io/access-rules) - name: Agent Conversations description: >- Build LLM-driven workflows that can call MCP tools, ask the caller for input, and return structured answers. A conversation pins a model, a system prompt, and a tool catalog. Each run sends the model a user message (or a batch of tool outputs from a previously-paused run); the model decides whether to answer directly, call a server-side tool (resolved by the platform via Model Context Protocol), or call a client-side tool (which pauses the run with `requires_action` and waits for the caller to reply). Related guides: - [Agent Conversations Reference](https://docs.narrative.io/reference/architecture/agent-conversations) - [Error catalog](https://docs.narrative.io/reference/architecture/agent-conversations/errors/conversation-not-found) - name: MCP Connections description: >- Connect external (non-Narrative) MCP servers so agent runs can call their tools with the calling user's own OAuth authorization. A connection is created interactively: `POST /mcp-connections` runs OAuth discovery and Dynamic Client Registration against the server and returns a consent URL; the user authorizes in a browser; the authorization server redirects to `GET /mcp-connections/callback`, which stores the authorization code and sends the browser on to the Narrative app; the app calls `POST /mcp-connections/complete` with the user's own bearer token, which exchanges the code and marks the connection `connected`. That last step is authenticated on purpose. The callback is public — it's a cross-site browser redirect, so no bearer reaches it — so it is not allowed to complete anything. Only the user who started the flow can turn the stored code into a token. Tokens are stored encrypted and used server-side — they are never returned by the API. Once connected, reference the connection by id from an agent run's `mcp_servers[].connection_id`. - name: App Invites description: >- App invites allow applications to create one-time, shareable links on behalf of their users. These links enable users to invite third parties who do not have a Narrative account to perform actions within the application. For example, a Narrative user can send an invite link to a third party who then completes a Pinterest OAuth flow and creates a connector profile in the inviter's account, allowing the inviter to deliver audience data to the third party's Pinterest account without the third party needing a Narrative account. This API is intended to be used by applications (via app client credentials) to create and manage invites on behalf of their users, which can then be shared with invitees. - name: Apps description: >- Apps are applications bundled with a UI that can perform various actions on behalf of a user utilizing the Narrative API. Related guides: - [Building a Narrative Native App](https://www.narrative.io/knowledge-base/how-to-guides/building-a-narrative-native-app) - name: Access Tokens description: API Access Token management - name: Attributes description: >- An attribute models a standardized data point available for sale on the Narrative marketplace. Narrative automatically turns data points from provider datasets into attributes so that buyers can purchase well-formed, standardized data from any supplier on the marketplace. - name: Auth description: >- API token is a crucial step for developers to securely authenticate requests to the Narrative API Related guides: - [How to Create an API Token](https://www.narrative.io/knowledge-base/how-to-guides/understanding-narratives-apis/create-an-api-token) - name: Authentication description: User login and registration - name: Billings description: Used by Narrative internally to bill customers - name: Companies description: A collection of employees - name: Company Marketing Information description: Useful information related to companies - name: Compute Pools description: >- Compute pools represent compute resources (e.g. Snowflake warehouses) provisioned within a data plane. Companies can manage and share compute pools, assign them to jobs, and set a default compute pool on data planes. - name: Connections description: Associations between connectors and datasets - name: Data Shops description: |- Self-hosted website to sell your data Related guides: - [Setting up your datashop](https://www.narrative.io/knowledge-base/how-to-guides/shop-builder/settting-up-your-data-shop) - name: Data Streams description: >- The `data-stream` API endpoints allows one to create and update data-streams. Additionally the endpoints allow finding data-streams using free text search. A few of the endpoints are behind authorization. Update endpoint allows a client to post an edited data-stream document as is, without having to change its shape. The API ensures that only certain fields are allowed to be modified. Attempts to modify fields not up for client modifications are ignored. Related guides: - [What is a data stream?](https://kb.narrative.io/what-is-a-data-stream) - name: Contracts description: Contracts related APIs - name: Datasets description: >- Any kind of data, in any schema, can be pushed into the Narrative Data Collaboration Platform as a dataset exactly as it is stored in your own system. The `datasets` API allows you to manage your datasets. - name: Derivations description: >- Derivation rules describe how the value of one Rosetta Stone attribute can be computed from another — for example, hashing a raw email into a SHA-256 hashed email. Each rule carries a transformation expression that reads the source attribute's value through `$source`. The `derivations` API allows you to browse the rules your company can use — the ones it owns plus the ones shared with it through collaborators. Creating and changing them requires an `admin` grant on `attribute_derivations`, and a rule can only be changed by the company that owns it. - name: Destinations description: >- Destinations associate a subscription to a profile. Optionally, ad-hoc quick settings can be configured to a destination. Those quick settings have to match the format defined on the app manifest. - name: Installations description: Installations of Applications for a profile - name: Jobs description: >- Jobs represent an operation done on a given data plane. All jobs today are tied to a query that represents a forecast or a materialized view. The jobs API provides an interface for interacting with the jobs table, which stores various operations involving reading or writing data. This API allows users to retrieve detailed information about specific jobs, including NQL forecasts and materialized views. - name: Mappings description: >- A mapping is a transformation from a dataset to an attribute. Defining a mapping between a dataset and an attribute makes the dataset eligible to participate in subscriptions where a buyer is purchasing the target attribute. - name: Model Inference description: Model Inference - name: Model Training description: >- Train machine learning models on datasets, e.g. text classifiers used to power attribute mappings. - name: Models description: >- Machine learning models for training and inference. Models can be stored in HuggingFace or Narrative repositories and have configurable collaborator permissions for training and inference access. The `models` API allows you to list, retrieve, and update models accessible to your company. - name: NQL description: >- Narrative Query Language (NQL) is a specialized, SQL-inspired language designed to query and manipulate data within the Narrative platform. While it looks and feels much like standard SQL, it offers extended functionality and syntax that let you leverage platform-specific features—such as referencing datasets by their IDs, creating materialized views, or generating forecasts—without having to manage the complexities of different query engines behind the scenes. NQL queries can ultimately compile down to multiple underlying engines (e.g., Snowflake, Spark) to execute your requests efficiently in the Narrative ecosystem. - name: Payment Methods description: Payment methods used to purchase data - name: Products description: Internal routes used to offer datastream as products - name: Profiles description: >- App profiles are associated with an installation. They represent a reference to a configuration that the app can use to save confidential information outside of Narrative's control. Profiles are currently used to configure settings for connector apps. - name: Resources description: >- Narrative gives you access to managed resources, like your own AWS S3 bucket, so that you can effortlessly buy and sell data on the platform. The `resources` API allows you to manage your resources. - name: Schema Inference description: >- The `schema-inference` API analyzes submitted files to automatically infer and return their structure as a dataset schema. - name: Schema Presets description: >- The `schema-presets` API allows you to list the available schema presets, get detailed information about a specific one and manage its life cycle. You can create a schema preset from scratch or create one based on an existing one, administrators can create platform wide available (public) schema preset. - name: Subscriptions description: >- In the Narrative Data Collaboration Platform a subscription represents a set of rules dictating the commercial terms related to the licensing of data. The `subscriptions` API allows you to set and get information about `subscription` objects owned by the authenticated account. - name: Uploads description: >- The `uploads` API allows you to send files to Narrative and use them to perform tasks like creating a list or adding data to a dataset. - name: Usage description: >- The `usage` API enables the recording of usage events associated with a product. - name: Workflows description: >- The `workflows` API allows you to create, schedule, trigger, and archive workflows. Workflows are defined using a serverlessworkflow YAML specification. paths: /derivations/{derivation_id}: patch: tags: - Derivations summary: Update a derivation rule description: >- Update some fields of a derivation rule. Requires an `admin` grant on `attribute_derivations`, and only the company that owns a rule can change it. Only the fields present in the request change; a changed transformation runs the same validation as a creation. Set `fidelity_note` to `null` to clear it. A rule's source and target attributes cannot be changed — create a new rule instead. parameters: - $ref: '#/components/parameters/DerivationId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DerivationUpdateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DerivationResponse' '400': description: >- The update is invalid — see the error message for the specific validation failure. '403': description: The caller is not an admin or does not own the rule. '404': description: No derivation rule with that id. '409': description: The new name is already taken by another of the company's rules. security: - BearerAuth: [] components: parameters: DerivationId: name: derivation_id in: path required: true description: Id of the derivation rule. schema: type: integer format: int64 minimum: 1 schemas: DerivationUpdateRequest: type: object description: >- Body of `PATCH /derivations/{id}`. Only the fields present in the request change. Setting `fidelity_note` to `null` clears it; leaving the key out keeps the current value. The source and target attributes of a rule are immutable — there is no key for them here, and one sent anyway is ignored. additionalProperties: true properties: name: $ref: '#/components/schemas/DerivationName' description: $ref: '#/components/schemas/DerivationDescription' collaborators: $ref: '#/components/schemas/DerivationCollaborators' mapping: $ref: '#/components/schemas/DerivationMapping' lossy: type: boolean imprecise: type: boolean fidelity_note: type: - string - 'null' maxLength: 2048 cost: $ref: '#/components/schemas/DerivationCost' active: type: boolean DerivationResponse: type: object required: - id - name - description - source_attribute_id - target_attribute_id - company_id - collaborators - mapping - lossy - imprecise - fidelity_note - cost - active - created_at - created_by - updated_at - updated_by - warnings properties: id: $ref: '#/components/schemas/DerivationId' name: $ref: '#/components/schemas/DerivationName' description: $ref: '#/components/schemas/DerivationDescription' source_attribute_id: type: integer format: int64 target_attribute_id: type: integer format: int64 company_id: type: integer format: int64 collaborators: $ref: '#/components/schemas/DerivationCollaborators' mapping: $ref: '#/components/schemas/DerivationMapping' lossy: type: boolean imprecise: type: boolean fidelity_note: type: - string - 'null' maxLength: 2048 description: >- Explains the `lossy` and `imprecise` flags to whoever is deciding whether to accept derived data. `null` when the rule has no note. cost: $ref: '#/components/schemas/DerivationCost' active: type: boolean created_at: type: string format: date-time created_by: type: integer format: int64 description: Id of the user who created the rule. updated_at: type: string format: date-time updated_by: type: integer format: int64 description: Id of the user who last updated the rule. warnings: type: array description: Populated on create and update responses; empty on reads. items: $ref: '#/components/schemas/DerivationWarning' DerivationName: type: string maxLength: 256 description: Name of the derivation rule, unique within the owning company. example: raw_email_to_sha256 DerivationDescription: type: string maxLength: 2048 description: >- What the rule does, for whoever is deciding whether to accept derived data. example: Hashes the raw email address with SHA-256. DerivationCollaborators: type: object description: >- Which companies, besides the one that owns the rule, may have the rule applied to their data. A rule grants a single thing, so there is one `use` dimension. Only Narrative can share a rule broadly — with `all` companies or with everyone outside an `exclusion` set. required: - use properties: use: $ref: '#/components/schemas/DerivationParticipants' example: use: type: none DerivationMapping: description: >- The transformation that produces the target attribute's value from the source attribute's value. Expressions reference the source attribute's shape through `$source` — for a rule from `raw_email` to `sha256_hashed_email`, the `value` property maps to `SHA2(NORMALIZE_EMAIL($source.value), 256)`. The shape mirrors mapping expressions, except `cached_mapping` is not allowed: a cached mapping reads values out of a stored dataset, so there would be nothing to substitute a `$source` reference into. Expressions may use the current date or time (`CURRENT_DATE`, `CURRENT_TIMESTAMP`, …): the expression runs when a query resolves the rule, so a rule like birthdate → age in years is correct as of each query that uses it. Enum constraints and validation expressions on the target attribute do not restrict the transformation, exactly as they do not restrict a dataset mapping. oneOf: - $ref: '#/components/schemas/RawObjectMapping' - $ref: '#/components/schemas/RawValueMapping' DerivationCost: type: integer minimum: 1 default: 1 description: >- Breaks ties when more than one rule reaches the same target attribute — cheapest first. Resolution over multi-step paths sums the cost of every rule on a path and prefers the cheapest total. DerivationId: type: integer format: int64 description: Unique identifier of the derivation rule. example: 42 DerivationWarning: type: object description: >- A condition worth knowing about that did not stop the rule from being written. Returned on create and update responses; list and get responses do not compute warnings. required: - type - cycle properties: type: type: string enum: - cyclic_derivation cycle: type: array description: >- The rule closes a cycle in the derivation graph. Lists the attribute ids visited in order, starting from the rule's source attribute; the closing step back to the first id is implied. Cycle detection is bounded: only cycles of up to 6 attributes are reported, and at most 10 come back. minItems: 1 items: type: integer format: int64 DerivationParticipants: description: Which companies a grant applies to. oneOf: - type: object description: No companies. properties: type: type: string enum: - none required: - type - type: object description: Every company. Reserved for rules owned by Narrative. properties: type: type: string enum: - all required: - type - type: object description: Only the listed companies. properties: type: type: string enum: - inclusion company_ids: type: array minItems: 1 items: type: integer format: int64 minimum: 1 description: Company ID required: - type - company_ids - type: object description: >- Every company except the listed ones. Reserved for rules owned by Narrative. properties: type: type: string enum: - exclusion company_ids: type: array minItems: 1 items: type: integer format: int64 minimum: 1 description: Company ID required: - type - company_ids RawObjectMapping: type: object description: >- Object mapping definition for create/update requests (without dependencies). required: - type - property_mappings properties: type: type: string description: A mapping from a dataset to an attribute with a type of `object`. enum: - object_mapping property_mappings: type: array description: >- `property_mappings` define how a value for each property of the target attribute is constructed from a row of the source dataset. A mapping must be provided for each of the target attribute's _required_ properties. items: type: object properties: expression: $ref: '#/components/schemas/MappingExpression' path: $ref: '#/components/schemas/MappingPath' RawValueMapping: type: object description: >- Value mapping definition for create/update requests (without dependencies). required: - type - expression properties: type: type: string description: >- A mapping from a dataset to an attribute with a primitive type, i.e. one of `array`, `boolean`, `double`, `long`, `string`, or `timestamptz`. enum: - value_mapping expression: $ref: '#/components/schemas/MappingExpression' MappingExpression: type: string description: >- A raw SQL expression which produces a value from the source dataset for the target primitive attribute type. E.g. for a source dataset with the following type definition: ``` { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "required": [ "lastName" ] } ``` Valid expressions include: - Lower casing the first name: ```sql lower(firstName) ``` - Constructing a "full name" from the first and last name: ```sql concat_ws(' ', coalesce(firstName, ''), lastName) ``` - Taking the first initial of the first name if is not null: ```sql case when firstName is not null and char_length(firstName) > 0 then substr(firstName, 1) else null end ``` MappingPath: type: string description: >- A string indicating which property of the target attribute the expression is producing a value for. E.g. for an attribute with the following type definition; ``` { "type": "object", "properties": { "latitude": { "type": "double" }, "longitude": { "type": "double" }, "location_accuracy": { "type": "object", "properties": { "horizontal": { "type": "double" }, "vertical": { "type": "double" } } } }, "required": [ "latitude", "longitude" ] } ``` The possible paths are: - `latitude` - `longitude` - `location_accuracy.horizontal` - `location_accuracy.vertical` securitySchemes: BearerAuth: type: http scheme: bearer ````