Reference
API reference
Core API endpoints reachable with an API key: method, path, permission, parameters, request body and responses.
This reference is generated from the Core API OpenAPI document. Only endpoints a tenant API key can call are listed; widget, authentication, platform and service-to-service endpoints are left out.
https://api.2people.chat/api/v1/…
Authorization: Bearer tpk_…
X-Tenant-Id: <tenant id>#Conversations19
GET/api/v1/conversationsUnified inbox (views: mine, unassigned, open, closed, all)
Loading…
GET/api/v1/conversations/{id}
Loading…
GET/api/v1/conversations/{id}/messagesMessages after a sequence (replay cursor)
Loading…
POST/api/v1/conversations/{id}/messagesReply; claims an unowned conversation atomically
Loading…
GET/api/v1/conversations/{id}/transcriptConversation as a text/JSON file (audited)
Loading…
POST/api/v1/conversations/{id}/receipts
Loading…
POST/api/v1/conversations/{id}/assignAssign to self (or another agent with conversations:manage)
Loading…
POST/api/v1/conversations/{id}/transferTransfer to another agent (owner or supervisor)
Loading…
POST/api/v1/conversations/{id}/close
Loading…
POST/api/v1/conversations/{id}/reopen
Loading…
POST/api/v1/conversations/{id}/ai/pauseStop the AI on this conversation; it waits for a human
Loading…
POST/api/v1/conversations/{id}/ai/resumeHand the conversation (back) to the AI agent deployed on its website
Loading…
GET/api/v1/conversations/{id}/notesInternal notes (never visible to visitors)
Loading…
POST/api/v1/conversations/{id}/notes
Loading…
POST/api/v1/conversations/{id}/tagsReplace the tag set
Loading…
POST/api/v1/conversations/{id}/attachmentsUpload a file (multipart field "file")
Loading…
GET/api/v1/conversations/{id}/attachments/{attachmentId}
Loading…
PUT/api/v1/conversations/{id}/departmentMoves the conversation to a department (re-routes it if waiting)
Loading…
GET/api/v1/agentsAgents in the tenant (transfer targets)
Loading…
#Saved replies5
GET/api/v1/macrosShared macros and the caller's own
Loading…
POST/api/v1/macros
Loading…
PATCH/api/v1/macros/{id}
Loading…
DELETE/api/v1/macros/{id}
Loading…
POST/api/v1/macros/{id}/usedCounts a use (popularity order)
Loading…
#Visitors5
GET/api/v1/visitors/liveVisitors online now (Redis presence); push updates arrive as visitor.presence events
Loading…
GET/api/v1/visitors/analyticsTraffic analytics: totals, time series, geo, sources, devices, pages, triggers
Loading…
GET/api/v1/visitors/{id}Presence, analytics profile, linked players
Loading…
GET/api/v1/visitors/{id}/journeyJourney timeline (newest first, cursor pagination)
Loading…
GET/api/v1/visitors/{id}/conversations
Loading…
#Brands & websites7
GET/api/v1/brands
Loading…
POST/api/v1/brands
Loading…
GET/api/v1/websites
Loading…
POST/api/v1/websitesRegister a website and generate its widget key
Loading…
GET/api/v1/websites/{id}/widget-settingsWidget settings (widget-settings.v1)
Loading…
PUT/api/v1/websites/{id}/widget-settingsReplace the widget settings; validated against widget-settings.v1
Loading…
GET/api/v1/websites/{id}/identity-secretReveal the player identity signing secret (audited)
Loading…
#Tenant2
GET/api/v1/tenants/{id}Get a tenant
Loading…
PATCH/api/v1/tenants/{id}Update tenant name/settings (status: platform admins only)
Loading…
#Proactive triggers4
GET/api/v1/proactive-triggers
Loading…
POST/api/v1/proactive-triggers
Loading…
PATCH/api/v1/proactive-triggers/{id}
Loading…
DELETE/api/v1/proactive-triggers/{id}
Loading…
#Privacy3
GET/api/v1/privacy/telemetry-policyTenant telemetry and retention policy
Loading…
PUT/api/v1/privacy/telemetry-policyReplace the telemetry policy (audited; shorter retention also applies to stored rows)
Loading…
DELETE/api/v1/visitors/{id}/analyticsErase a visitor's analytics events and live presence (audited)
Loading…
#AI agents11
GET/api/v1/ai/toolsTyped tool registry
Loading…
GET/api/v1/ai/agents
Loading…
POST/api/v1/ai/agentsCreates the agent with a draft v1
Loading…
GET/api/v1/ai/agents/{id}
Loading…
PATCH/api/v1/ai/agents/{id}
Loading…
GET/api/v1/ai/agents/{id}/versionsPrompt/config versions
Loading…
GET/api/v1/ai/agents/{id}/versions/{versionId}
Loading…
PUT/api/v1/ai/agents/{id}/draft
Loading…
POST/api/v1/ai/agents/{id}/publish
Loading…
PUT/api/v1/ai/agents/{id}/websites
Loading…
POST/api/v1/ai/simulationsRuns the full AI pipeline without persisting messages (Simulation Lab)
Loading…
#Knowledge bases10
GET/api/v1/knowledge-bases
Loading…
POST/api/v1/knowledge-bases
Loading…
GET/api/v1/knowledge-bases/{id}
Loading…
PATCH/api/v1/knowledge-bases/{id}
Loading…
POST/api/v1/knowledge-bases/{id}/documentsUpload txt/md/html/pdf (indexed asynchronously; same title = new version)
Loading…
POST/api/v1/knowledge-bases/{id}/documents/text
Loading…
DELETE/api/v1/knowledge-bases/{id}/documents/{documentId}
Loading…
GET/api/v1/knowledge-bases/{id}/documents/{documentId}/chunks
Loading…
POST/api/v1/knowledge-bases/{id}/publish
Loading…
POST/api/v1/knowledge-bases/{id}/searchTest retrieval: hybrid search + rerank, as the AI would see it
Loading…
#AI runs & evaluations11
GET/api/v1/ai/runs
Loading…
GET/api/v1/ai/runs/{id}
Loading…
GET/api/v1/ai/metricsAI cost & latency report
Loading…
GET/api/v1/ai/evaluation-suites
Loading…
POST/api/v1/ai/evaluation-suites
Loading…
POST/api/v1/ai/evaluation-suites/platformCreate or refresh the platform regression suite for this tenant
Loading…
PATCH/api/v1/ai/evaluation-suites/{id}
Loading…
DELETE/api/v1/ai/evaluation-suites/{id}
Loading…
POST/api/v1/ai/evaluations/runQueues a suite run against an agent version (real models)
Loading…
GET/api/v1/ai/evaluations
Loading…
GET/api/v1/ai/evaluations/{id}
Loading…
#AI models2
GET/api/v1/ai/modelsActive models tenants can choose from
Loading…
GET/api/v1/ai/inference/statusHealth, queue depth, KV cache usage and throughput per inference endpoint
Loading…
#Integrations17
GET/api/v1/integrations
Loading…
POST/api/v1/integrations
Loading…
GET/api/v1/integrations/{id}
Loading…
PATCH/api/v1/integrations/{id}Rename or approve outbound hosts
Loading…
GET/api/v1/integrations/{id}/specs
Loading…
POST/api/v1/integrations/{id}/specsUpload an OpenAPI 3.x / Swagger 2.0 / Postman v2.1 document (≤5 MB)
Loading…
POST/api/v1/integrations/{id}/suggestAI mapping suggestion from an uploaded document; becomes the draft for review
Loading…
GET/api/v1/integrations/{id}/versions
Loading…
PUT/api/v1/integrations/{id}/draft
Loading…
PUT/api/v1/integrations/{id}/credentialsSealed for the connector runtime; values are never returned
Loading…
GET/api/v1/integrations/{id}/conformance
Loading…
POST/api/v1/integrations/{id}/conformanceRuns the conformance suite against the operator sandbox (grants a test bonus)
Loading…
POST/api/v1/integrations/{id}/publish
Loading…
PUT/api/v1/integrations/{id}/capabilities
Loading…
POST/api/v1/integrations/{id}/activate
Loading…
POST/api/v1/integrations/{id}/disable
Loading…
POST/api/v1/integrations/{id}/testTry a read operation live
Loading…
#Actions & bonuses12
GET/api/v1/actions
Loading…
POST/api/v1/actionsStaff-initiated bonus request (same policy as AI)
Loading…
GET/api/v1/actions/{id}Action with its transition log
Loading…
POST/api/v1/actions/{id}/approve
Loading…
POST/api/v1/actions/{id}/reject
Loading…
GET/api/v1/conversations/{id}/playerVerified player panel: live provider data for the signed-in player
Loading…
GET/api/v1/conversations/{id}/campaignsCampaigns staff can offer in this conversation (its brand, enabled, active now)
Loading…
GET/api/v1/bonus-campaigns
Loading…
POST/api/v1/bonus-campaigns
Loading…
PATCH/api/v1/bonus-campaigns/{id}
Loading…
GET/api/v1/action-policy
Loading…
PUT/api/v1/action-policy
Loading…
#Deposit methods4
GET/api/v1/payment-methods
Loading…
POST/api/v1/payment-methods
Loading…
PATCH/api/v1/payment-methods/{id}
Loading…
DELETE/api/v1/payment-methods/{id}
Loading…
#Routing3
GET/api/v1/routing/queueConversations waiting for a human, open offers and agent routability
Loading…
GET/api/v1/routing/settings
Loading…
PUT/api/v1/routing/settings
Loading…
#Telegram10
GET/api/v1/telegram/statusBridge health and bot connections
Loading…
GET/api/v1/telegram/connections
Loading…
POST/api/v1/telegram/connectionsConnect a bot: the token is verified (getMe) and sealed for the bridge
Loading…
PATCH/api/v1/telegram/connections/{id}Rename, disable/enable, rotate token
Loading…
POST/api/v1/telegram/groups/linkOne-time startgroup link (30 min) that makes a forum group the staff group
Loading…
POST/api/v1/telegram/groups/{id}/checkRe-read forum flag and bot rights
Loading…
DELETE/api/v1/telegram/groups/{id}
Loading…
GET/api/v1/telegram/linksAgents linked to the bot
Loading…
DELETE/api/v1/telegram/links/{id}
Loading…
GET/api/v1/telegram/logsOutbound deliveries and inbound commands/messages, newest first
Loading…
#Webhooks9
GET/api/v1/webhooks/eventsEvents that can be subscribed to
Loading…
GET/api/v1/webhooks
Loading…
POST/api/v1/webhooksAdd an endpoint; the signing secret is returned only once
Loading…
PATCH/api/v1/webhooks/{id}
Loading…
DELETE/api/v1/webhooks/{id}
Loading…
POST/api/v1/webhooks/{id}/rotate-secretNew signing secret (shown once)
Loading…
POST/api/v1/webhooks/{id}/testSend a webhook.test event now
Loading…
GET/api/v1/webhooks/{id}/deliveries
Loading…
POST/api/v1/webhooks/deliveries/{deliveryId}/retrySend a delivery now (a failed one is reopened)
Loading…
#Analytics9
GET/api/v1/analytics/overviewKPIs of a period vs the previous one
Loading…
GET/api/v1/analytics/conversations
Loading…
GET/api/v1/analytics/agents
Loading…
GET/api/v1/analytics/csat
Loading…
GET/api/v1/analytics/csat/comments
Loading…
GET/api/v1/analytics/actionsBonus actions and deposit links
Loading…
GET/api/v1/analytics/liveQueue, active chats and staffing right now
Loading…
GET/api/v1/analytics/export/conversations.csv
Loading…
GET/api/v1/analytics/export/agents.csv
Loading…
#Operations, privacy & usage17
GET/api/v1/operations/healthOperator API, AI, Telegram and queue health from operational data
Loading…
POST/api/v1/operations/evaluateEvaluate the incident rules now (normally every minute)
Loading…
GET/api/v1/operations/settingsIncident thresholds
Loading…
PUT/api/v1/operations/settingsReplace the incident thresholds (audited)
Loading…
GET/api/v1/integrations/{id}/callsOperator API call log (outcome and latency; no inputs or results)
Loading…
GET/api/v1/incidents
Loading…
GET/api/v1/incidents/{id}Incident with its timeline
Loading…
POST/api/v1/incidents/{id}/acknowledge
Loading…
POST/api/v1/incidents/{id}/resolveResolve by hand; if the condition persists the evaluator opens a new incident
Loading…
POST/api/v1/incidents/{id}/notes
Loading…
GET/api/v1/privacy/retentionConversation retention
Loading…
PUT/api/v1/privacy/retentionSet conversation retention; closed conversations past it are anonymised (audited)
Loading…
POST/api/v1/visitors/{id}/eraseErase a visitor: anonymise all their conversations, delete files, browser details and analytics (audited)
Loading…
GET/api/v1/usageUsage for a UTC calendar month, with an estimate when prices are set
Loading…
GET/api/v1/usage/historyUsage of the last N months
Loading…
GET/api/v1/usage/export.csvMonthly usage as CSV
Loading…
GET/api/v1/billing/pricesPrices set by the platform (null if none)
Loading…
#Team, roles & audit12
GET/api/v1/members
Loading…
GET/api/v1/permissions
Loading…
GET/api/v1/roles
Loading…
GET/api/v1/departments
Loading…
GET/api/v1/business-hours
Loading…
PUT/api/v1/business-hours
Loading…
GET/api/v1/audit-logs
Loading…
GET/api/v1/audit-logs/verifyRecomputes the tenant hash chain
Loading…
GET/api/v1/api-keys
Loading…
POST/api/v1/api-keysThe secret is returned once
Loading…
GET/api/v1/api-keys/scopes
Loading…
DELETE/api/v1/api-keys/{id}
Loading…
#Schemas210
ActionActorDto
Loading…
ActionCampaignRefDto
Loading…
ActionDetailDto
Loading…
ActionDto
Loading…
ActionEventDto
Loading…
ActionPageDto
Loading…
ActionsAnalyticsDto
Loading…
ActionStatusRowDto
Loading…
AgentDto
Loading…
AgentPerformanceDto
Loading…
AgentRefDto
Loading…
AgentWebsitesDto
Loading…
AiAgentDto
Loading…
AiAgentVersionDto
Loading…
AiAgentVersionRefDto
Loading…
AiHealthDto
Loading…
AiMetricsBucketDto
Loading…
AiMetricsCountDto
Loading…
AiMetricsDto
Loading…
AiMetricsModelDto
Loading…
AiMetricsTotalsDto
Loading…
AiModelDto
Loading…
AiModelHealthDto
Loading…
AiRunDetailDto
Loading…
AiRunDto
Loading…
AiRunPageDto
Loading…
AiToolDto
Loading…
AnalyticsTotalsDto
Loading…
ApiKeyDto
Loading…
AssignDto
Loading…
AttachmentDto
Loading…
AuditLogDto
Loading…
AuditLogPageDto
Loading…
AuditVerifyDto
Loading…
BillingPricesDto
Loading…
BrandDto
Loading…
BreakdownRowDto
Loading…
BusinessHoursDto
Loading…
BusinessHoursInputDto
Loading…
CampaignDto
Loading…
CapabilitiesDto
Loading…
ConformanceInputDto
Loading…
ConformanceRunDto
Loading…
ConnectorVersionDto
Loading…
ConversationAnalyticsDto
Loading…
ConversationBreakdownDto
Loading…
ConversationBucketDto
Loading…
ConversationDto
Loading…
ConversationPageDto
Loading…
ConversationRatingDto
Loading…
CreateActionDto
Loading…
CreateAiAgentDto
Loading…
CreateApiKeyDto
Loading…
CreateBrandDto
Loading…
CreateCampaignDto
Loading…
CreatedApiKeyDto
Loading…
CreateEvalSuiteDto
Loading…
CreateIntegrationDto
Loading…
CreateKnowledgeBaseDto
Loading…
CreateMacroDto
Loading…
CreatePaymentMethodDto
Loading…
CreateTriggerDto
Loading…
CreateWebhookDto
Loading…
CreateWebsiteDto
Loading…
CredentialsInputDto
Loading…
CredentialsSummaryDto
Loading…
CsatBucketDto
Loading…
CsatCommentDto
Loading…
CsatCommentPageDto
Loading…
CsatReportDto
Loading…
CsatSplitDto
Loading…
DecisionNoteDto
Loading…
DepartmentDto
Loading…
DepartmentRefDto
Loading…
DepositLinkCardDto
Loading…
DepositLinkRowDto
Loading…
EraseResultDto
Loading…
EstimateDto
Loading…
EstimateLineDto
Loading…
EvalRunDetailDto
Loading…
EvalRunDto
Loading…
EvalSuiteDto
Loading…
GroupLinkInputDto
Loading…
IncidentDetailDto
Loading…
IncidentDto
Loading…
IncidentEventDto
Loading…
IncidentNoteDto
Loading…
IncidentNoteRequiredDto
Loading…
IncidentPageDto
Loading…
InferenceEndpointDto
Loading…
InferenceStatusDto
Loading…
InferenceStatusEndpointDto
Loading…
IntegrationCallDto
Loading…
IntegrationCallPageDto
Loading…
IntegrationDto
Loading…
IntegrationHealthDto
Loading…
IntegrationLastErrorDto
Loading…
JourneyEventDto
Loading…
JourneyPageDto
Loading…
KnowledgeBaseDetailDto
Loading…
KnowledgeBaseDto
Loading…
KnowledgeChunkDto
Loading…
KnowledgeDocumentDto
Loading…
KnowledgeSearchDto
Loading…
KnowledgeSearchHitDto
Loading…
KnowledgeSearchResultDto
Loading…
KpiDto
Loading…
LinkedPlayerDto
Loading…
LiveConversationRefDto
Loading…
LiveDepartmentDto
Loading…
LiveDto
Loading…
LiveVisitorDto
Loading…
LiveVisitorsDto
Loading…
MacroDto
Loading…
MacroInputDto
Loading…
MemberDto
Loading…
MessageDto
Loading…
MessagePageDto
Loading…
MoneyDto
Loading…
NoteDto
Loading…
NoteInputDto
Loading…
OfferDto
Loading…
OperationsHealthDto
Loading…
OperationsSettingsDto
Loading…
OperationsSettingsInputDto
Loading…
OverviewDto
Loading…
PaymentMethodDto
Loading…
PercentilesDto
Loading…
PermissionDto
Loading…
PlayerPanelDto
Loading…
PlayerRefDto
Loading…
PlayerSectionDto
Loading…
PlayerSectionsDto
Loading…
PolicyDto
Loading…
PolicyInputDto
Loading…
PresenceDto
Loading…
ProblemStructured error body (RFC 9457 problem details) returned by every HTTP service.
Loading…
PublishConnectorDto
Loading…
PublishDto
Loading…
QueueAgentDto
Loading…
QueueHealthDto
Loading…
QueueItemDto
Loading…
ReceiptDto
Loading…
ReceiptStateDto
Loading…
RetentionPolicyDto
Loading…
RetentionPolicyInputDto
Loading…
RoleDto
Loading…
RoleRefDto
Loading…
RoutingQueueDto
Loading…
RoutingSettingsDto
Loading…
RoutingSettingsInputDto
Loading…
RunConformanceDto
Loading…
RunEvaluationDto
Loading…
SaveConnectorDraftDto
Loading…
SaveDraftDto
Loading…
SendMessageDto
Loading…
SetDepartmentDto
Loading…
SimulationMessageDto
Loading…
SimulationPlayerDto
Loading…
SimulationRequestDto
Loading…
SimulationResultDto
Loading…
SpecDocumentDto
Loading…
SuggestDto
Loading…
SuggestResultDto
Loading…
TagsInputDto
Loading…
TelegramConnectionDto
Loading…
TelegramConnectionHealthDto
Loading…
TelegramConnectionInputDto
Loading…
TelegramConnectionPatchDto
Loading…
TelegramGroupDto
Loading…
TelegramGroupLinkDto
Loading…
TelegramHealthDto
Loading…
TelegramLinkDto
Loading…
TelegramLogItemDto
Loading…
TelegramLogPageDto
Loading…
TelegramStatusDto
Loading…
TelemetryPolicyDto
Loading…
TenantDto
Loading…
TestOperationDto
Loading…
TestOperationResultDto
Loading…
TextDocumentDto
Loading…
TimeBucketDto
Loading…
TopPageDto
Loading…
TransferDto
Loading…
TriggerDto
Loading…
TriggerStatsDto
Loading…
UpdateAiAgentDto
Loading…
UpdateCampaignDto
Loading…
UpdateEvalSuiteDto
Loading…
UpdateIntegrationDto
Loading…
UpdateKnowledgeBaseDto
Loading…
UpdatePaymentMethodDto
Loading…
UpdateTenantDto
Loading…
UpdateTriggerDto
Loading…
UpdateWebhookDto
Loading…
UsageDto
Loading…
UsageHistoryDto
Loading…
UsageHistoryItemDto
Loading…
UsageMetricDto
Loading…
VisitorAnalyticsDto
Loading…
VisitorDetailDto
Loading…
VisitorErasureDto
Loading…
VisitorProfileDto
Loading…
WebhookCreatedDto
Loading…
WebhookDeliveryDto
Loading…
WebhookDeliveryPageDto
Loading…
WebhookDto
Loading…
WebhookSecretDto
Loading…
WebsiteDto
Loading…
WebsiteSecretDto
Loading…