# Document AI Warehouse API API

> Document AI Warehouse API API on Apizie: 22 endpoints (Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist.…, Sets the access control policy for a resource. Replaces any existing policy., Get the project status., Provisions resources for given tenant project. Returns a long running operation., …) 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-contentwarehouse/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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



## Endpoints

### Gets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist.…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-fetch-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Required. REQUIRED: The resource for which the policy is being requested. Format for document:… |
| body | object | yes | JSON request body |

### Sets the access control policy for a resource. Replaces any existing policy.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-set-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | Required. REQUIRED: The resource for which the policy is being requested. Format for document:… |
| body | object | yes | JSON request body |

### Get the project status.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| location | string | yes | Required. The location to be queried Format: projects/{project_number}/locations/{location}. |

### Provisions resources for given tenant project. Returns a long running operation.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-initialize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| location | string | yes | Required. The location to be initialized Format: projects/{project_number}/locations/{location}. |
| body | object | yes | JSON request body |

### Run a predefined pipeline.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-run-pipeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}. |
| body | object | yes | JSON request body |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of document schemas to return. The service may return fewer than this value. If unspecified, at most 50 document… |
| pageToken | string | no | A page token, received from a previous `ListDocumentSchemas` call. Provide this to retrieve the subsequent page. When paginating, all… |
| parent | string | yes | Required. The parent, which owns this collection of document schemas. Format: projects/{project_number}/locations/{location}. |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent name. |
| body | object | yes | JSON request body |

### Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist
`GET https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-synonym-sets-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the synonymSet to retrieve Format: projects/{project_number}/locations/{location}/synonymSets/{context}. |

### Remove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-synonym-sets-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the synonymSet to update Format: projects/{project_number}/locations/{location}/synonymSets/{context}. |
| body | object | yes | JSON request body |

### Deletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-synonym-sets-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the synonymSet to delete Format: projects/{project_number}/locations/{location}/synonymSets/{context}. |

### Creates a document.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent name. Format: projects/{project_number}/locations/{location}. |
| body | object | yes | JSON request body |

### Deletes a document. Returns NOT_FOUND if the document does not exist.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-reference-id-d` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the document to delete. Format: projects/{project_number}/locations/{location}/documents/{document_id} or… |
| body | object | yes | JSON request body |

### Gets a document. Returns NOT_FOUND if the document does not exist.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-reference-id-g` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the document to retrieve. Format: projects/{project_number}/locations/{location}/documents/{document_id} or… |
| body | object | yes | JSON request body |

### Return all source document-links from the document.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-linked-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the document, for which all source links are returned. Format:… |
| body | object | yes | JSON request body |

### Return all target document-links from the document.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-linked-targets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The name of the document, for which all target links are returned. Format:… |
| body | object | yes | JSON request body |

### Lock the document so the document cannot be updated by other users.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-lock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | Required. The name of the document to lock. Format: projects/{project_number}/locations/{location}/documents/{document}. |
| body | object | yes | JSON request body |

### Searches for documents using provided SearchDocumentsRequest. This call only returns documents that the…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent, which owns this collection of documents. Format: projects/{project_number}/locations/{location}. |
| body | object | yes | JSON request body |

### Create a link between a source document and a target document.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-document-links` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. Parent of the document-link to be created. parent of document-link should be a document. Format:… |
| body | object | yes | JSON request body |

### Lists rulesets.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-rule-sets-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of rule sets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be… |
| pageToken | string | no | A page token, received from a previous `ListRuleSets` call. Provide this to retrieve the subsequent page. When paginating, all other… |
| parent | string | yes | Required. The parent, which owns this collection of document. Format: projects/{project_number}/locations/{location}. |

### Creates a ruleset.
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-rule-sets-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent name. Format: projects/{project_number}/locations/{location}. |
| body | object | yes | JSON request body |

### Returns all SynonymSets (for all contexts) for the specified location.
`GET https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-synonym-sets-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pageSize | integer | no | The maximum number of synonymSets to return. The service may return fewer than this value. If unspecified, at most 50 rule sets will be… |
| pageToken | string | no | A page token, received from a previous `ListSynonymSets` call. Provide this to retrieve the subsequent page. When paginating, all other… |
| parent | string | yes | Required. The parent name. Format: projects/{project_number}/locations/{location}. |

### Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists…
`POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-synonym-sets-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| parent | string | yes | Required. The parent name. Format: projects/{project_number}/locations/{location}. |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-fetch-acl" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Document AI Warehouse API API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/analytics:googleapis-contentwarehouse/contentwarehouse-projects-locations-documents-fetch-acl with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Document AI Warehouse 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-contentwarehouse.

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