{ "uuid": "2b1a2877-2083-4f2b-a27a-d19483c2630a", "lastMigration": 29, "name": "Cloud Document AI API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "0ca761b7-1ba4-4bc6-af2b-b11a8f36cd47", "documentation": "Send a document for Human Review. The input document should be processed by the specified processor.", "method": "post", "endpoint": "v1beta3/:humanReviewConfig:reviewDocument", "responses": [ { "uuid": "330aca2c-c7dc-4b91-9b09-b12a7b6515af", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "796377b6-58e7-4233-9530-055d8bee03da", "documentation": "Deletes the processor version, all artifacts under the processor version will be deleted.", "method": "delete", "endpoint": "v1beta3/:name", "responses": [ { "uuid": "e528f3ca-e560-4d85-9047-6a5173a4888a", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7cebc693-c4a7-4b3a-a3be-3d97884dba30", "documentation": "Gets a processor version detail.", "method": "get", "endpoint": "v1beta3/:name", "responses": [ { "uuid": "78ab2986-367c-49a2-aedf-99ef8306e5b2", "body": "{\n \"createTime\": \"\",\n \"deprecationInfo\": {\n \"deprecationTime\": \"\",\n \"replacementProcessorVersion\": \"\"\n },\n \"displayName\": \"\",\n \"googleManaged\": {{faker 'datatype.boolean'}},\n \"kmsKeyName\": \"\",\n \"kmsKeyVersionName\": \"\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'DEPLOYED' 'DEPLOYING' 'UNDEPLOYED' 'UNDEPLOYING' 'CREATING' 'DELETING' 'FAILED')}}\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b828df6a-f130-4b48-8913-cae602164d1b", "documentation": "Lists information about the supported locations for this service.", "method": "get", "endpoint": "v1beta3/:name/locations", "responses": [ { "uuid": "cf85b726-9c6b-4300-b956-b4c66b6ba959", "body": "{\n \"locations\": [\n {\n \"displayName\": \"\",\n \"labels\": {},\n \"locationId\": \"\",\n \"metadata\": {},\n \"name\": \"\"\n }\n ],\n \"nextPageToken\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ee7ba969-a903-4229-909e-24d2d7407e48", "documentation": "LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.", "method": "post", "endpoint": "v1beta3/:name:batchProcess", "responses": [ { "uuid": "adbf9631-4c38-4385-bb3d-59a1a5fe17fc", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b5c4e763-e88c-4bf7-a704-b110f7277888", "documentation": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "method": "post", "endpoint": "v1beta3/:name:cancel", "responses": [ { "uuid": "f733b1b4-c766-4561-940c-2a64501ad6d6", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0b0f273d-82c5-486b-9e4a-08a1c1e68662", "documentation": "Deploys the processor version.", "method": "post", "endpoint": "v1beta3/:name:deploy", "responses": [ { "uuid": "50806dc8-d45f-4c24-86e4-152ea0bd8d6f", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c5a6b264-e453-4d23-b2ae-b8f8581930e6", "documentation": "Disables a processor", "method": "post", "endpoint": "v1beta3/:name:disable", "responses": [ { "uuid": "2a5f4eaf-ecdb-4e85-80f4-932c265b9453", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f604103d-1540-4b42-8719-043ae5e18d26", "documentation": "Enables a processor", "method": "post", "endpoint": "v1beta3/:name:enable", "responses": [ { "uuid": "9ee78760-7c4f-404b-9dd4-e99918a44453", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d4303616-062f-4d8d-ba91-67ffa275312d", "documentation": "Processes a single document.", "method": "post", "endpoint": "v1beta3/:name:process", "responses": [ { "uuid": "97c99961-b474-404c-b89b-27e98dd78cba", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "881ebecc-3cc6-46e2-a65a-414b146931c6", "documentation": "Undeploys the processor version.", "method": "post", "endpoint": "v1beta3/:name:undeploy", "responses": [ { "uuid": "84b245ef-223d-46a7-947c-f2e78aceca5e", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cab8b362-e7a3-461e-bf5b-007e6a255191", "documentation": "Lists the processor types that exist.", "method": "get", "endpoint": "v1beta3/:parent/processorTypes", "responses": [ { "uuid": "80cb2e9d-c070-4a31-a135-6ffde8596a94", "body": "{\n \"nextPageToken\": \"\",\n \"processorTypes\": [\n {\n \"allowCreation\": {{faker 'datatype.boolean'}},\n \"availableLocations\": [\n {\n \"locationId\": \"\"\n }\n ],\n \"category\": \"\",\n \"launchStage\": \"{{oneOf (array 'LAUNCH_STAGE_UNSPECIFIED' 'UNIMPLEMENTED' 'PRELAUNCH' 'EARLY_ACCESS' 'ALPHA' 'BETA' 'GA' 'DEPRECATED')}}\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "64cb9a60-719e-48ba-acf7-70c127ff98b7", "documentation": "Lists all versions of a processor.", "method": "get", "endpoint": "v1beta3/:parent/processorVersions", "responses": [ { "uuid": "763a2f57-9d8f-4fb0-a172-b4c214db0b93", "body": "{\n \"nextPageToken\": \"\",\n \"processorVersions\": [\n {\n \"createTime\": \"\",\n \"deprecationInfo\": {\n \"deprecationTime\": \"\",\n \"replacementProcessorVersion\": \"\"\n },\n \"displayName\": \"\",\n \"googleManaged\": {{faker 'datatype.boolean'}},\n \"kmsKeyName\": \"\",\n \"kmsKeyVersionName\": \"\",\n \"name\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'DEPLOYED' 'DEPLOYING' 'UNDEPLOYED' 'UNDEPLOYING' 'CREATING' 'DELETING' 'FAILED')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "19aff442-f9ad-46c8-b950-36399c50b8c3", "documentation": "Lists all processors which belong to this project.", "method": "get", "endpoint": "v1beta3/:parent/processors", "responses": [ { "uuid": "13597d97-474f-4a51-915e-5c9c92ad080a", "body": "{\n \"nextPageToken\": \"\",\n \"processors\": [\n {\n \"createTime\": \"\",\n \"defaultProcessorVersion\": \"\",\n \"displayName\": \"\",\n \"kmsKeyName\": \"\",\n \"name\": \"\",\n \"processEndpoint\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ENABLED' 'DISABLED' 'ENABLING' 'DISABLING' 'CREATING' 'FAILED' 'DELETING')}}\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de9268d7-5c16-48f6-8e12-1b904d6de4b4", "documentation": "Creates a processor from the type processor that the user chose. The processor will be at \"ENABLED\" state by default after its creation.", "method": "post", "endpoint": "v1beta3/:parent/processors", "responses": [ { "uuid": "fbea18f0-d0b1-4a9b-8924-2c90f1301916", "body": "{\n \"createTime\": \"\",\n \"defaultProcessorVersion\": \"\",\n \"displayName\": \"\",\n \"kmsKeyName\": \"\",\n \"name\": \"\",\n \"processEndpoint\": \"\",\n \"state\": \"{{oneOf (array 'STATE_UNSPECIFIED' 'ENABLED' 'DISABLED' 'ENABLING' 'DISABLING' 'CREATING' 'FAILED' 'DELETING')}}\",\n \"type\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1b236343-e22a-4d0a-8a45-8f98009db231", "documentation": "Fetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.", "method": "get", "endpoint": "v1beta3/:parent:fetchProcessorTypes", "responses": [ { "uuid": "9267cd17-3c35-41a1-b649-5bbe210a82f5", "body": "{\n \"processorTypes\": [\n {\n \"allowCreation\": {{faker 'datatype.boolean'}},\n \"availableLocations\": [\n {\n \"locationId\": \"\"\n }\n ],\n \"category\": \"\",\n \"launchStage\": \"{{oneOf (array 'LAUNCH_STAGE_UNSPECIFIED' 'UNIMPLEMENTED' 'PRELAUNCH' 'EARLY_ACCESS' 'ALPHA' 'BETA' 'GA' 'DEPRECATED')}}\",\n \"name\": \"\",\n \"type\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5861ee61-8f76-451a-9d04-7e98cef3b874", "documentation": "Set the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.", "method": "post", "endpoint": "v1beta3/:processor:setDefaultProcessorVersion", "responses": [ { "uuid": "41777435-64b9-4180-8aeb-cabd7bfd170f", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "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": "0ca761b7-1ba4-4bc6-af2b-b11a8f36cd47" }, { "type": "route", "uuid": "796377b6-58e7-4233-9530-055d8bee03da" }, { "type": "route", "uuid": "7cebc693-c4a7-4b3a-a3be-3d97884dba30" }, { "type": "route", "uuid": "b828df6a-f130-4b48-8913-cae602164d1b" }, { "type": "route", "uuid": "ee7ba969-a903-4229-909e-24d2d7407e48" }, { "type": "route", "uuid": "b5c4e763-e88c-4bf7-a704-b110f7277888" }, { "type": "route", "uuid": "0b0f273d-82c5-486b-9e4a-08a1c1e68662" }, { "type": "route", "uuid": "c5a6b264-e453-4d23-b2ae-b8f8581930e6" }, { "type": "route", "uuid": "f604103d-1540-4b42-8719-043ae5e18d26" }, { "type": "route", "uuid": "d4303616-062f-4d8d-ba91-67ffa275312d" }, { "type": "route", "uuid": "881ebecc-3cc6-46e2-a65a-414b146931c6" }, { "type": "route", "uuid": "cab8b362-e7a3-461e-bf5b-007e6a255191" }, { "type": "route", "uuid": "64cb9a60-719e-48ba-acf7-70c127ff98b7" }, { "type": "route", "uuid": "19aff442-f9ad-46c8-b950-36399c50b8c3" }, { "type": "route", "uuid": "de9268d7-5c16-48f6-8e12-1b904d6de4b4" }, { "type": "route", "uuid": "1b236343-e22a-4d0a-8a45-8f98009db231" }, { "type": "route", "uuid": "5861ee61-8f76-451a-9d04-7e98cef3b874" } ] }