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 asAuthorization: Bearer … - Format: JSON request and response bodies
- OpenAPI spec:
/api/v1/openapi.json(OpenAPI 3.1)
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
| Area | Endpoints |
|---|---|
| Chatbots | Create, list, get, update, and delete chatbots |
| Documents | Ingest PDFs from a URL; list, get, delete, and manage document privacy / authorized emails; start, list, and detect drift for website crawls |
| Videos | List, get, and delete uploaded videos |
| Scopes | Read and update knowledge scopes |
| MCP Servers | Full CRUD plus per-server access control |
| Skills | Full CRUD for agent skills |
| Security | Access protection, external-API config, access lists, telemetry |
| Domains | Authorize, deauthorize, and verify custom domains |
| Deployment | Read deployment status and trigger a redeploy |
| Analytics | Read cost and usage analytics |
| Config-as-code | Export an aggregate config document, then apply a desired state |
| Team | List 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.
- TypeScript —
@wizchat/management - Python —
wizchat-management
Next steps
- Quickstart — make your first call in under five minutes
- Authentication & scopes — keys, the bearer header, and the scope model
- Config-as-code — export, edit, dry-run, apply
- Errors & rate limits — error shape and status codes
- API Reference — every operation, with a "try it" console