For AI agents and automation

This page is the entry point for AI agents and automated clients working with Pryv.io. Everything here is stable, machine-readable, and safe to fetch.

Machine-readable documentation

• llms.txt - a concise index of this documentation, following the llms.txt convention.
• llms-full.txt - a dense, single-file dump of the API reference (every method, its HTTP route and parameters) for context ingestion.

API definitions

• OpenAPI 3.0: api.yaml (hosted platforms), api_open.yaml (open-source), api_system.yaml, api_admin.yaml.
• Event types: flat.json (types['{class}/{format}']) and hierarchical.json (classes['{class}'].formats['{format}']). See the event types reference.

Discovering a platform at runtime

Every Pryv.io platform exposes a service info descriptor that a client should fetch first to learn the API endpoints, registration URL, supported event types and platform metadata:

GET https://reg.{domain}/service/info

The API reference documents the full surface. Each user account has its own root endpoint (https://{token}@{username}.{domain}/); see Get started and Concepts.

Authentication

Access is granted through accesses (scoped tokens), never raw credentials. An app requests an access via the auth flow and then calls the API with that token. See Custom authentication and the reference sections on authentication and access management.

Ground rules

• Prefer the OpenAPI definitions and flat.json over scraping HTML.
• Respect per-token rate expectations and the access scopes granted to you.
• The reference pages use stable in-page anchors (/reference/#method-ids), so deep links are safe to cite.