Simplafy Docs

hub-api

API reference for hub-api.

Login with email and password

Register a new user

Refresh access token using refresh cookie

Logout and revoke all refresh tokens

Get current user profile

Update current user profile

Switch organization context, get new access token

Request password reset email

Reset password with token from email

List user's org memberships

Create a new organization

Get organization details

Update organization (owner only)

Delete organization (owner only)

List org members

Update member role (admin only)

Remove member (admin only)

List pending invitations (admin only)

Create an invitation (admin only)

Revoke an invitation (admin only)

Accept an invitation (authenticated user)

Validate invitation token (public)

Accept invitation and create account (public)

Get current user's permissions for the org

Get specific member's permissions (admin only)

Set member's permissions (admin only)

Seed/update OAuth token for an org (admin only)

List webhook templates

Create a webhook template (admin only)

Get a webhook template

Update a webhook template (admin only)

Delete a webhook template (admin only)

List agent tool param mappings

Create or update a param mapping

Delete a param mapping

List org credentials (admin only)

Create a credential (admin only)

Get a credential (admin only)

Update a credential (admin only)

Delete a credential (admin only)

List agent credential overrides (admin only)

Upsert an agent credential override (admin only)

Delete an agent credential override (admin only)

Resolve credentials for an agent/deployment (member)

List credential sets (admin only)

Create a credential set (admin only)

Get a credential set (admin only)

Update a credential set — merges values (admin only)

Delete a credential set (admin only)

List agent-to-credential-set bindings (member)

Upsert agent-to-credential-set binding (member)

Delete agent-to-credential-set binding (member)

Update agent system prompt (admin only) — saves to Langfuse + LangGraph

List prompt versions for an agent (member)

Restore agent prompt to a previous version (admin only)

List guardrail rules for an org (member)

Create a guardrail rule (admin only)

Delete a guardrail rule (admin only)

Update a guardrail rule (admin only)

List channels for an org (member)

Create a channel (admin only) — provisions Evolution API instance

Get a channel (member)

Update a channel (admin only)

Delete a channel (admin only) — removes Evolution API instance

Get QR code for connecting a QR_CODE channel (member)

Get channel connection status from Evolution API (member)

Get channel WhatsApp profile (member)

Update channel WhatsApp profile (admin only)

Create a shareable QR link token (admin only)

List WWABA message templates (member)

Create a WWABA message template (member)

Delete a WWABA message template by name (member)

List LangGraph threads for a channel (admin only)

Delete LangGraph threads for a channel (admin only)

List pending messages for a channel (member)

Reprocess pending messages for a connected channel (admin only)

List chats for a channel from Evolution API (member)

Fetch messages for a chat (requires inbox:view permission)

Send a message to a chat (requires inbox:edit permission)

Validate QR link token and return channel info (public)

Fetch QR code image via token (public)

Check connection status for a QR link (public) — auto-marks used when connected

Mark QR link as used (internal auth only)

List CRM pipelines for an org (member)

Create a CRM pipeline (admin only)

Get a CRM pipeline with phases and fields (member)

Update a CRM pipeline (admin only)

Delete a CRM pipeline (admin only)

Sync CRM pipeline — import all existing cards as CrmLeads (admin only)

Discover pipeline schema from provider — upsert phases and fields (admin only)

Get CRM KPIs for a pipeline (member or internal auth) — Redis SWR cached

CRM KPIs segmented by actor (AI vs human)

Get a CRM phase with its fields (member)

Update a CRM phase config — agentName, internalStatus, webhookTemplateId (admin only)

Delete a CRM phase (admin only)

Get follow-up rule for a phase (member)

Delete follow-up rule for a phase (admin only)

Upsert follow-up rule for a phase (admin only)

List follow-up events for a lead (member)

Pause follow-up for a lead (admin only)

Resume follow-up for a lead (admin only)

LGPD hard delete — permanently remove a lead and all associated data (admin only)

List campaigns with pagination (member)

Create a campaign in DRAFT status (admin only)

Get campaign detail with message counters by status (member)

Update a campaign (admin only)

Delete a campaign (admin only)

Launch a campaign — apply filters, create CampaignMessages, set RUNNING (admin only)

Preview matching leads for campaign filters — returns count + 5 samples (member)

Send a test message to a single phone number (admin only)

Import leads from CSV and create CampaignMessages (admin only)

Get dashboard metrics — leads by phase, creation counts, recent transitions (requires dashboard:view)

Get lead detail with field values and history (requires contacts:view)

Update lead contact info (requires contacts:edit)

List leads in funnel view with filters and pagination (requires funnel:view)

Move a lead to another phase in the funnel (requires funnel:edit)

List support sessions with filters and pagination (member)

Get support session detail with channel, contact, and lead info (member)

Get support metrics — activeSessions, avgCsat, csatCount, recentEscalations (member)

Get escalation config for an agent (admin only)

Create or update escalation config for an agent (admin only)

List available MCP integrations (proxied from MCP server)

List dynamic (OpenAPI-based) integrations for an org (admin only)

Create a dynamic integration from an OpenAPI spec (admin only)

Get a dynamic integration with its tools (admin only)

Update a dynamic integration (admin only)

Delete a dynamic integration and its tools (admin only)

Toggle enabled/disabled status for a set of tools (admin only)

Re-sync tools from the stored OpenAPI spec (admin only)

Parse an OpenAPI spec preview without persisting (admin only)

List GraphQL integrations for an org (admin only)

Create a GraphQL integration (admin only)

Get GraphQL integration details with entity tree (admin only)

Delete a GraphQL integration and all entities/scopes (admin only)

Trigger GraphQL schema discovery using stored credentials (admin only)

List agent scopes for a GraphQL integration (admin only)

Upsert an agent scope for a GraphQL integration (admin only)

Delete a specific agent scope (admin only)

Resolve merged guardrail rules for org/agent (MCP internal auth)

Health check — PostgreSQL and Redis connectivity (public)

Proxy GET request to RAG server

Proxy POST request to RAG server

Proxy PATCH request to RAG server

Proxy DELETE request to RAG server

Proxy PUT request to RAG server

Proxy GET to LangGraph deployment (NEXT_PUBLIC_USE_LANGSMITH_AUTH)

Proxy POST to LangGraph deployment

Get or create default assistants for a LangGraph deployment (Bearer pass-through)

List available LLM providers (based on configured API keys)

List models for a specific LLM provider

List Langfuse prompts

Create a Langfuse prompt

Get a Langfuse prompt by name

Update a Langfuse prompt by name

List Langfuse traces filtered by org/agent

Get Langfuse trace detail with observations

Proxy GET request to MCP server

Proxy POST request to MCP server (SSE streaming supported)