Informer API
The Informer API provides programmatic access to Informer's business intelligence and reporting platform. Use it to manage datasets, build AI-powered experiences, and integrate Informer into your workflows.
Guides
New to building with Informer? Start with the Magic Apps Guides - a progressive tutorial series that takes you from setup to AI-enhanced dashboards.
- Getting Started - Install the Claude Code plugin and deploy your first app
- KPI Dashboard - Build a dashboard with metrics and charts
- Multi-Dataset Dashboard - Combine data from multiple datasets
- Integration Dashboard - Pull data from external APIs
- API Mashup - Combine datasets, integrations, and saved queries
- AI-Enhanced Dashboard - Add AI tools and chat integration
- Smart Summaries - Use AI completion endpoints for insights
Getting Started
Authentication
All API requests require authentication. Informer supports session-based authentication and API tokens.
Session Authentication
Obtain a session by posting credentials to the auth endpoint:
curl -X POST https://your-instance.entrinsik.com/api/auth/login \
-H "Content-Type: application/json" \
-d '{"username": "your-username", "password": "your-password"}'
Include the session cookie in subsequent requests.
API Tokens
For server-to-server integrations, use API tokens passed via the Authorization header:
curl https://your-instance.entrinsik.com/api/datasets \
-H "Authorization: Bearer YOUR_API_TOKEN"
Base URL
All API endpoints are relative to your Informer instance:
https://your-instance.entrinsik.com/api/
Response Format
The API returns JSON responses following the HAL hypermedia format, with _links and _embedded properties for resource navigation.
Example HAL response:
{
"id": "example-dataset",
"name": "Sales Data",
"type": "dataset",
"_links": {
"self": { "href": "/api/datasets/example-dataset" },
"fields": { "href": "/api/datasets/example-dataset/fields" },
"run": { "href": "/api/datasets/example-dataset/run" }
}
}
API Sections
The Informer API is organized into 20 sections covering core data management, AI capabilities, identity and access, content management, and platform configuration.
Core Data
| API | Description | Endpoints |
|---|---|---|
| Dataset | Create, query, and manage datasets with fields, filters, and aggregations | ~108 |
| Query | Execute parameterized queries with drafts, multiple languages, and dataset generation | ~30 |
| Report | Build and publish reports with templates, inputs, and visuals | ~40 |
| Visual | Create chart components and visualizations | ~6 |
| Template | Manage report templates with files, processors, and inputs | ~50 |
AI Platform
| API | Description | Endpoints |
|---|---|---|
| AI | Manage chats, messages, models, providers, seats, and usage budgets | ~71 |
| Assistant | Configure AI assistants with skills, secrets, knowledge, and files | ~40 |
| Toolkit | Integrate AI toolkits with MCP support and tool discovery | ~20 |
Identity & Access
| API | Description | Endpoints |
|---|---|---|
| Auth | Login, logout, API tokens, password management, and MFA | ~25 |
| User | Manage users, profiles, preferences, avatars, and memberships | ~30 |
| Team | Configure teams, members, and AI subscriptions | ~15 |
Content Management
| API | Description | Endpoints |
|---|---|---|
| Library | Organize and sync files with integration support | ~50 |
| Job | Schedule and execute jobs with actions, attachments, and history | ~40 |
| Integration | Connect external services with OAuth and API integrations | ~15 |
| Folder | Organize content hierarchically with permissions | ~9 |
Configuration & Admin
| API | Description | Endpoints |
|---|---|---|
| Datasource | Connect to databases with drivers, testing, and field mappings | ~25 |
| Tenant | Manage tenant settings, licenses, mail, and App configuration | ~20 |
| Function | Create user-defined functions (UDFs) in JavaScript | ~6 |
| Storage | Upload, retrieve, and search files | ~4 |
| Subscription | Handle AI seat subscriptions and billing | ~5 |
| Tag | Organize resources with color-coded tags | ~7 |
| Search | Universal search across all content types | ~1 |
Total Coverage
The documentation covers approximately 537 endpoints across 21 API sections, providing comprehensive reference material for building integrations with Informer.