{ "uuid": "54ab5ee3-c03f-4667-95f8-ef52f689f554", "lastMigration": 29, "name": "Computer Vision Client", "endpointPrefix": "vision/v2.1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "fc80e38e-586c-4669-a3df-64b60804eb06", "documentation": "Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​", "method": "post", "endpoint": "read/core/asyncBatchAnalyze", "responses": [ { "uuid": "b3943e1c-5f1e-4825-9bc0-3b4d32374fb4", "body": "", "latency": 0, "statusCode": 202, "label": "The service has accepted the request and will start processing later.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Operation-Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4bcf08f5-5032-45fd-92e4-9deeb286b885", "body": "{\n \"code\": \"{{oneOf (array 'InvalidImageFormat' 'UnsupportedMediaType' 'InvalidImageUrl' 'NotSupportedFeature' 'NotSupportedImage' 'Timeout' 'InternalServerError' 'InvalidImageSize' 'BadArgument' 'DetectFaceError' 'NotSupportedLanguage' 'InvalidThumbnailSize' 'InvalidDetails' 'InvalidModel' 'CancelledRequest' 'NotSupportedVisualFeature' 'FailedToProcess' 'Unspecified' 'StorageException')}}\",\n \"message\": \"\",\n \"requestId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c7bdb353-ea28-43b2-b393-1ddcc301c637", "documentation": "This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Batch Read File interface.", "method": "get", "endpoint": "read/operations/:operationId", "responses": [ { "uuid": "fae4d6f2-c3c8-4bb2-a21f-d5eed9bf7564", "body": "{\n \"recognitionResults\": [\n {\n \"clockwiseOrientation\": {{faker 'number.int' max=99999}},\n \"height\": {{faker 'number.int' max=99999}},\n \"lines\": [\n {\n \"boundingBox\": [\n {{faker 'number.int' max=99999}}\n ],\n \"text\": \"\",\n \"words\": [\n {\n \"boundingBox\": [\n {{faker 'number.int' max=99999}}\n ],\n \"confidence\": \"{{oneOf (array 'High' 'Low')}}\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"page\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'pixel' 'inch')}}\",\n \"width\": {{faker 'number.int' max=99999}}\n }\n ],\n \"status\": \"{{oneOf (array 'NotStarted' 'Running' 'Failed' 'Succeeded')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the read operation status.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c425cc0e-f10b-423d-bfc5-ed284c07c586", "body": "{\n \"code\": \"{{oneOf (array 'InvalidImageFormat' 'UnsupportedMediaType' 'InvalidImageUrl' 'NotSupportedFeature' 'NotSupportedImage' 'Timeout' 'InternalServerError' 'InvalidImageSize' 'BadArgument' 'DetectFaceError' 'NotSupportedLanguage' 'InvalidThumbnailSize' 'InvalidDetails' 'InvalidModel' 'CancelledRequest' 'NotSupportedVisualFeature' 'FailedToProcess' 'Unspecified' 'StorageException')}}\",\n \"message\": \"\",\n \"requestId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e594beae-d509-4625-a69c-1a03c11bf3c1", "documentation": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.", "method": "post", "endpoint": "recognizeText", "responses": [ { "uuid": "21bdc15d-8984-4fa4-a57d-067d5746734f", "body": "", "latency": 0, "statusCode": 202, "label": "The service has accepted the request and will start processing later. It will return Accepted immediately and include an 'Operation-Location' header. Client side should further query the operation status using the URL specified in this header. The operation ID will expire in 48 hours.", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Operation-Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3134a5a5-f523-4b33-a823-05ddafccf584", "body": "{\n \"code\": \"{{oneOf (array 'InvalidImageFormat' 'UnsupportedMediaType' 'InvalidImageUrl' 'NotSupportedFeature' 'NotSupportedImage' 'Timeout' 'InternalServerError' 'InvalidImageSize' 'BadArgument' 'DetectFaceError' 'NotSupportedLanguage' 'InvalidThumbnailSize' 'InvalidDetails' 'InvalidModel' 'CancelledRequest' 'NotSupportedVisualFeature' 'FailedToProcess' 'Unspecified' 'StorageException')}}\",\n \"message\": \"\",\n \"requestId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7dc34754-9940-4884-b066-b7351cefecc8", "documentation": "This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.", "method": "get", "endpoint": "textOperations/:operationId", "responses": [ { "uuid": "5013bc97-5304-4127-bf8a-5fe2011e598a", "body": "{\n \"recognitionResult\": {\n \"clockwiseOrientation\": {{faker 'number.int' max=99999}},\n \"height\": {{faker 'number.int' max=99999}},\n \"lines\": [\n {\n \"boundingBox\": [\n {{faker 'number.int' max=99999}}\n ],\n \"text\": \"\",\n \"words\": [\n {\n \"boundingBox\": [\n {{faker 'number.int' max=99999}}\n ],\n \"confidence\": \"{{oneOf (array 'High' 'Low')}}\",\n \"text\": \"\"\n }\n ]\n }\n ],\n \"page\": {{faker 'number.int' max=99999}},\n \"unit\": \"{{oneOf (array 'pixel' 'inch')}}\",\n \"width\": {{faker 'number.int' max=99999}}\n },\n \"status\": \"{{oneOf (array 'NotStarted' 'Running' 'Failed' 'Succeeded')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Returns the operation status.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4574719e-9582-4818-8eb4-6bfbda36b19a", "body": "{\n \"code\": \"{{oneOf (array 'InvalidImageFormat' 'UnsupportedMediaType' 'InvalidImageUrl' 'NotSupportedFeature' 'NotSupportedImage' 'Timeout' 'InternalServerError' 'InvalidImageSize' 'BadArgument' 'DetectFaceError' 'NotSupportedLanguage' 'InvalidThumbnailSize' 'InvalidDetails' 'InvalidModel' 'CancelledRequest' 'NotSupportedVisualFeature' 'FailedToProcess' 'Unspecified' 'StorageException')}}\",\n \"message\": \"\",\n \"requestId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Error response.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "fc80e38e-586c-4669-a3df-64b60804eb06" }, { "type": "route", "uuid": "c7bdb353-ea28-43b2-b393-1ddcc301c637" }, { "type": "route", "uuid": "e594beae-d509-4625-a69c-1a03c11bf3c1" }, { "type": "route", "uuid": "7dc34754-9940-4884-b066-b7351cefecc8" } ] }