API reference
Methods of the public API. The full machine-readable OpenAPI 3.1 specification is available for download; there is no "try it" here: integration keys are never entered on the page.
Base URLs
Three independent cells. A key works only in the cell it was issued in; otherwise wrong_cell is returned.
| Cell ID | https://wfacademy.id/api/public/v1 |
Authorization
Header Authorization: Bearer <key>. HTTPS only.
Methods
No method matches the filter.
Account 4
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /me | Who am I | — | Available |
| PUT | /me/encryption-key | Public key for the JWE format | webhooks:manage | Available |
| GET | /wallet | Wallet and exchange state | — | Available |
| GET | /operations/{id} | Get an operation | — | Available |
Conversations 5
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /conversations | List conversations | conversations:read | Available PII |
| POST | /conversations | Find or create a conversation | conversations:write | Available PII |
| GET | /conversations/{id} | Get a conversation | conversations:read | Available PII |
| GET | /conversations/{id}/messages | Conversation messages | conversations:read | Available PII |
| POST | /conversations/{id}/messages | Customer message and AI reply | conversations:write | Available PII |
Analytics 4
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /analytics/timeseries | Time series | analytics:read | Available |
| GET | /analytics/traffic-sources | Traffic sources | analytics:read | Available |
| GET | /analytics/funnel | Funnel | analytics:read | Available |
| GET | /analytics/visibility | Visibility | analytics:read | Available |
Dashboards 2
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /dashboards/overview | The Overview dashboard | dashboards:read | Available |
| GET | /dashboards/pulse | The Pulse dashboard | dashboards:read | Available |
Leads 2
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /leads | List leads | leads:read | Available PII |
| GET | /leads/{id} | Get a lead | leads:read | Available PII |
Articles 2
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /articles | List articles | articles:read | Available |
| GET | /articles/{id} | Get an article | articles:read | Available |
Strategist 6
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /strategist/reports | List strategist reports | strategist:read | Available |
| GET | /strategist/reports/{id} | Get a strategist report | strategist:read | Available |
| GET | /strategist/topics | List topics | strategist:read | Available |
| GET | /strategist/topics/{id} | Get a topic | strategist:read | Available |
| GET | /strategist/actions | List strategist actions of your sessions | strategist:read | Available |
| GET | /strategist/actions/{id} | Get a strategist action | strategist:read | Available |
Webhooks 8
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /webhooks | List subscriptions | webhooks:manage | Available |
| POST | /webhooks | Create a subscription | webhooks:manage | Available |
| GET | /webhooks/{id} | Get a subscription | webhooks:manage | Available |
| PATCH | /webhooks/{id} | Update a subscription | webhooks:manage | Available |
| DELETE | /webhooks/{id} | Delete a subscription | webhooks:manage | Available |
| POST | /webhooks/{id}/test | Send a test event | webhooks:manage | Available |
| GET | /webhooks/{id}/deliveries | Delivery log | webhooks:manage | Available |
| GET | /.well-known/jwks.json | Webhook signing public keys | — | Available |
Channels 2
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /channels/{id}/widget | Get chat widget settings | channels:read | Available |
| PATCH | /channels/{id}/widget | Update chat widget settings | channels:write | Available |
Product cards 6
| Method | Path | Description | Scopes | Status |
|---|---|---|---|---|
| GET | /cards | List cards | cards:read | Available |
| POST | /cards | Create a card | cards:write | Available |
| GET | /cards/{code} | Get a card | cards:read | Available |
| PATCH | /cards/{code} | Update a card | cards:write | Available |
| DELETE | /cards/{code} | Delete a card | cards:write | Available |
| POST | /conversations/{id}/cards | Send cards to a conversation | conversations:write | Available PII |