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 acco
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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 crea
| method | path | what the vendor says it does |
|---|---|---|
POST | /auth | Login and retrieve a JWT Token Login with the provided credentials (POST data) and return a JWT Token for this |
GET | /auth/api-key | Get all API-Key **Permission required:** view_api_keys auth |
POST | /auth/api-key | Create a new API Key API Keys are simple randomly generated strings bound to roles that grant access to resour |
GET | /auth/api-key/inbox/{inbox_id} | Get all API-Keys for this inbox **Permission required:** view_api_keys auth |
POST | /auth/api-key/inbox/{inbox_id} | Create a new API Key on inbox level The requesting user needs to have inbox level permissions API Keys are si |
GET | /auth/api-key/{key} | Get details of an API-Key **Permission required:** view_api_keys auth |
PATCH | /auth/api-key/{key} | Edit an API-Key **roles** can't be modified after creation: you need to create a new token if you want other r |
DELETE | /auth/api-key/{key} | Delete an API Key Completely remove an API Key, thus disabling it. The token won't be recoverable **Permissio |
POST | /auth/ephemeral | Create a new ephemeral token Ephemeral tokens are short lived tokens that can be used to temporary grant acces |
POST | /auth/get_JWT | Create a new JWT Token ## This endpoint is *deprecated* : use /auth/ephemeral and /auth/token instead This en |
POST | /auth/reset_password | Reset the user password auth |
POST | /auth/token | Create a new token Bearer tokens can be used to authenticated without session or without sending credentials. |
GET | /connections | Get all Connections Return the list of set up connections **Permission required:** edit_integrations connecti |
POST | /connections | Create connection Create a new connection bound to the given scope (can be a project or inbox) **Permission r |
GET | /connections/{connection_id} | Get connection Return the connection attributes **Permission required:** edit_integrations connections |
PATCH | /connections/{connection_id} | Update connection attributes **Permission required:** edit_integrations connections |
DELETE | /connections/{connection_id} | Delete a connection Delete the given connection. **WARNING** This will completely remove the connection, this |
GET | /data_retention_settings | Get all data retention settings **Permission required:** read_data_retention_settings data_retention_settings |
GET | /data_retention_settings/{level}/{id} | Get scoped data retention settings **Permission required:** read_data_retention_settings data_retention_settin |
PATCH | /data_retention_settings/{level}/{id} | Update scoped data retention settings **Permission required:** edit_data_retention_settings data_retention_set |
DELETE | /data_retention_settings/{level}/{id} | Delete scoped sampling settings **Permission required:** edit_data_retention_settings data_retention_settings |
POST | /documents/ | Upload a new document This endpoint is a simplified version of the upload document to inbox one - synchronous |
POST | /documents/custom_output | Generate custom output for documents Using the provided filter on documents, will generate a custom output. * |
GET | /documents/{document_id} | Get the document Simple endpoint that will fetch the given document **Permission required:** review documents |
DELETE | /documents/{document_id} | Delete the document how parameter: if how == "FULL", we delete the entire document, including its source files |
GET | /documents/{document_id}/custom_output | Get custom output formatted document If you have a custom output configured (this is set by contract.fit team) |
POST | /documents/{document_id}/feedback | Submit a feedback Send a feedback for the given document and optionally evaluate. When a document is to be re |
GET | /documents/{document_id}/last_version | Get latest version Get the latest possible version for this document, optionally with constraints on the sourc |
GET | /documents/{document_id}/original_file | Get document original file Return the document original file, as attachment. **Permission required:** review |
POST | /documents/{document_id}/process_table_annotation | Process a table-level annotation A fast and convenient annotation tool that converts a table-level annotation |
POST | /documents/{document_id}/reprocess | Schedule document reprocessing This endpoint schedules (async) reprocessing for the given document; it will ca |
POST | /documents/{document_id}/status_data | Update document status Update the given document status data with the request user and date. Each document de |
GET | /documents/{document_id}/text | Get the document text Return the optimal text for the document; will either be the OCR text, the native text, |
GET | /documents/{document_id}/workflow | Get the document Workflow **WARNING experimental use only** **Permission required:** upload documents |
POST | /documents/{inbox_id} | Upload a new doc to the inbox This endpoint uploads a new file to the given inbox and will process the file. |
PATCH | /documents/{inbox_id}/copy_inbox | Copy documents to another inbox Copy documents in the provided list to another inbox. If the destination inbo |
PATCH | /documents/{inbox_id}/move_inbox | Move documents to another inbox Move documents in the provided list to another inbox. If the destination inbo |
GET | /formats | Get lists of format Return the formats **Deprecated**: display_name **Deprecated**: default_format formats |
POST | /formats | Create format Create an new format **Deprecated**: display_name **Deprecated**: default_format **Permission |
GET | /formats/document_types | Get supported document_types **Permission required:** edit_format_settings formats |
and 78 more operation(s) in this specification, all searchable.
specification origin: https://cfportal.contract-p.fit/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.