Search skmtc…
⌘K
Docs
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Generate
Filter operations
get
/api/status
Current service status: components, incidents and planned maintenance
post
/api/agents/fit
Fit assessment for a described business (vendor self-assessment, can say no)
post
/api/agents/quote
Monthly net quote for a plan with add-ons, each figure with its source
post
/api/agents/handoff
Prepare a single-use sign-up link for a person (no account or trial is created)
post
/api/agents/prepare-checkout
Prepare a purchase for a person: quote, contract versions, steps and the confirmation URL
post
/api/v1/api-key
Stillgelegt — Schlüssel entstehen im Dashboard
get
/api/v1/chatbots
List chatbots
post
/api/v1/chatbots
Create chatbot
get
/api/v1/chatbots/{id}
Get chatbot details
put
/api/v1/chatbots/{id}
Update chatbot
delete
/api/v1/chatbots/{id}
Delete chatbot
post
/api/v1/chatbots/{id}/chat
Send message to chatbot
get
/api/v1/chatbots/{id}/knowledge/sources
List the knowledge sources of a chatbot
post
/api/v1/chatbots/{id}/knowledge/sources
Add a knowledge source (file as base64, URL, text or FAQ)
get
/api/v1/chatbots/{id}/knowledge/sources/{sourceId}
Read a knowledge source (without its content)
delete
/api/v1/chatbots/{id}/knowledge/sources/{sourceId}
Delete a knowledge source
post
/api/v1/chatbots/{id}/knowledge/sources/{sourceId}/refresh
Refresh a URL source
post
/api/v1/chatbots/{id}/knowledge/crawl
Start a website crawl
get
/api/v1/chatbots/{id}/knowledge/crawl/{crawlId}
Read a crawl: its job and the discovered pages (id, status, depth; no URLs)
post
/api/v1/chatbots/{id}/knowledge/crawl/{crawlId}/confirm
Confirm a crawl and import its pages
get
/api/v1/jobs/{jobId}
Status of a long-running job (website crawl or source processing)
get
/api/v1/chatbots/{id}/leads
List leads for chatbot
delete
/api/v1/chatbots/{id}/leads/{leadId}
Delete a single lead
patch
/api/v1/chatbots/{id}/leads/{leadId}
Update lead status
get
/api/v1/chatbots/{id}/installation
Installation status of a chatbot: website conversations and origins
get
/api/v1/chatbots/{id}/diagnose
Diagnose why a chatbot does not answer
get
/api/v1/chatbots/{id}/branding
Branding of a chatbot: colors, Smartwebchat notice, legal links
patch
/api/v1/chatbots/{id}/branding
Change branding (partial update)
get
/api/v1/chatbots/{id}/custom-domain
Custom widget domain of a chatbot
put
/api/v1/chatbots/{id}/custom-domain
Set the custom widget domain
delete
/api/v1/chatbots/{id}/custom-domain
Remove the custom widget domain
post
/api/v1/chatbots/{id}/custom-domain/verify
Check the DNS record of the custom domain now
get
/api/v1/chatbots/{id}/webhooks
List the webhooks of a chatbot
post
/api/v1/chatbots/{id}/webhooks
Create a webhook
delete
/api/v1/chatbots/{id}/webhooks/{webhookId}
Delete a webhook
get
/api/v1/chatbots/{id}/embed
Embed snippet of a chatbot
get
/api/v1/chatbots/{id}/origins
Allowed origins of a chatbot
put
/api/v1/chatbots/{id}/origins
Replace the allowed origins
get
/api/v1/chatbots/{id}/conversations
List conversations grouped by session
get
/api/v1/bookings
List bookings (all chatbots of the authenticated user)
get
/api/v1/bookings/{id}
Get booking by ID
patch
/api/v1/bookings/{id}
Update booking status
get
/api/v1/events
List the events of the account (new lead, handover requested, credit threshold, missed payment)
get
/api/v1/orders
List the orders of the account (subscription, seats, assistants, credit)
get
/api/v1/orders/{id}
Get one order by its Digistore24 order id
get
/api/v1/billing
Usage, message quota and credit balance of the account
get
/api/v1/subscription
Subscription status of the account (read-only; changing or cancelling the plan is not available via this API)
get
/api/v1/team
Team members, pending invitations and seats
get
/api/v1/account
Company details of the account (read-only)
get
/api/v1/handover-requests
List handover requests for the authenticated user
get
/api/v1/handover-requests/{id}
Get handover request by ID
patch
/api/v1/handover-requests/{id}
Accept, resolve, or cancel a handover request
get
/api/v1/handover-settings/{chatbotId}
Get handover settings for a chatbot
put
/api/v1/handover-settings/{chatbotId}
Create or update handover settings for a chatbot
get
/api/v1/proactive-triggers
List proactive triggers for the authenticated user
post
/api/v1/proactive-triggers
Create a proactive trigger
get
/api/v1/proactive-triggers/{id}
Get a proactive trigger by ID
delete
/api/v1/proactive-triggers/{id}
Delete a proactive trigger
patch
/api/v1/proactive-triggers/{id}
Partially update a proactive trigger
Webhooks
post
lead.created
A chatbot captured a lead: a contact request, an appointment booking or a callback request. The event names the lead; read its contents with the leads endpoint of the chatbot.
post
handover.requested
A visitor asked for a person, or the chatbot handed the conversation over. The event names the request; read it with the handover requests endpoint.
post
quota.threshold
The account used a warning share of its monthly credit. Sent once per threshold and billing month. A person tops up the credit or changes the plan in the dashboard. In the feed it may disappear and reappear with the same id if the warning mail failed; deduplicate by id.
post
payment.failed
The payment provider reported a missed recurring payment. Access is not withdrawn by this event. A person updates the payment method with the payment provider. Repeated notifications for the same payment transaction within a short retry window are delivered once; a later failure of the same transaction is a new event. Without a transaction id a notification may be delivered more than once, then with different ids.
post
job.completed
A knowledge job finished: a website crawl or the processing of a knowledge source. Sent once per run; reading the same source again is a new run with a new event. Pages of a crawl are reported with the crawl.
post
job.failed
A knowledge job failed for good, after its retries. errorCode is a code from the error catalog. Sent once per run; a retry that later succeeds sends no failure.
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
List chatbots
get
/api/v1/chatbots
Request
Base URL:
https://smartwebchat.eu
URL:
https://smartwebchat.eu/api/v1/chatbots
Auth:
HTTP bearer
Response
Array of chatbots
Changes
No recorded changes to this operation across all 1 revision of this API.