Crisp Chat Crisp REST API
40
AI ReadinessFoundational (D-)40/100
Agent-ready OpenAPI document · curated by JenticCommunicationsChat Messagingbasic26 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Read and reply to Crisp conversations, route them to operators, and maintain people profiles and event data from outside the Crisp UI. Use it for support automation, lead routing, and CRM sync.
Use for: Send a reply into an open Crisp conversation, List the most recent conversations on my website, Assign a conversation to a specific operator, Mark a conversation as resolved
Not supported: Does not handle helpdesk ticketing, SLA management, or outbound email campaigns - use for Crisp websites, conversations, messaging, and people profiles only.
Jentic publishes the only available OpenAPI specification for Crisp REST API, keeping it validated and agent-ready. Crisp is a customer messaging platform that combines a website chat widget, shared inbox, and contact CRM. The v1 REST API exposes the same primitives the operator UI uses - websites, conversations, messages, people profiles, and an upload helper for attachments - so an external system can read the inbox, post replies, route conversations, and keep visitor profile data in sync.
Install Jentic One Beta
Connect the Crisp REST API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Crisp REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcrisp.chat%2Fcrisp" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcrisp.chat%2Fcrisp" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Crisp REST API.
Create, retrieve, and delete Crisp websites and update their settings
List operators on a website to find a target for routing or assignment
List, create, and delete conversations on a website and update their state and routing
Send messages into a conversation and update the compose (typing) indicator from a bot
Fetch and update conversation metadata for tagging or context-injection workflows
Manage people profiles, profile-level data, and the events stream attached to each person
Generate a signed upload URL through the bucket endpoint for attachments and media
Use Cases
Patterns agents use Crisp REST API for, with concrete tasks.
★ AI-assisted support replies
Let an LLM-powered assistant draft replies inside Crisp by listing open conversations with GET /website/{website_id}/conversations, reading the message thread with GET /website/{website_id}/conversation/{session_id}/messages, and posting the suggested reply with POST /website/{website_id}/conversation/{session_id}/message. Compose indicators give the human operator real-time feedback that the bot is composing.
List conversations in state 'pending', read the last 20 messages of each, draft a reply, set the compose indicator with PATCH /website/{website_id}/conversation/{session_id}/compose, and POST the message.
Conversation routing and triage
Route inbound conversations based on tags, language, or visitor data by combining GET /website/{website_id}/operators with PATCH /website/{website_id}/conversation/{session_id}/routing to assign the right operator. Conversation meta and state can be updated in the same workflow to mark priority or move the conversation to resolved.
On new conversation, fetch GET /website/{website_id}/operators, choose by skill tag, and call PATCH /website/{website_id}/conversation/{session_id}/routing with the chosen operator IDs.
Visitor profile and event sync
Keep Crisp's people profiles aligned with an external CRM by paging GET /website/{website_id}/people/profiles and writing back fields with PATCH /website/{website_id}/people/profile/{people_id} and event entries via the people events endpoint. This gives operators a richer picture of who is chatting with them.
On CRM update, find the matching profile via GET /website/{website_id}/people/profiles, then PATCH /website/{website_id}/people/profile/{people_id} and write an event via the people events endpoint.
Agent-driven shared inbox via Jentic
An LLM-orchestrated agent can act as a frontline responder for inbound chats, with Jentic mediating the Crisp credentials. The agent searches Jentic for a 'send a chat reply' operation, loads POST /website/{website_id}/conversation/{session_id}/message, and posts the reply while Jentic injects the basic-auth identifier and key.
Through Jentic, run search('send a Crisp chat message'), load POST /website/{website_id}/conversation/{session_id}/message, and post the reply with the resolved website_id and session_id.
Key Endpoints
26 endpoints — jentic publishes the only available openapi specification for crisp rest api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/website/{website_id}/conversations
List conversations on a website
GET
/website/{website_id}/conversation/{session_id}/messages
Read messages in a conversation
POST
/website/{website_id}/conversation/{session_id}/message
Send a message into a conversation
PATCH
/website/{website_id}/conversation/{session_id}/state
Change conversation state
PATCH
/website/{website_id}/conversation/{session_id}/routing
Assign conversation routing
GET
/website/{website_id}/people/profiles
List people profiles
PATCH
/website/{website_id}/people/profile/{people_id}
Update a people profile
POST
/bucket/url/upload
Generate a signed file upload URL
GET
/website/{website_id}/conversations
List conversations on a website
GET
/website/{website_id}/conversation/{session_id}/messages
Read messages in a conversation
POST
/website/{website_id}/conversation/{session_id}/message
Send a message into a conversation
PATCH
/website/{website_id}/conversation/{session_id}/state
Change conversation state
PATCH
/website/{website_id}/conversation/{session_id}/routing
Assign conversation routing
GET
/website/{website_id}/people/profiles
List people profiles
PATCH
/website/{website_id}/people/profile/{people_id}
Update a people profile
POST
/bucket/url/upload
Generate a signed file upload URL
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Crisp REST API
- Foundational (D-)40/100
81
Foundational Compliance63
Developer Experience & Jentic Compatibility50
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
81
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
98%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
25%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
50
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
43%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
58%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Crisp by hand means encoding its identifier and key pair for Basic auth and threading the website and session ids through every conversation call. Through Jentic you install once, import Crisp from the API Directory, store the credential pair once, and your agent calls it.
Permission scoping
Crisp puts the website id in the URL path (/website/{website_id}/...), so a rule can pin the agent to one Crisp website and nothing else. You choose the operations it may call, so changing conversation state or routing is not included unless you add those operations.
Credential isolation
Your Crisp identifier and key pair is stored once, encrypted, by your own Jentic One instance and applied as the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'send a Crisp chat message' or 'list Crisp conversations', and Jentic returns the matching Crisp operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Crisp REST API through Jentic.
Why is there no official OpenAPI spec for Crisp REST API?
Crisp documents its REST API in HTML reference pages but does not distribute a maintained OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Crisp REST API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the Crisp REST API use?
The API uses HTTP basic authentication. The username is your plugin or token identifier and the password is the matching key, both issued by Crisp. Through Jentic, the credential pair is stored encrypted in the vault and applied to every call to https://api.crisp.chat/v1 so it never appears in the agent's prompt.
Can I send a message into a Crisp conversation through the API?
Yes. POST /website/{website_id}/conversation/{session_id}/message posts a new message into an existing conversation. PATCH /website/{website_id}/conversation/{session_id}/compose updates the typing indicator while a reply is being composed.
How do I assign a Crisp conversation to a specific operator?
List operators with GET /website/{website_id}/operators, then PATCH /website/{website_id}/conversation/{session_id}/routing with the chosen operator IDs to assign the conversation.
What are the rate limits for the Crisp REST API?
The published OpenAPI spec does not declare numeric rate limits. Crisp enforces fair-use limits per plan, so check response headers and your plan's limits in the Crisp dashboard. Build retries with backoff around HTTP 429 responses, particularly on POST /website/{website_id}/conversation/{session_id}/message.
How do I send a Crisp reply through Jentic?
Install Jentic with pip install jentic, then async-search for 'send a Crisp chat message'. Jentic returns POST /website/{website_id}/conversation/{session_id}/message; load it and execute with the website_id, session_id, and reply body. Jentic attaches the basic-auth credentials from the vault automatically.
Can I limit what my agent is allowed to do with the Crisp REST API?
Yes. Because you run Jentic One yourself, your own rules decide which Crisp operations and credentials the agent can use. Since Crisp carries the website id in the URL path (/website/{website_id}/...), a rule can pin the agent to a single website and nothing else. You also pick the exact operations it may call, so sensitive actions like changing conversation state with PATCH /website/{website_id}/conversation/{session_id}/state or reassigning it with PATCH /website/{website_id}/conversation/{session_id}/routing stay out of reach unless you explicitly grant them.
GET STARTED