HTTP API reference

Understand Organizational AI Memory HTTP API conventions before using the generated endpoint reference.

Organizational AI Memory publishes a generated reference from the repository's committed OpenAPI contract. The reference is useful for discovering paths, request shapes, and response schemas; the surrounding guides define the security and product semantics that the schema alone cannot express.

Treat the contract as deployment-scoped

Availability still depends on the enabled modules, your organization, and your permissions. A documented endpoint is not permission to access every resource it describes.

Before you integrate

  1. Read Authentication and errors for browser-session, CSRF, authorization, and error-handling expectations.
  2. Choose the endpoint group below.
  3. Confirm the operation against the exact Organizational AI Memory release you deploy.
  4. Exercise the flow in a non-production environment with a least-privilege identity.

Endpoint groups

  • Administration — identity, roles, permissions, and organization controls.
  • Sources and connections — source registration, credentials, crawl control, and access mapping.
  • Assets — governed assets, releases, delivery, and lifecycle operations.
  • Assistant — conversations and permission-aware assistant tools.
  • Knowledge graph — graph indexing, exploration, curation, and export.
  • Search and catalog — retrieval, catalog browsing, and citation content.
  • Platform — session, organization context, health, and visible spaces.

Generated-reference safety

The public schema replaces runtime server addresses with the reserved example.invalid domain and removes secret-bearing examples. The interactive playground is disabled. No production credential, private host, or deployment path is required to browse these pages.

Last updated on