Change Document Revision Status

Request

This API allows you to update the revision status of document that has been uploaded on the platform as the result of a previous inference request.

PATCH  '/inference/service/:service_id:/predicted-documents/:document_id:'

Note

For further information about when documents are uploaded on platform, please refer to Inference Sync and Inference Async

The API requires making a PATCH request by specifying the service_id and the document_id as parameters and the updated revision_status in a JSON payload as the examples below shows.

curl --location --request PATCH 'https://platform.mybiros.com/api/v1/inference/service/:service_id:/predicted-documents/:document_id:' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Accept: application/json'
--data '{
  "revision_status": "to_review"
}'

Parameters

Headers Parameters

x-api-key (required)

Type: string

A valid API key for the service.

Path parameters

service_id (required)

Type: string

Identifier of the service.

document_id (required)

Type: string

Identifier of the document.

Body Parameters

The accepted body content-type is application/json with the following parameters specified as keys:

revision_status (required)

Type: string
Allowed values: pending, to_review, review_required, approved, not_approved

The updated revision status that will be assigned to the document.

Note

For further information about revision statuses please refer to Revision Status

Responses

Successful Responses

The request was successful, and a JSON response is returned.

Status	Message	Description	Reference
200	OK	the request has succeeded.	Success Response 200

Status 200 - OK

JSON Response Example

    {
        "message": "Document fields updated.",
        "fields_updated": {
            "revision_status": "to_review"
        }
    }

---

Error Responses

The request was unsuccessful, and a specific status code is returned to identify the error.

Status	Message	Description	Reference
401	Unauthorized	the server has not been able to authenticate the request.	Response 401
404	Not Found	the server could not locate the requested resource.	Response 404
422	Unprocessable Content	The server has not been able to process the content of the request.	Response 422
429	Too Many Requests	the client has sent too many requests in a short period, exceeding the rate limit. Please try again later.	Response 429

500	Internal Server Error	the server encountered an unexpected and unrecoverable error while processing the request.	Response 500
503	Service Unavailable	the server could be under maintenance for an update. Will be back soon.	Response 503

Status 401 - Unauthorized

The current endpoint is protected and requires an API key to be accessed. If sufficient privileges are not present, the request will not be authorized.

Tip

Double-check that the API Key is correct, valid and set using the x-api-key header in the request. Also make sure that you are using the right API key for the service you are requesting and that the service ID in it is correct and corresponds to the ID of an existing service in your account.

Status 404 - Not Found

The service ID provided does not exist or could not be found. Please verify the ID and try again. The document ID provided does not exist or could not be found. Please verify that the ID is valid and that it references a document processed with the service you specified.

Status 422 - Unprocessable content

This status code indicates that the server successfully received and understood the request, but it cannot process it due to errors in the provided data. These errors may include missing fields, invalid formats, or values that do not meet the endpoint requirements.

Tip

Double-check your request's payload format and parameters

Status 429 - Too Many Requests

This status code is returned when the client has made too many requests in a given timeframe, exceeding the rate limits set by the server. It indicates that the client needs to slow down and retry after a specified cooldown period. Rate limits are typically enforced to protect the server from being overwhelmed and to ensure fair use of resources.

Status 500 - Internal Server Error

This status code indicates that the server encountered an unexpected error or condition that prevented it from completing the request. It is a generic error message when no more specific message is suitable. The client cannot resolve the issue.

Status 503 - Service Unavailable

This status code indicates that the server is currently unavailable, typically due to ongoing maintenance or temporary overloading. The server is unable to handle the request at the moment, but the issue is expected to be resolved shortly. This status code signals that the downtime is temporary, and the service will be restored once maintenance is complete.