Contract.fit API

api:contract-p.fit · v1.0 · source: apis.guru

This OpenAPI describes the API exposed by the contract.fit backend. Security Authentication All endpoints are protected: you need to make authenticated calls. There are 3 authentication mechanisms: - HTTP Basic (Username + Password) - JWT Token - API-Key By default you should have an account allowing you to bootstrap your tenant and create users and roles, using Basic Auth or after creating a Token - see /auth endpoints. If you are missing credentials or permissions, please contact us. Authorization The security system is RBAC based: users must be granted scoped roles, allowing them to access resources. Each role grants a defined set of permissions, which can be restricted to a given inbox or document - see /roles endpoints. Upload and Processing Below is a short description of common use cases of the API. Simple Upload The easiest and simplest way to get started is to use POST /documents : it will make a synchronous upload of your file and wait for the result. This is a simplified version of POST /documents/{inbox id} with less arguments and settings; it may not be suitable for real workload as it offers less capabilities. Upload to Inbox The favored endpoint to upload files is POST /documents/{inbox id}: it is also highly recommended to make async call using sync=false. Sync / Async For convenience uploads can be synchronous: it will make the request blocks until the document is processed. It is however discouraged to rely on sync requests, as our service is designed to pro

[![Connect-MCP](https://clawy.uk/mcp/badge/api%3Acontract-p.fit.svg)](https://clawy.uk/mcp/s/api%3Acontract-p.fit)