Custom (ai12z)

ai12z Custom Connector Setup Guide

The connector is responsible for processing custom source data and ingesting it into the platform

Step 1: Enable Connector

1. Log in to the Ai12z portal using admin credentials.
2. In the organization settings, verify that the connectors are enabled.
3. Navigate to your Agent.
4. Select Agent Settings.
5. Click on the edit button next to Connectors and enable ai12z (Custom).

Step 2: Configure Connector

1. Select Connectors from the Agent left navigation.
2. From the connector list, click on Custom
3. In the Connector Configuration screen, fill out the information

• Name: Friendly name
• Description: General description
• Filter By Language:
• Include Patterns: A RegEx per line
• Exclude Patterns: A RegEx per line

Step 3: Create API Key

Generate key by clicking on the Manage Keys button

Step 4: Submit data to ingest

curl --location '<YOUR_ENDPOINT>' \
--header 'Content-Type: application/json' \
--header 'x-api-key: your-key' \
--data '{
    "id": "cinema001",
    "title": "The Cinema and Social Impact",
    "description": "How films became a voice for the people.",
    "content": "The cinema has often tackled bold social issues – from caste discrimination to corruption – using storytelling as a tool for awareness and reform. It's not just entertainment; it's influence.",
    "url": "https://example.com/hollywood",
    "eventType": "publish",
  "metadata": {
  }
}
'

Event Types for Data Ingestion

The eventType field in your data submission determines the action the platform should take with the provided content. Below are the supported event types:

1. publish

• Description: Use this event type to add new content or update existing content in the platform. This is the default action for ingesting or refreshing data.
• When to use: When you want to make content available for search, retrieval, or display.
• Example:

{
  "id": "cinema001",
  "title": "The Cinema and Social Impact",
  "eventType": "publish",
  ...
}

2. unpublish

• Description: Use this event type to remove or hide content from the platform. The content will no longer be available for search or display, but may be retained for audit or recovery purposes.
• When to use: When content should no longer be accessible to users (e.g., outdated, retracted, or deleted content).
• Example:

{
  "id": "cinema001",
  "eventType": "unpublish"
}

Note: The id field must match the content you wish to unpublish.

If you have custom event types or workflows, please refer to your platform administrator or integration specialist for further guidance.