DOCSEARCHbyAlgolia
Submit Docs

Informer API Reference

website·Indexed 33 days ago

https://docs.entrinsik.com

Complete reference documentation for Informer's REST API endpoints. This includes comprehensive guides for AI capabilities (chats, models, providers, and memories), Magic App development (core CRUD, runtime, server routes, and persistence), and Assistant management (draft workflows, files, and collaboration).

Tokens
308.8K
Snippets
1.1K
Records
2.5K
Agent score
50%

What's inside Informer

  1. Overview of AI Models and Aliases

    AI models in the system are categorized into two types:

    • Canonical Models: Point directly to a Provider and a provider-side model identifier.
    • Alias Models: Reference another model via referencesId. They inherit the provider and capabilities of the referenced model but can override the name, slug, instructions, and options.

  2. Overview of Informer Bundles

    Bundles are packs of Informer content used to export data from one instance of Informer and import it into another. Only Super Users have the permission to create Bundles. To manage Bundles, navigate to Administration > Bundles.

  3. Overview of the Assistant Draft Workflow

    The Draft Workflow provides a mechanism to edit an Assistant without impacting its live version. A draft is a separate Assistant row where the editingId points back to the original Assistant. This is recommended for making significant changes to Assistants actively used in production chats. The workflow consists of creating a draft, editing it via standard Assistant routes, and finally either committing the changes to the live version or discarding the draft.

  4. Overview of Informer REST API Endpoints

    Informer provides a comprehensive set of REST API endpoints for managing various system components. The API uses HAL (Hypertext Application Language) responses. Key functional areas include:

    • AI & Automation: AI API (conversations, models, budgets), Assistant API (skills, knowledge), Toolkit API (MCP integration), and AI Instructions API.
    • Data & Querying: Dataset API (data operations), Query API (parameterized queries), Datasource API (connections, drivers), and Function (UDF) API.
    • User & Access Management: Auth API (sessions, MFA), User API (profiles), Team API (memberships), Principals API (unified ID space), and Authentication Domains API.
    • Content & Reporting: Report API (templates, visuals), Library API (vector indexing, files), Template API (document rendering), and Folder API.
    • System Administration: Tenant/Admin API (licenses, mail settings), Subscription API (billing, credits), Usage API (credit caps), and OAuth Client API.
    • UI & Customization: App API (Magic Apps with HTML/CSS/JS), Visual API (charts), Colors API (tenant palette), and Letterheads API.

  5. Overview of the Authorization Code Flow

    The Authorization Code Flow is a standard OAuth 2.0 grant used to obtain access tokens. The process consists of four primary steps: discovering available scopes, redirecting the user to the authorization endpoint for consent, receiving a single-use authorization code via a redirect, and exchanging that code for tokens using client credentials. This flow supports optional PKCE (Proof Key for Code Exchange) for enhanced security.

  6. Overview of Search Clusters in Informer

    Search Clusters allow administrators to connect and manage ElasticSearch or OpenSearch instances. In multi-tenant deployments, administrators can distribute Tenants across multiple clusters to improve performance and reduce bottlenecks. This feature was introduced in Informer 2025.2.9; organizations upgrading from previous versions will have an 'Initial Search Cluster' automatically created using existing deployment-level credentials.

  7. Overview of Add Field Flow Steps

    Add Field Flow Steps are used to create new fields based on values within a Query's result set. Every Add Field Flow Step includes two primary identification options:

    • Label: The display name of the Flow Step as seen by the user.
    • Alias: A unique identifier used by Informer to reference the Flow Step (auto-generated from the Label but editable).

  8. Overview of Assistant Skills and Permissions

    Assistant Skills are capabilities attached to an AI Assistant. Each skill's behavior is defined by a registered skill driver. Access to all skills routes requires ai.verify (AI enabled on the tenant and the caller having AI access). Write operations (POST, PUT, DELETE) additionally require the permission.assistant.write permission for the specific Assistant.

    Registered skill driver IDs include: informerExpert, apiRequest, simpleFunction, highcharts, magic-visual, app, printTemplate, websiteSearch, quickbooks, salesforce, and informer.

  9. Overview of App Databases

    App databases are external Postgres connection profiles that allow Magic Apps to store data in a dedicated database instead of the primary Informer database. These are system-level resources, meaning all API routes associated with app databases require root-manager superuser privileges. Creating a profile triggers lazy provisioning of the target database, and using the ping route establishes a live connection.

  10. Overview of Report Access Tokens

    Tokens provide authenticated access to reports without requiring a user login. They are used for embedding reports in external applications, sharing reports with unauthenticated users, and providing limited-scope API access. Tokens can be either local (server-side) or cloud-based (created when cloud publishing is enabled).

  11. Overview of the Informer Template Editor

    The Template editor allows users to define the format and styling of reports using either a visual designer or direct code. Key interface sections include:

    • Header bar: Contains the Template name, breadcrumb navigation, and Save/Cancel buttons.
    • Run/Refresh button: Generates a PDF or HTML preview. The dropdown allows choosing between an in-editor preview or a new window.
    • Component list: Provides access to Template files, Assets, Inputs, Processors, and Outputs.
    • Component editor: The primary workspace for making changes. Users can toggle between the HTML view and Designer Mode.

  12. Overview of Dataset Visuals

    Visuals are charts, pivots, maps, and other visual representations attached to a Dataset. Each visual contains a component object keyed by its visual type (e.g., chart, pivot, map). The configuration within the component is owned by the client and stored verbatim by the system.