Latest Documentation
Welcome to the ContentIQ documentation. This section will always reflect the most up-to-date product guidance, integration steps, and operator notes.
v1.2.0
Latest release with ingest time estimation, SSO configuration, Azure Blob Storage, RBAC, and more.
Latestv1.1.0
Content APIs, Content Management UI, and SharePoint Wizard refresh.
v1.0.0
Initial release of ContentIQ.
API Reference
Explore REST endpoints for ingestion, vector store administration, and analytics.
API Reference
Explore REST endpoints for ingestion, vector store administration, and analytics.
Getting Your API Key
Through the Web Interface
- Login to your ContentIQ account
- Go to Settings (left sidebar)
- Click the ContentIQ API tab
- Click Generate next to ContentIQ API Key
- Copy the key — you'll only see it once!
Important
- Keep your API key secure. Don't share it or commit it to code repositories.
- Each time you generate a new key, the previous one becomes invalid.
- You must be logged into your ContentIQ account to generate keys.
Chat with Your Agent
Notes:
- Agent ID is the watsonx Orchestrate Agent ID (find via ADK or in the ContentIQ dashboard under Usage Analytics).
- Thread ID should be dynamically generated per conversation.
Basic Chat Example
curl -X POST "https://backend.contentiq.symplistic.ai/api/headless/chat" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY_HERE" \
-d '{
"agent_id": "your-agent-id",
"message": "Hello! What can you help me with?",
"thread_id": "my-conversation-123"
}'Upload Documents
Upload documents for ingestion into your agent's knowledge base.
curl -X POST "https://backend.contentiq.symplistic.ai/api/headless/document/ingest" \
-H "Authorization: Bearer YOUR_API_KEY_HERE" \
-F "[email protected]" \
-F "[email protected]" \
-F "agent_id=your-agent-id" \
-F "use_gpu=true"Check Ingestion Status
Check the status of a document ingestion run.
curl -N -H "Authorization: Bearer YOUR_API_KEY_HERE" \
"https://backend.contentiq.symplistic.ai/api/headless/document/status/<YOUR_RUN_ID>/stream"List Structured Data Files (Headless)
Returns files with schema, row/column counts, and sample rows. Supports Parquet, CSV, Excel, JSON, XML.
curl -X GET "https://backend.contentiq.symplistic.ai/api/headless/structured_data/files?agent_id={agent_id}" \
-H "Authorization: Bearer YOUR_API_KEY_HERE"Delete Structured Data File (Headless)
Remove a structured data file by filename.
curl -X DELETE "https://backend.contentiq.symplistic.ai/api/headless/structured_data/files/{filename}?agent_id={agent_id}" \
-H "Authorization: Bearer YOUR_API_KEY_HERE"List Milvus Sources (Headless)
List distinct source URLs in an agent's Milvus collection.
curl -X GET "https://backend.contentiq.symplistic.ai/api/headless/milvus/sources?agent_id={agent_id}&batch_size=512" \
-H "Authorization: Bearer YOUR_API_KEY_HERE"Delete Milvus Chunks by Source (Headless)
Delete all chunks for a specific source URL.
curl -X DELETE "https://backend.contentiq.symplistic.ai/api/headless/milvus/chunks" \
-H "Authorization: Bearer YOUR_API_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"agent_id": "{agent_id}",
"source": "https://example.com/document1.pdf"
}'Delete Entire Milvus Collection (Headless)
⚠️ WARNING: This permanently deletes the entire Milvus collection for an agent. This action cannot be undone.
curl -X DELETE "https://backend.contentiq.symplistic.ai/api/headless/milvus/collection" \
-H "Authorization: Bearer YOUR_API_KEY_HERE" \
-H "Content-Type: application/json" \
-d '{
"agent_id": "{agent_id}"
}'Highlights
Ingest Time Estimation
See estimated completion time for each document ingestion process.
Single Sign-On (SSO) Configuration
Configure and manage SSO authentication for your ContentIQ instance.
Custom Azure Blob Storage
Configure custom Azure Blob Storage for document storage and retrieval.
Role-Based Access Control (RBAC)
Configure roles and permissions for users and service accounts via the Admin tab.
Agent Management
View, edit, delete, and undeploy agents from a centralized management interface.
Cancel Ingestion
Cancel ongoing ingestion runs using the cancel button available during active ingestion.
Ingest Time Estimation
Where
Estimated time is displayed during the ingestion process in the Connect section and ingestion status pages.
What you can do
- View estimated completion time for each ingestion run before starting the process.
- Monitor progress with real-time time estimates that update as ingestion progresses.
- Plan your workflows more effectively with accurate time predictions based on document size and complexity.
Cancel Ingestion
Where
The Cancel Ingestion button appears during an ongoing ingestion run in the ingestion status view.
What you can do
- Cancel ongoing ingestion runs by clicking the "Cancel Ingestion" button that appears during active ingestion processes.
- Stop ingestion workflows when you need to halt processing before completion.
Single Sign-On (SSO) Configuration
Where
Go to Settings → SSO Configuration to configure SSO for your ContentIQ instance.
Important
- SSO is only available for Microsoft Azure Entra (formerly Azure AD).
- You must configure your app registration on Microsoft Azure Entra before configuring SSO in ContentIQ.
- The redirect URI for ContentIQ must be set to
https://contentiq.symplistic.ai/auth/sso_callback.htmlin both the ContentIQ setup and in Microsoft Azure AD.
What you can do
- Configure SSO by entering Microsoft Azure Entra app registration details and credentials.
- Enable or disable SSO for your ContentIQ instance.
- Manage SSO settings including callback URLs, certificate configuration, and user attribute mapping.
Custom Azure Blob Storage Configuration
Where
Go to Settings → Object Store to configure custom Azure Blob Storage for your ContentIQ instance.
Important
- You must have an Azure Storage Account with Blob Storage enabled.
- Provide valid connection string or account key for authentication.
- Ensure the storage account has appropriate permissions for read/write operations.
- Configure container names and access policies according to your security requirements.
What you can do
- Set Azure Blob Storage credentials including connection string, account name, and container configuration.
- Configure storage containers for different document types or agents.
- View current storage configuration (sanitized) to verify settings.
- Clear custom storage settings to revert to default ContentIQ storage configuration.
- Test storage connection to ensure proper access and permissions.
Role-Based Access Control (RBAC)
Where
Go to Settings → Admin to configure roles and permissions for your ContentIQ instance.
What you can do
- Create, update, and delete custom roles per tenant with specific permissions.
- Assign roles to service accounts to control access to resources and operations.
- Enforce access control with admin-only endpoints for SSO configuration and RBAC management.
- Control content visibility based on assigned roles, ensuring users only see content they're permitted to access.
Agent Management
Where
Access agent management through the Deploy Agent and Agent List tabs.
What you can do
- View all agents in a clean, organized interface for easy navigation.
- Edit agents directly from the management interface to update configurations and settings.
- Delete agents when they are no longer needed.
- Undeploy agents to remove them from active deployment while preserving their configuration.
Frontend — UX Improvements
We've made significant UX/UI improvements across several key pages to enhance user experience and interface consistency:
- Ingest Analytics — Improved layout and visual design for better readability and data presentation.
- Usage Analytics — Enhanced interface with cleaner organization and improved data visualization.
- Content Management — Refined user interface for more intuitive content management workflows.
- Conversation Platforms — Updated design elements and improved user interactions for better engagement.
Upgrade Notes
- No migrations required for existing installations.
- SSO configuration is optional and can be enabled when ready.
- Custom Azure Blob Storage configuration is optional; ContentIQ will use default storage if not configured.
- Ingest time estimation is automatically enabled for all new ingestion runs.
- RBAC is available for admin users to configure roles and permissions; existing installations will have default admin access.
- Agent Management is immediately available for all users to manage their agents.
- Cancel Ingestion functionality is automatically available for all ongoing ingestion runs.
Highlights
Content APIs
List, inspect, and delete Files or Web Pages uploaded to ContentIQ.
Content Management via UI
Manage your agent's content across Vector Store and Structured Data.
SharePoint Wizard Refresh
Cleaner, consistent UI aligned with OneDrive.
Vector Store (Settings) — Milvus
Where
Go to Settings → Vector Store to configure Milvus access used by ContentIQ.
Important
- Supports Zilliz Cloud, Azure, & Qdrant
- The URI is the address of the Milvus server.
- The Token is the authentication token for the Milvus server.
What you can do
- Set credentials (URI, Token) used by backend for Milvus operations.
- View current credentials (sanitized) to confirm configuration.
- Clear credentials to fall back to default ContentIQ SaaS configuration, which would use ContentIQ Milvus as a Service.
Frontend — UX Improvements
SharePoint Connect Wizard gets a visual refresh with a professional palette and consistent iconography, aligning with OneDrive.
Content Management Page
Manage your agent's content.
Key actions
- Select Agent from the dropdown to load its content.
- Search within sources by URL or filename.
- Delete file by Name or URL — removes a file from the agent's content.
- Delete entire collection — wipes the agent's Milvus collection (irreversible).
Upgrade Notes
- No migrations required.
- If using Milvus operations, ensure credentials are set via the new credentials endpoints or environment configuration.
Initial release of ContentIQ. See API Reference section for all available endpoints.