Back
DocsAgent API

Agent API

Run the Waslo agent from your own code: one REST endpoint for replies, plus knowledge base, catalogue, memory and calendar — no dashboard required.

Everything the dashboard does, your code can do too. The Agent API exposes the same engine that answers on WhatsApp and Instagram — the same knowledge base, the same per-customer memory, the same calendar and catalogue tools — as a REST API you can call from your own product.

Full reference and key management live in the developer portal.

When you'd use it

  • You already have an app or a website and want Waslo answering inside it, not on a channel.
  • You are an agency and want to run the agent for clients under your own brand.
  • You want the classification, memory or knowledge-base retrieval on their own, without the messaging layer.

If you just want an AI agent on WhatsApp or Instagram, you don't need this — connect the channel from Integrations instead.

One call

Send a message and a user id; get back a reply that already has memory, knowledge-base citations and tool actions applied.

curl https://api.waslo.io/v1/agent/reply \
  -H "Authorization: Bearer wsk_live_..." \
  -d '{
    "message": "Do you have a morning slot Thursday?",
    "userId": "customer_8842",
    "tools": ["calendar"]
  }'

The userId is yours to choose — it is how the agent remembers a person between calls. Reuse it and the conversation continues; change it and you get a fresh one.

What else the API covers

AreaWhat you can do
RepliesText, media (image, audio, video, PDF) and voice output
ClassificationScore a message HOT / WARM / COLD on its own
MemoryRead or delete what the agent remembers about a user
Knowledge baseUpload, list and delete documents — shared with the dashboard
CatalogueFull CRUD over products — shared with the dashboard
CalendarConnect Google Calendar or Cal.com without opening the dashboard
ConfigSet the system prompt and behaviour per request or persistently
UsageCredits consumed, current balance, spend cap

Anything you upload through the API shows up in the dashboard, and anything you add in the dashboard is visible to the API. It is one workspace, not two.

API keys

Keys are created in the developer portal and shown once — they are stored hashed, so we cannot recover one for you. Each key carries scopes (agent, memory, kb, catalog, config, usage), and a key can only do what its scopes allow. You can hold up to 10 active keys per organisation; revoke one at any time.

Treat a key like a password: server-side only, never in a browser bundle or a mobile app.

Credits and rate limits

The API always bills credits, on every plan — it is a separate product from your channel subscription, so a Growth subscription does not make API calls free. Rates are higher than channel replies because each call carries more work:

EventCredits
Text reply2
Reply that used a tool3
Reply that read media5
Voice output+2
Classification1

Developer plans set your rate limit and grant a monthly credit allowance on top of what you buy. Without a plan you fall back to the default per-minute and per-day limits. You can also set a monthly spend cap so a runaway loop cannot drain your balance — requests are refused with spend_cap_reached once you hit it.

Errors

Every error comes back in the same envelope, with a request_id worth quoting if you contact support.

CodeMeaning
400The request body failed validation
401Missing or invalid API key
402Not enough credits, or the spend cap is reached
403The key's scopes don't cover this endpoint
413Payload too large
429Rate limit — retry after the interval in the header

Pass an Idempotency-Key header on replies and a repeated call within 24 hours returns the original response instead of charging twice.

Your API users stay out of the operator inbox

Conversations created through the API belong to your app's users, not to the person watching the Waslo inbox — so they are hidden from the Leads and Inbox screens by default. Add ?includeApi=true when you want to see them.

White-label

On the White-label plan a master key can create isolated tenant workspaces, each with its own key, knowledge base and catalogue. The parent account pays for all usage and gets a per-tenant meter for re-billing; a tenant never sees the parent's balance. Tenants have no dashboard access by design — the API is their whole surface, including connecting a calendar.

Next steps

Related guides

Ready to get started?

75 free credits on signup — no card needed.

Get Started