Skip to content
OpenParablePublic APIs

Cloud Document AI API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.

Cloud Document AI API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 21 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://documentai.googleapis.com/
Version
v1beta3
Endpoints
21
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://documentai.googleapis.com/v1beta3/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://documentai.googleapis.com/v1beta3/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://documentai.googleapis.com/v1beta3/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1beta3/{humanReviewConfig}:reviewDocumentSend a document for Human Review. The input document should be processed by the specified processor.
GET/v1beta3/{name}Gets a processor type detail.
DELETE/v1beta3/{name}Deletes the processor version, all artifacts under the processor version will be deleted.
GET/v1beta3/{name}/locationsLists information about the supported locations for this service.
POST/v1beta3/{name}:batchProcessLRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the [Document] format.
POST/v1beta3/{name}:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv
POST/v1beta3/{name}:deployDeploys the processor version.
POST/v1beta3/{name}:disableDisables a processor
POST/v1beta3/{name}:enableEnables a processor
POST/v1beta3/{name}:processProcesses a single document.
POST/v1beta3/{name}:undeployUndeploys the processor version.
GET/v1beta3/{parent}/evaluationsRetrieves a set of evaluations for a given processor version.
GET/v1beta3/{parent}/processorTypesLists the processor types that exist.
GET/v1beta3/{parent}/processorVersionsLists all versions of a processor.
POST/v1beta3/{parent}/processorVersions:importProcessorVersionImports a processor version from source processor version.
POST/v1beta3/{parent}/processorVersions:trainTrains a new processor version. Operation metadata is returned as cloud_documentai_core.TrainProcessorVersionMetadata.
GET/v1beta3/{parent}/processorsLists all processors which belong to this project.
POST/v1beta3/{parent}/processorsCreates a processor from the type processor that the user chose. The processor will be at "ENABLED" state by default after its creation.
GET/v1beta3/{parent}:fetchProcessorTypesFetches processor types. Note that we do not use ListProcessorTypes here because it is not paginated.
POST/v1beta3/{processorVersion}:evaluateProcessorVersionEvaluates a ProcessorVersion against annotated documents, producing an Evaluation.
POST/v1beta3/{processor}:setDefaultProcessorVersionSet the default (active) version of a Processor that will be used in ProcessDocument and BatchProcessDocuments.

Questions

Does the Cloud Document AI API API need an API key?

Yes. The Cloud Document AI API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Document AI API API support HTTPS?

Yes, the Cloud Document AI API API is served over HTTPS.

How many endpoints does the Cloud Document AI API API have?

Its OpenAPI description lists 21 endpoints in version v1beta3. All of them are shown on this page.

What are alternatives to the Cloud Document AI API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).