Getting Started

This guide walks you through creating your InformedAI account, setting up a workspace, defining a document type, and embedding the assistant widget in your application.

Create Your Account#

Sign up for an InformedAI account. An organization and default workspace are created automatically when you register.

After signing in you land on the dashboard where you can manage workspaces, document types, knowledge library, and API keys.

Understand Workspaces#

A workspace is an isolated environment with its own:

• API keys
• Knowledge library (RAG-powered domain knowledge)
• Document types and documents
• Widget configuration

Most teams only need a single workspace, but you can create separate ones for staging and production environments.

Get Your API Keys#

InformedAI uses four key types, each scoped to specific operations. You can find and manage your keys in the dashboard under Settings:

| Prefix | Name | Use Case | |--------|------|----------| | wsk_ | Workspace Secret Key | Server-side admin operations (full access) | | pak_ | Public Access Key | Client-side widget authentication | | ssk_ | Sync Secret Key | Webhook and sync operations | | aak_ | Admin Access Key | Admin chatbot access |

Include your key in the Authorization header:

curl -H "Authorization: Bearer wsk_your_key" \
  https://api.informedai.app/api/v1/document-types

Create Your First Document Type#

A document type defines the schema of documents the AI assistant will help create. Each field in the schema becomes a task the assistant can work on.

Supported Field Types#

| Type | Description | |------|-------------| | string | Plain text (titles, names, short descriptions) | | number | Numeric values | | boolean | True/false toggles | | richtext | Rich HTML content (articles, descriptions) | | array | Lists of values | | image | Image prompt generation |

Example: Blog Post Schema#

{
  "fields": {
    "title": {
      "type": "string",
      "label": "Title",
      "description": "The blog post title"
    },
    "body": {
      "type": "richtext",
      "label": "Body",
      "description": "Main content of the blog post"
    },
    "tags": {
      "type": "array",
      "label": "Tags",
      "description": "Relevant topic tags"
    }
  }
}

Create via API#

curl -X POST https://api.informedai.app/api/v1/document-types \
  -H "Authorization: Bearer wsk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "blog_post",
    "displayName": "Blog Post",
    "schema": {
      "fields": {
        "title": { "type": "string", "label": "Title", "description": "The blog post title" },
        "body": { "type": "richtext", "label": "Body", "description": "Main content" },
        "tags": { "type": "array", "label": "Tags", "description": "Topic tags" }
      }
    }
  }'

You can also create document types from the dashboard UI.

Create a Document#

Once you have a document type, create a document instance:

curl -X POST https://api.informedai.app/api/v1/documents \
  -H "Authorization: Bearer wsk_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "documentTypeId": "dt_abc123",
    "data": {}
  }'

The AI assistant will help fill in each field based on your knowledge library and the document type schema.

Embed the Widget#

Install the React SDK and add the assistant to your application:

npm install @informedai/react

import { InformedAssistant } from '@informedai/react';
 
function MyEditor() {
  return (
    <InformedAssistant
      documentTypeId="dt_abc123"
      accessKey="pak_your_pool_access_key"
      onFieldApply={(field, value) => {
        console.log(`Applied ${value} to ${field}`);
      }}
    />
  );
}

The widget authenticates using a Pool Access Key (pak_ prefix). You can find your key in Settings > Environments in the dashboard. The API also validates the request origin against your environment's allowed domains. See the React SDK docs for full configuration options.

Next Steps#

• React SDK — Full component reference and theming
• Sync SDK — Sync your backend data to the knowledge library
• API Reference — Complete endpoint documentation