> ## 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. # Create an app invite > Creates a new app invite for a company. Requires an app client credentials token. The invite is created in `pending` status and includes a generated invite code. ## OpenAPI ````yaml https://docs-cdn.narrative.io/api-reference/main/openapi.json post /app-invites 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 finishes the token exchange and marks the connection `connected`. 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: 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 cost forecasts, data forecasts, 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: 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: /app-invites: post: tags: - App Invites summary: Create an app invite description: >- Creates a new app invite for a company. Requires an app client credentials token. The invite is created in `pending` status and includes a generated invite code. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAppInviteRequest' responses: '201': description: Successfully created the app invite. content: application/json: schema: $ref: '#/components/schemas/AppInviteResponse' '400': description: >- This error is raised when: - The request body cannot be parsed - The `base_url` is not a valid URI - The `display_name` exceeds the maximum length (1024 characters) - The `invitee_name` exceeds the maximum length (1024 characters) - A `tags` entry is empty or exceeds the maximum length (128 characters) content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' security: - BearerAuth: [] components: schemas: CreateAppInviteRequest: type: object description: Request body for creating a new app invite. properties: base_url: type: string description: >- The base URL for the invite link. Must be a valid URI with a scheme and host. example: https://example.com/invite installation_id: type: integer format: int64 description: The ID of the app installation to create the invite for. example: 42 data: type: - object - 'null' description: Optional custom JSON data to associate with the invite. example: key: value display_name: type: - string - 'null' description: An optional display name for the invite. Maximum 1000 characters. example: Partner onboarding invite invitee_name: type: - string - 'null' description: An optional name for the invitee. Maximum 1024 characters. example: Jane Smith tags: type: array items: type: string description: >- A list of tags to associate with the invite. Each tag is max 128 characters. example: - onboarding required: - base_url - installation_id example: base_url: https://example.com/invite installation_id: 42 data: key: value display_name: Partner onboarding invite invitee_name: Jane Smith tags: - onboarding AppInviteResponse: type: object description: An app invite with full details. properties: id: type: string format: uuid description: Unique identifier for the app invite. example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 activated_at: type: - string - 'null' format: date-time description: >- The timestamp when the invite was activated, or null if not yet activated. example: '2025-01-15T10:30:00Z' app: $ref: '#/components/schemas/AppInfo' code: type: string description: The 24-character invite code. example: abc123def456ghi789jkl012 company: $ref: '#/components/schemas/CompanyInfo' created_at: type: string format: date-time description: The timestamp when the invite was created. example: '2025-01-01T00:00:00Z' data: type: - object - 'null' description: Custom JSON data associated with the invite. example: key: value display_name: type: - string - 'null' description: An optional display name for the invite. example: Partner onboarding invite invitee_name: type: - string - 'null' description: An optional name for the invitee. Maximum 1024 characters. example: Jane Smith status: $ref: '#/components/schemas/AppInviteStatus' tags: type: array items: type: string description: >- A list of tags associated with the invite. Each tag is max 128 characters. example: - onboarding - partner updated_at: type: string format: date-time description: The timestamp when the invite was last updated. example: '2025-01-15T10:30:00Z' url: type: string description: The full invite URL constructed from the base URL and invite code. example: https://example.com/invite?code=abc123def456ghi789jkl012 required: - id - app - code - company - created_at - status - updated_at - url example: id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 activated_at: null app: id: 100 name: Test App slug: test-app code: abc123def456ghi789jkl012 company: id: 42 logo: https://example.com/logo.png name: Acme Corp created_at: '2025-01-01T00:00:00Z' data: key: value display_name: Partner onboarding invite invitee_name: Jane Smith status: pending tags: - onboarding - partner updated_at: '2025-01-01T00:00:00Z' url: https://example.com/invite?code=abc123def456ghi789jkl012 Error: type: object required: - error - error_description properties: error: type: string example: Unauthorized error_description: type: string example: You are not authorized to use this endpoint. AppInfo: type: object description: Summary information about an app. properties: id: type: integer format: int64 description: The app ID. example: 100 name: type: string description: The app name from the manifest. example: Test App slug: type: - string - 'null' description: The app slug. example: test-app required: - id - name example: id: 100 name: Test App slug: test-app CompanyInfo: type: object description: Summary information about a company. properties: id: type: integer format: int64 description: The company ID. example: 42 logo: type: - string - 'null' description: URL to the company logo. example: https://example.com/logo.png name: type: string description: The company name. example: Acme Corp required: - id - name example: id: 42 logo: https://example.com/logo.png name: Acme Corp AppInviteStatus: type: string description: The lifecycle status of an app invite. enum: - pending - active - archived example: pending responses: Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: BearerAuth: type: http scheme: bearer ````