Skip to main content

Management API (v1)

The WizChat Management API is a programmatic control plane for your chatbots. It lets you manage chatbots, documents, website crawls, videos, knowledge scopes, MCP servers, skills, security settings, custom domains, deployments, analytics, and team members — and, with the config-as-code endpoints, treat an entire chatbot's configuration as a single versionable document.

  • Base URL: https://www.wizchat.com
  • Path prefix: /api/v1
  • Auth: a wpk_live_… Management API key sent as Authorization: Bearer …
  • Format: JSON request and response bodies
  • OpenAPI spec: /api/v1/openapi.json (OpenAPI 3.1)
info

This is a different surface from the older Legacy API guides. The Management API is the current, scoped, config-as-code control plane and is the one you should build against.

What you can do

AreaEndpoints
ChatbotsCreate, list, get, update, and delete chatbots
DocumentsIngest PDFs from a URL; list, get, delete, and manage document privacy / authorized emails; start, list, and detect drift for website crawls
VideosList, get, and delete uploaded videos
ScopesRead and update knowledge scopes
MCP ServersFull CRUD plus per-server access control
SkillsFull CRUD for agent skills
SecurityAccess protection, external-API config, access lists, telemetry
DomainsAuthorize, deauthorize, and verify custom domains
DeploymentRead deployment status and trigger a redeploy
AnalyticsRead cost and usage analytics
Config-as-codeExport an aggregate config document, then apply a desired state
TeamList the account owner's team members

The config-as-code workflow

The capstone of the API is a GitOps-style loop:

GET  /api/v1/chatbots/{id}/config   →  edit the document  →  POST /api/v1/chatbots/{id}/apply

apply supports a dry run (?dryRun=true) that returns the change plan without mutating anything, and prunes resources that are absent from your document by default. See Config-as-code.

SDKs

Both SDKs are generated from the same OpenAPI document, so they always match the deployed API.

Next steps