# Cloud Document AI API API

> Cloud Document AI API API on Apizie: 26 endpoints (Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…, Updates a schema version. Editable fields are: - `display_name` - `labels`, Deletes a schema version., Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/analytics:googleapis-documentai/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:googleapis-documentai`
- Category: Analytics
- Status: byok
- Source: https://cloud.google.com/document-ai/docs/
- Page: https://zieapi.vercel.app/api/analytics/googleapis-documentai
- OpenAPI: https://zieapi.vercel.app/api/analytics/googleapis-documentai/openapi.json

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.

## Endpoints

### Gets the latest state of a long-running operation. Clients can use this method to poll the operation result…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-operations-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource. |

### Updates a schema version. Editable fields are: - `display_name` - `labels`
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-schema-versions-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Identifier. The resource name of the SchemaVersion. Format:… |
| updateMask | string | no | Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - `display_name` - `labels` |
| body | object | yes | JSON request body |

### Deletes a schema version.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-schema-versions-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the SchemaVersion to delete. Format:… |

### Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-fetch-processor-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`. |

### Lists information about the supported locations for this service. This method lists locations based on the…
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| extraLocationTypes | string | no | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter | string | no | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is… |
| name | string | yes | The resource that owns the locations collection, if applicable. |
| pageSize | integer | no | The maximum number of results to return. If not set, the service selects a default. |
| pageToken | string | no | A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. |

### Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-operations-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The name of the operation resource to be cancelled. |

### Lists the processor types that exist.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processor-types-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of processor types to return. If unspecified, at most `100` processor types will be returned. The maximum value is… |
| pageToken | string | no | Used to retrieve the next page of results, empty if at the end of the list. |
| parent | string | yes | Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`. |

### LRO endpoint to batch process many documents. The output is written to Cloud Storage as JSON in the…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or… |
| body | object | yes | JSON request body |

### Lists all processors which belong to this project.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of processors to return. If unspecified, at most `50` processors will be returned. The maximum value is `100`. Values… |
| pageToken | string | no | We will return the processors sorted by creation time. The page token will point to the next processor. |
| parent | string | yes | Required. The parent (project and location) which owns this collection of Processors. Format: `projects/{project}/locations/{location}` |

### Creates a processor from the ProcessorType provided. The processor will be at `ENABLED` state by default…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent (project and location) under which to create the processor. Format: `projects/{project}/locations/{location}` |
| body | object | yes | JSON request body |

### Disables a processor
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-disable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The processor resource name to be disabled. |
| body | object | yes | JSON request body |

### Enables a processor
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-enable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The processor resource name to be enabled. |
| body | object | yes | JSON request body |

### Processes a single document.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name of the Processor or ProcessorVersion to use for processing. If a Processor is specified, the server will use… |
| body | object | yes | JSON request body |

### Set the default (active) version of a Processor that will be used in ProcessDocument and…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-set-default-process` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| processor | string | yes | Required. The resource name of the Processor to change default version. |
| body | object | yes | JSON request body |

### Send a document for Human Review. The input document should be processed by the specified processor.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-human-review-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| humanReviewConfig | string | yes | Required. The resource name of the HumanReviewConfig that the document will be reviewed with. |
| body | object | yes | JSON request body |

### Deploys the processor version.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The processor version resource name to be deployed. |
| body | object | yes | JSON request body |

### Evaluates a ProcessorVersion against annotated documents, producing an Evaluation.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-4` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| processorVersion | string | yes | Required. The resource name of the ProcessorVersion to evaluate.… |
| body | object | yes | JSON request body |

### Lists all versions of a processor.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-5` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of processor versions to return. If unspecified, at most `10` processor versions will be returned. The maximum value is… |
| pageToken | string | no | We will return the processor versions sorted by creation time. The page token will point to the next processor version. |
| parent | string | yes | Required. The parent (project, location and processor) to list all versions. Format:… |

### Trains a new processor version. Operation metadata is returned as TrainProcessorVersionMetadata.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent (project, location and processor) to create the new version for. Format:… |
| body | object | yes | JSON request body |

### Undeploys the processor version.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-7` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The processor version resource name to be undeployed. |
| body | object | yes | JSON request body |

### Retrieves a set of evaluations for a given processor version.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-processors-processor-versions-8` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The standard list page size. If unspecified, at most `5` evaluations are returned. The maximum value is `100`. Values above `100` are… |
| pageToken | string | no | A page token, received from a previous `ListEvaluations` call. Provide this to retrieve the subsequent page. |
| parent | string | yes | Required. The resource name of the ProcessorVersion to list evaluations for.… |

### Lists Schemas.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`.… |
| pageToken | string | no | Optional. Returns the schema groups sorted by creation time. The page token will point to the next Schema. |
| parent | string | yes | Required. Format: `projects/{project}/locations/{location}` |

### Creates a schema.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` |
| body | object | yes | JSON request body |

### Lists SchemaVersions.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-schema-versions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is… |
| pageToken | string | no | Optional. Returns the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion. |
| parent | string | yes | Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` |

### Creates a schema version.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-schema-versions-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent (project and location) under which to create the SchemaVersion. Format:… |
| body | object | yes | JSON request body |

### Generates a schema version.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-locations-schemas-schema-versions-genera` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format:… |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-operations-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Cloud Document AI API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/analytics:googleapis-documentai/documentai-projects-operations-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Cloud Document AI API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Cloud Document AI API itself also needs your own key from googleapis.com.

### Can AI agents use the Cloud Document AI API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:googleapis-documentai.

### What is the status of the Cloud Document AI API API?
Needs your own provider key (bring your own key)