Run organization-grade assistants with the same API your product can extend
Companin centralizes assistant configuration, user contexts, conversations, and knowledge so your teams and partners ship reliable workflows without stitching together multiple services.
Assistant catalog
Create and manage assistant personas per organization using REST endpoints for full lifecycle control.
Context-aware sessions
Capture visitor sessions, attach user traits, and keep conversations persistent across touchpoints.
Knowledge that stays fresh
Sync files, curated Q&A, and URLs into the knowledge base so assistants surface the right answers.
Built around real resources
Core resources
Assistants / Sessions / Conversations / Knowledge
Rate limit
1000 requests/day per org
Auth
X-API-Key header
API Performance Metrics
Reliable and fast API for seamless integrations
API requests per month
API uptime
active integrations
average response time
Capabilities shipped with the organization assistant platform
Each capability maps to an API resource or analytics surface inside the Companin stack, so everything in the UI can also be automated.
Assistant personas
Shape tone, language, and default tasks for each organization while tracking versions programmatically.
Knowledge everywhere
Upload files, add curated Q&A, and ingest URLs with metadata so answers stay accurate over time.
User context & sessions
Store visitor traits, manage anonymous sessions, and keep conversation history.
Conversations with feedback
Stream messages, capture assistant replies, and record rating feedback to improve quality signals.
Operational analytics
Query request logs, usage aggregates, and endpoint metrics to monitor adoption and performance.
Guardrails built-in
API keys, rate limiting, and per-organization data isolation make governance straightforward.
How Companin resources power your workflow
Every step is anchored in the endpoints shipping in the assistant API, so what you automate in code mirrors what operators see in the dashboard.
- 1Provision assistants
Create assistant personas, set tone and language, and manage active status with the /assistants endpoints.
- 2Load knowledge
Attach files, URLs, or curated Q&A to the knowledge base so responses stay grounded in your source material.
- 3Personalize sessions
Create visitor sessions, store user traits, and keep metadata synced using /sessions and /contexts.
- 4Track conversations
Stream messages, capture assistant replies, and log feedback for continuous improvement via /conversations routes.
Extend Companin through the same API that powers the dashboard
The REST API exposes every core resource: assistants, knowledge, sessions, contexts, conversations, and analytics. Bring the assistant experience into your applications without reimplementing the backend.
Assistant lifecycle
Create, update, and archive organization-specific assistants with tone, language, and default task settings.
Knowledge management
Manage files, curated Q&A, and URLs with summaries, keywords, and embeddings ready for semantic search.
Sessions and context
Handle visitor sessions, attach user traits, and keep metadata aligned to your identifiers across channels.
Usage analytics
Query request logs, aggregate usage, endpoint metrics, and rate-limit events to monitor your deployment.
Send a message into an ongoing conversation
curl -X POST https://api.companin.tech/api/v1/conversations/send-message \
-H "X-API-Key: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"session_id": "session-123",
"message": "Hello, assistant!"
}'Tooling
- API documentation available at /api/v1/docs with OpenAPI schema.
- Sandbox environments seeded with example data for testing integrations.
- Rate limiting and analytics endpoints for usage monitoring and governance.
Launch your organization assistant in five steps
Everything maps directly to the REST resources already live in the Assistant API, so you can go from sandbox to production without rewriting workflows.
Provision API access
Generate an API key from the dashboard and authenticate every request with the X-API-Key header.
Create assistant personas
Call /api/v1/assistants to configure tone, language, and default tasks for each organization you manage.
Load trusted knowledge
Use the knowledge endpoints for files, URLs, and Q&A so responses stay grounded in up-to-date content.
Wire up sessions and context
Create visitor sessions, attach user traits, and map them to your own identifiers via /sessions and /contexts.
Stream conversations
Send and retrieve messages with the /conversations endpoints, capture feedback, and monitor status in real time.
Keep every integration accountable with analytics endpoints
Dedicated analytics routes surface usage trends and rate-limit signals so operations teams can act before SLAs slip.
Request logs
Export detailed API request logs to investigate issues and confirm compliance across organizations.
GET /assistant_api/analytics/logs/
Usage aggregates
Track volume by endpoint and organization to stay ahead of rate limits and plan billing.
GET /assistant_api/analytics/usage/
Rate-limit events
Monitor when requests are throttled so you can tune integrations before users feel friction.
GET /assistant_api/analytics/rate-limits/
Report a Bug
Request a Feature
Found a bug or have an idea to improve our productivity assistant? We'd love to hear from you. Your feedback helps us build a better experience for everyone.