# amfionhq-com Tenants API

**Canonical:** https://apis.io/apis/amfionhq-com/amfionhq-com-tenants-api/  
**Provider:** amfionhq-com — https://apis.io/providers/amfionhq-com/  
**Base URL:** https://api.amfionhq.com/v1/partner  
**Documentation:** https://amfionhq.com/docs

amfionhq-com Tenants API is one of 4 APIs that [amfionhq-com](https://apis.io/providers/amfionhq-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 3 JSON Schema definitions. Tagged areas include Tenants. The published artifact set on APIs.io includes an OpenAPI specification and 3 JSON Schemas.

The Tenants API from amfionhq-com — 30 operation(s) for tenants.

## Operations (36)

| Method | Path | Summary |
|---|---|---|
| POST | `/tenants` | Provision a partner tenant (idempotent via externalTenantId + Idempotency-Key) |
| GET | `/tenants` | List this partner's tenants |
| GET | `/tenants/{id}` | Full tenant detail: lifecycle, live catalog version/checksum, profile… |
| POST | `/tenants/{id}/terms-acceptance` | Attest the business representative's acceptance of the Terms for Amfion… |
| POST | `/tenants/{id}/pause` | Pause public chat (fail closed); catalog untouched |
| POST | `/tenants/{id}/resume` | Restore public chat exactly as configured |
| PATCH | `/tenants/{id}/profile` | Update business info (name, contact, address, hours, requirePhone) |
| PUT | `/tenants/{id}/services` | Replace partner-synced services (convenience; prefer atomic catalog) |
| PUT | `/tenants/{id}/faqs` | Replace partner-synced FAQs (convenience; prefer atomic catalog) |
| PUT | `/tenants/{id}/policies` | Upsert policy text |
| PUT | `/tenants/{id}/agent-config` | Set vertical / persona / custom instructions / answer policy / provider state |
| POST | `/tenants/{id}/catalog/validate` | Dry-run catalog compile: schema errors (JSON pointers), duplicate ids, trust… |
| PUT | `/tenants/{id}/catalog` | ATOMIC replace of services + FAQs + knowledge items + policies + agent config… |
| GET | `/tenants/{id}/catalog` | Knowledge inventory readback: every item with trust state, compiled answer… |
| GET | `/tenants/{id}/catalog/versions` | Applied catalog version history (checksums, counts) |
| POST | `/tenants/{id}/catalog/versions/{v}/restore` | Re-apply a stored version verbatim (becomes a new version) |
| POST | `/tenants/{id}/evals` | Start an eval run against the live catalog/policy (async, temperature 0… |
| GET | `/tenants/{id}/evals/{runId}` | Eval status + per-case structured results (envelope assertions) |
| GET | `/tenants/{id}/sessions` | Recent chat sessions (trace discovery) |
| GET | `/tenants/{id}/sessions/{sessionId}/trace` | Redacted conversation trace: messages, tool calls, per-answer envelopes… |
| GET | `/tenants/{id}/webhooks` | List webhook endpoints |
| POST | `/tenants/{id}/webhooks` | Create endpoint (signing secret returned ONCE) |
| PATCH | `/tenants/{id}/webhooks/{webhookId}` | Update url/events/active (reactivation resets failure count) |
| DELETE | `/tenants/{id}/webhooks/{webhookId}` | Delete endpoint |
| GET | `/tenants/{id}/webhooks/{webhookId}/deliveries` | Last 50 deliveries (status, attempts, errors) |
| POST | `/tenants/{id}/webhooks/{webhookId}/deliveries/{deliveryId}/redrive` | Re-enqueue a failed/stuck delivery (safe — delivered rows are skipped) |
| POST | `/tenants/{id}/webhooks/{webhookId}/rotate-secret` | New signing secret (returned ONCE); old secret co-signs for a 24h grace window |
| POST | `/tenants/{id}/webhooks/{webhookId}/test` | Synchronous signed test.ping fixture delivery |
| GET | `/tenants/{id}/knowledge-gaps` | Questions the agent could not answer (deduped, most-asked first; ?status=… |
| PATCH | `/tenants/{id}/knowledge-gaps/{gapId}` | Triage a gap (open / addressed / dismissed) |
| POST | `/tenants/{id}/reports` | Generate (or regenerate) a value report for a period |
| GET | `/tenants/{id}/reports` | List reports (metrics, no HTML) |
| GET | `/tenants/{id}/reports/{reportId}` | Full report incl. rendered HTML |
| GET | `/tenants/{id}/tools` | Tool enablements for a tenant |
| PUT | `/tenants/{id}/tools` | Replace a tenant's enablement set (with per-tenant config) |
| GET | `/tenants/{id}/usage` | Monthly usage: conversations, allowance, tokens, daily breakdown |

## Machine-readable artifacts (4)

- **OpenAPI** — https://artifacts.apis.io/amfionhq-com/openapi/amfionhq-com-tenants-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/amfionhq-com/json-schema/amfionhq-com-route-lead-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/amfionhq-com/json-schema/amfionhq-com-fleet-tenant-schema.json
- **JSONSchema** — https://artifacts.apis.io/amfionhq-com/json-schema/amfionhq-com-route-lead-response-schema.json

## Other amfionhq-com APIs (3)

- [amfionhq-com Fleet API](https://apis.io/apis/amfionhq-com/amfionhq-com-fleet-api/)
- [amfionhq-com Tools API](https://apis.io/apis/amfionhq-com/amfionhq-com-tools-api/)
- [amfionhq-com Usage API](https://apis.io/apis/amfionhq-com/amfionhq-com-usage-api/)

## Tags

Tenants

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/amfionhq-com/amfionhq-com-tenants-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/amfionhq-com/.