Build with Notir API

Introduction

Notir provides a powerful API for ingesting documents, querying your knowledge base, and building intelligent applications. Our API is RESTful and returns JSON responses.

Quick Start

curl -X POST "https://api.notir.io/api/v1/ingest" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_ORG_ID" \
  -d '{
    "content": "Your content to ingest",
    "metadata": {
      "source": "api",
      "type": "feedback"
    }
  }'

// Query your knowledge base
const response = await fetch('https://api.notir.io/api/v1/query', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY',
    'x-tenant-id': 'YOUR_ORG_ID'
  },
  body: JSON.stringify({
    query: 'What are the main customer complaints?',
    options: {
      maxResults: 5,
      includeMetadata: true
    }
  })
});

const { answer, sources } = await response.json();

Authentication

All API requests require authentication using an API key. Include your key in theAuthorization header.

REST API

The Notir REST API provides endpoints for document ingestion, querying, and management.

curl -X POST "https://api.notir.io/api/v1/ingest" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-tenant-id: YOUR_ORG_ID" \
  -d '{
    "content": "Your content to ingest",
    "metadata": {
      "source": "api",
      "type": "feedback"
    }
  }'

API Endpoints

JavaScript SDK

Our JavaScript SDK makes it easy to integrate Notir into your Node.js or browser applications.

npm install @notir/sdk

import { NotirClient } from '@notir/sdk';

const notir = new NotirClient({
  apiKey: 'YOUR_API_KEY',
  orgId: 'YOUR_ORG_ID'
});

// Ingest content
await notir.ingest({
  content: 'User feedback or content',
  metadata: {
    source: 'app',
    userId: 'user-123',
    page: '/dashboard'
  }
});

// Query the knowledge base
const response = await notir.query('What feedback have users given?');
console.log(response.answer);

Embeddable Widget

Add a chat widget to your website with just a few lines of code. The widget allows your users to interact with your knowledge base directly.

<!-- Notir Widget -->
<script src="https://api.notir.io/notir-widget.js" 
        data-api-key="YOUR_API_KEY"
        data-org-id="YOUR_ORG_ID"
        data-position="bottom-right"
        data-theme="light">
</script>

Webhooks

Receive real-time notifications when events occur in your Notir account. Configure webhooks to trigger automations and keep your systems in sync.