Reference
API basics
Find generated API schemas and make a workspace-scoped request.
Two kinds of documentation
These guides explain Factivum workflows. The API server generates an OpenAPI schema and interactive endpoint reference from the running backend. Use the API origin for your deployment; the website origin is not automatically the API origin.
- OpenAPI JSON is at /openapi.json on the API origin.
- Interactive Swagger reference is at /docs on the API origin.
- Workspace routes contain a workspace identifier and require the appropriate authenticated session or bearer token.
Make a first request
- Read the deployment's API origin from the developer portal or your operator configuration.
- Call the public health endpoint to confirm reachability; health alone does not prove a workspace action is ready.
- Use an authorized workspace ID and token for a read-only dataset or object request. Handle 401, 403, and 404 distinctly.
- Inspect response data and errors before building write operations. Do not put tokens into URLs, examples, or support messages.