convi
Book a demoGet started
CONVI FOR DEVELOPERS

Your frontend.
Our intelligence.

Build a custom shopping experience with the same assistant, semantic product search and attribution your Shopify theme gets.

Explore the APITalk about your build
Available on Premium and Enterprise · Server-side API
Your storefrontHydrogen · Next.js · Custom UI
Your serverSecure bearer authentication
Convi APIAssistant · Search · Events
THE BUILDING BLOCKS

A familiar assistant.
A flexible canvas.

Conversations

Create sessions, send messages and read threads. Get a complete JSON response or stream the reply with Server-Sent Events.

Product search

Use the same semantic catalog search that powers the widget’s recommendations in your own frontend.

Configuration

Read the assistant settings merchants already chose. Keep your custom experience connected to the Convi admin.

Attribution

Send add-to-cart and attribution events so custom storefront interactions stay connected to order analytics.
FIRST CONVERSATION

Three calls.
One helpful assistant.

Create a key in Convi under Settings → Developers, keep it on your server, and point these requests at your Convi host.

  1. 01

    Authenticate. Validate your key and check the store it belongs to.

  2. 02

    Start a session. Give the assistant the shopper’s page context.

  3. 03

    Send a message. Use the returned session id to continue the conversation.

Never expose your API key in browser code.

cURL · API v1
# Set your host and a server-side API key
export CONVI_API="https://your-convi-host"
export CONVI_KEY="cvi_sk_your_key_here"

# Confirm the key and its store
curl "$CONVI_API/api/v1/me/" \
  -H "Authorization: Bearer $CONVI_KEY"

Replace the example host, key and session id with your own values.

REFERENCE

Small surface.
Real possibilities.

The published v1 endpoints. Full request and response schemas ship with your Convi host.

Convi API v1 endpoints
MethodEndpointWhat it does
GET/api/v1/me/Validate a key and identify its store.
POST/api/v1/chat/sessions/Start a shopper conversation.
GET/api/v1/chat/sessions/{id}/Read a session and its messages.
POST/api/v1/chat/sessions/{id}/messages/Send a message and receive a reply.
POST/api/v1/search/Search your catalog semantically.
GET/api/v1/config/Read the assistant’s widget configuration.
POST/api/v1/events/add-to-cart/Report an add-to-cart event.
POST/api/v1/events/attribution/Connect an order attribution event.
KEYS WITH CARE

Built for your server.
Designed for control.

Explore security
  • Keys are shown once at creation and stored hashed. Replace a lost key rather than recovering it.
  • Up to five active keys per store let you rotate credentials without downtime.
  • Revocation takes effect on the next request. Keys stop working when the store uninstalls or is suspended.
  • Public surfaces have scoped rate limits, so one integration can’t exhaust another’s budget.
YOUR NEXT CHAPTER

Great conversations.
Extraordinary commerce.

Bring your store’s knowledge, care, and personality
to every customer conversation.

Start free on ShopifyLet’s talk
7-day trial · No credit card required