Skip to main content
Recallio centralizes everything your team knows about a property, resident, or operation so assistants can answer questions with context. These guides walk through the pieces you need to connect your data sources to the Knowledge service.

​
What the Knowledge service does

  • Live data ingestion via /api/Knowledge/livedata keeps resident, listing, or asset records synced field-by-field.
  • Document ingestion turns PDFs and other uploads into searchable knowledge that surfaces in Recallio answers.
  • Environment separation lets you map data to projects (for example Home A, Home B, or Staging) so answers stay scoped to the right audience.
All Knowledge endpoints require a bearer token created from Dashboard → API Keys.

​
Before you call any endpoint

  1. Create or locate an API key in the dashboard under API Keys. The generated value is the bearer token you send in the Authorization header.
  2. Create projects for every environment in Settings → Projects. Each project exposes a ProjectId that you include with every payload to keep knowledge organized.
  3. Confirm consent requirements with your team. Each data submission should respect the ConsentFlag field when applicable.

​
Live data vs. documents

Use caseEndpointRequired fields
Structured operational data that changes frequentlyPOST https://app.recallio.ai/api/Knowledge/livedatatype, rawJson, optional userId, recommended projectId
Static or semi-structured reference material (PDF, policy guides, manuals)POST https://app.recallio.ai/api/Knowledge/documentFile, ProjectId, optional Tags, SourceUrl, ConsentFlag
Retrieve processed documents and metadataGET https://app.recallio.ai/api/Knowledge/documentOptional query parameters to filter by ProjectId, paging
  • Set the type field to a domain-specific label ("listing", "resident", "maintenance-ticket", etc.) so Recallio can group similar payloads.
  • Always include the projectId whenever the content belongs to a specific environment; omit it only for global knowledge.

​
Where to go next

Knowledge Quickstart

End-to-end walkthrough: generate an API key, create a project, and make your first /api/Knowledge/livedata request.

Implementation Deep Dive

Payload schemas, validation tips, and how to automate document uploads via API or the dashboard.
Need the full API surface? Review the Recallio Swagger reference.