API Interaction Guide

For the authoritative schema, request models, and full endpoint list, use the interactive API documentation. For how the API is designed internally, see API Structure.

When to Use the API Directly

• scripted or batch access to structured research data
• connecting RELab records to notebooks or external tooling
• automating repetitive reference-data lookups
• building custom integrations on top of the platform

Authentication

• Browsers use cookies (POST /auth/cookie/login)
• Apps and scripts use bearer tokens (POST /auth/bearer/login)
• Refresh-token handling depends on the Redis-backed auth path (see Authentication)

!!! note “Public vs. authenticated routes” Public reference data (taxonomies, materials, product types) is accessible without authentication. Product records, images, and user data require a valid token.

Suggested First Steps

1. Open the live OpenAPI docs.
2. Identify whether the endpoint you need is public or requires authentication.
3. Start with a read-only request before attempting writes.
4. Inspect response models carefully, especially around linked entities and media.
5. Only automate writes once you understand how the product hierarchy is represented.

Integration Advice

• Build against the live OpenAPI schema rather than copying examples from old documentation.
• Treat uploads and image handling as first-class API operations, not afterthoughts.
• If you need a stable exported dataset rather than live application access, check the Dataset Documentation first.