> ## 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. # Get App Invite ## OpenAPI ````yaml https://docs-cdn.narrative.io/api-reference/main/openapi.json get /app-invites/{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: >- System Access Tokens are long-lived bearer credentials for calling the API without a user present. A token belongs to a company, carries an explicit list of permissions, and expires on a date you choose — at least a day out and at most a year. `admin` access cannot be granted to one. `POST /access-tokens/tokens` is the only endpoint that returns the credential. Everything after that works in terms of the token's id: the list, get and update responses describe a token without ever repeating its `access_token`. If you lose it, delete the token and create another. 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: 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: 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: 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: 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: 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: Webhooks description: >- Webhooks push events to a URL you control instead of making you poll for them. You create a subscription with the endpoint you want events sent to and a filter describing which events you want. Two kinds of subscription exist: job subscriptions follow the lifecycle of Narrative jobs, and app subscriptions follow the events a Narrative app reports through `POST /apps/events`. Creating a subscription returns a `secret`. Narrative sends it back in the `X-Narrative-Secret` header on every delivery, and comparing the two is how you tell a real callback from a forged one — so store it and do not share it. Deliveries are described under the "Event delivery" webhook below. Return any 2xx; anything else is retried with exponential backoff, and because a retry reuses the envelope's `id`, handlers should be idempotent on it. - 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/{id}: get: tags: - App Invites summary: Get App Invite operationId: GetAppInvite parameters: - name: id in: path description: App invite id in UUID format. schema: type: string description: App invite id in UUID format. pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 required: true responses: '200': description: GetAppInvite 200 response content: application/json: schema: $ref: '#/components/schemas/AppInviteResponse' '400': description: BadRequestError 400 response content: application/json: schema: $ref: '#/components/schemas/BadRequestError' '401': description: UnauthorizedError 401 response content: application/json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: ForbiddenError 403 response content: application/json: schema: $ref: '#/components/schemas/ForbiddenError' '404': description: 404 Response '500': description: InternalError 500 response security: - BearerAuth: [] components: schemas: AppInviteResponse: type: object properties: id: type: string description: App invite id in UUID format. pattern: >- ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 activated_at: type: string format: date-time example: '2025-01-15T10:30:00Z' app: $ref: '#/components/schemas/AppInfo' code: type: string description: 24-character alphanumeric invite code. pattern: ^[A-Za-z0-9]{24}$ example: abc123def456ghi789jkl012 company: $ref: '#/components/schemas/CompanyInfo' created_at: type: string format: date-time example: '2025-01-01T00:00:00Z' data: example: key: value display_name: type: string description: >- Display name shown to the invitee. Non-empty, at most 1023 characters once trimmed. minLength: 1 maxLength: 1023 example: Partner onboarding invite installation_id: type: integer format: int64 invitee_name: type: string description: >- Name of the invitee. Non-empty, at most 1023 characters once trimmed. minLength: 1 maxLength: 1023 example: Jane Smith status: $ref: '#/components/schemas/AppInviteStatus' tags: type: array items: type: string description: >- Free-form tag on an invite. Non-empty, at most 128 characters once trimmed. minLength: 1 maxLength: 128 example: - onboarding - partner updated_at: type: string format: date-time example: '2025-01-15T10:30:00Z' url: type: string description: >- The full invite URL: base_url with the invite code appended as a query parameter. example: https://example.com/invite?code=abc123def456ghi789jkl012 required: - app - code - company - created_at - id - installation_id - status - tags - updated_at - url example: id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 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 BadRequestError: type: object description: >- API-wide errors, declared at service level because any operation can return them: the auth middleware (UnauthorizedError, ForbiddenError), request decoding (BadRequestError) and unexpected failures (InternalError). Errors an operation produces itself are declared on that operation, under a name that says what went wrong. Error bodies mirror the marketplace API's existing error shape from io.narrative.api.model.Error: {"error": "", "error_description": ""}. InternalError intentionally has no members; it serializes as "{}". properties: error: type: string error_description: type: string required: - error - error_description UnauthorizedError: type: object properties: error: type: string error_description: type: string required: - error - error_description ForbiddenError: type: object properties: error: type: string error_description: type: string required: - error - error_description AppInfo: type: object properties: id: type: integer minimum: 1 format: int64 example: 100 name: type: string example: Test App slug: type: string example: test-app required: - id - name example: id: 100 name: Test App slug: test-app CompanyInfo: type: object properties: id: type: integer minimum: 0 format: int64 example: 42 logo: type: string example: https://example.com/logo.png name: type: string example: Acme Corp required: - id - name example: id: 42 logo: https://example.com/logo.png name: Acme Corp AppInviteStatus: type: string enum: - pending - active - archived example: pending securitySchemes: BearerAuth: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.