Haufe Files API Docs

Haufe Files API documentation provides detailed information about the API endpoints, request and response formats, and authentication methods. It is designed to help developers integrate with the Haufe Files platform effectively.

The whole OpenApi specification can be found here.

API Key Modes

This API operates in two distinct modes based on the type of API key used:

Product Mode (General Usage)

Designed for Haufe Products leveraging BYOC (Bring Your Own Content) capabilities to manage customer content through Haufe Files.

• Non-Scoped API Keys:

  • Used by HaufeShop products (e.g., Copilots)
  • User and tenant management provided by Control Plane
  • Can access our UI if the IDs match those in Control Plane

• Scoped API Keys:

  • Used by products like HR Assistant or KaaS
  • Can only access data within their own scope
  • Automatically provisions tenants and users when needed
  • User and tenant IDs are prefixed with the scope (e.g., {scope}:{externalId})

Gen AI Mode

A specialized API key type for generative AI tools requiring access to uploaded data for LLM integration.

• Exclusive to HAI (Haufe AI)
• Can read data from all scopes with the appropriate IDs
• Limited action set (read-focused capabilities)
• Permissions and features will evolve as the product develops

Feel free to contact the following people in case you have any questions:

• Ioana Lefter (Product Owner)
• Pavel Khralovich (Tech Lead)
• Raul de San Clemente (Software Engineer)
• Alejandro Cano (Software Engineer)
• Giulia Mainiero (Software Engineer)