API Reference
Complete reference documentation for Informer's REST API endpoints.
New to the API? Getting started covers the base URL, authentication, and how to read HAL responses.
Sections
AI API
Endpoints for managing AI-powered conversations, models, providers, and per-user credit budgets.
Dataset API
Endpoints for creating, querying, and managing datasets including fields, filters, aggregations, and data operations.
Query API
Endpoints for creating, managing, and executing parameterized queries with support for drafts, multiple languages, and dataset generation.
Auth API
Authentication and session management endpoints for login, API tokens, password management, MFA, and impersonation.
App API
Comprehensive endpoints for creating and managing Magic Apps - AI-powered interactive applications with custom HTML/CSS/JavaScript that can access datasets and execute queries.
Assistant API
Comprehensive endpoints for managing AI assistants including skills, secrets, knowledge, files, and sharing.
Toolkit API
Endpoints for managing AI toolkits with MCP integration, tool discovery, and chat associations.
Report API
Comprehensive endpoints for creating and managing reports including templates, datasets, visuals, inputs, and publishing.
User API
Comprehensive endpoints for managing users including authentication, profiles, preferences, MFA, avatars, and team memberships.
Team API
API for managing teams including members, memberships, feed, and AI usage profile assignments.
Datasource API
API for managing datasources including drivers, connections, testing, field mappings, and capabilities.
Library API
Endpoints for managing document libraries, file storage, vector indexing, cloud integrations, snapshots, and AI assistant knowledge bases.
Job API
Endpoints for creating and managing scheduled jobs, automated workflows, actions, attachments, run history, and workers.
Integration API
Endpoints for managing OAuth integrations with external services including connections, tokens, and request proxying.
Template API
Comprehensive endpoints for creating and managing document templates including files, processors, inputs, rendering, drafts, and sharing.
Folder API
Endpoints for organizing content into hierarchical folder structures across multiple entity types.
Search API
Unified search endpoints for discovering and searching content across multiple entity types.
Visual API
Endpoints for creating and managing visual components like charts, graphs, and dashboards.
Tag API
Endpoints for creating and managing tags to categorize and filter content across entity types.
Function (UDF) API
Endpoints for creating and managing User-Defined Functions for custom data transformations.
Tenant / Admin API
Administrative endpoints for managing tenant configuration, licenses, mail settings, and system operations.
Storage API
Endpoints for file upload, retrieval, and storage management.
Subscription API
Endpoints for managing annual credit subscriptions including credit packs, billing, payment processing, and auto-replenish configuration.
Usage API
Endpoints for usage profiles (model-tier access and credit caps), per-entity budgets, and credit consumption reporting.
OAuth Client API
Endpoints for managing OAuth 2.0 client applications, secrets, authorization flows, and device authorization for third-party API access.
Authentication Domains API
Endpoints for managing authentication domains (the built-in local realm plus SSO/directory domains), their drivers, and directory scans.
Multi-Factor Auth API
Endpoints for managing multi-factor authenticators and the MFA drivers available to a tenant.
Principals API
Endpoints for enumerating, resolving, and reassigning Principals, the unified id space over Users and Teams.
Comments API
Endpoints for reading, editing, deleting, and replying to a Comment by id, plus listing a Comment's replies.
Favorites API
Endpoints for reading the home aggregate of readable entities flagged as favorites, and bulk-toggling favorites for the current User.
Colors API
Endpoints for managing the tenant color palette: keyed colors, per-color permissions, and palette import/export.
Letterheads API
Endpoints for managing Letterheads (headers, footers, and watermarks for templated PDF output), their files, drafts, and copies.
Inputs API
Read-only catalogs that power the Template input builder: the input editor component drivers and the input presets bucketed by value type.
Saved Query Filters API
Endpoints for creating, listing, reading, updating, and deleting saved query filters attached to a Mapping.
AI Instructions API
Endpoints for creating, reading, updating, and deleting reusable AI instruction presets.
User-Defined Fields API
Endpoints for managing user-defined fields (custom profile attributes on Users), setting their values, and discovering custom-field drivers.
Bundles API
Endpoints for creating and managing schema Bundles, their entries, and the entry-type drivers used to export and import entities across systems.
Billing API
Endpoints for managing saved payment cards and receipts through the License Manager billing proxy.
Flow Steps API
Read-only endpoints for the registry of flow-step types available to a Dataset's data-prep flow.