Document AI Warehouse API
Document AI Warehouse API endpoints from Google
AI & machine learning#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Document AI Warehouse API endpoints from Google
Endpoints 20
projects
- POSTcontentwarehouse.projects.locations.initialize
/v1/:location:initialize?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringProvisions resources for given tenant project. Returns a long running operation. - GETcontentwarehouse.projects.locations.synonymSets.get
/v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringGets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist - DELETEcontentwarehouse.projects.locations.synonymSets.delete
/v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringDeletes a SynonymSet for a given context. Throws a NOT_FOUND exception if the SynonymSet is not found. - PATCHcontentwarehouse.projects.locations.synonymSets.patch
/v1/:name?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringRemove the existing SynonymSet for the context and replaces it with a new one. Throws a NOT_FOUND exception if the SynonymSet is not found. - POSTcontentwarehouse.projects.locations.documents.referenceId.delete
/v1/:name:delete?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringDeletes a document. Returns NOT_FOUND if the document does not exist. - POSTcontentwarehouse.projects.locations.documents.referenceId.get
/v1/:name:get?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringGets a document. Returns NOT_FOUND if the document does not exist. - POSTcontentwarehouse.projects.locations.documents.lock
/v1/:name:lock?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringLock the document so the document cannot be updated by other users. - POSTcontentwarehouse.projects.locations.documents.documentLinks.create
/v1/:parent/documentLinks?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreate a link between a source document and a target document. - GETcontentwarehouse.projects.locations.documentSchemas.list
/v1/:parent/documentSchemas?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&pageSize=0&pageToken=stringLists document schemas. - POSTcontentwarehouse.projects.locations.documentSchemas.create
/v1/:parent/documentSchemas?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreates a document schema. - POSTcontentwarehouse.projects.locations.documents.create
/v1/:parent/documents?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreates a document. - POSTcontentwarehouse.projects.locations.documents.search
/v1/:parent/documents:search?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringSearches for documents using provided SearchDocumentsRequest. This call only returns documents that the caller has permission to search against. - POSTcontentwarehouse.projects.locations.documents.linkedSources
/v1/:parent/linkedSources?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringReturn all source document-links from the document. - POSTcontentwarehouse.projects.locations.documents.linkedTargets
/v1/:parent/linkedTargets?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringReturn all target document-links from the document. - GETcontentwarehouse.projects.locations.ruleSets.list
/v1/:parent/ruleSets?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&pageSize=0&pageToken=stringLists rulesets. - POSTcontentwarehouse.projects.locations.ruleSets.create
/v1/:parent/ruleSets?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreates a ruleset. - GETcontentwarehouse.projects.locations.synonymSets.list
/v1/:parent/synonymSets?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string&pageSize=0&pageToken=stringReturns all SynonymSets (for all contexts) for the specified location. - POSTcontentwarehouse.projects.locations.synonymSets.create
/v1/:parent/synonymSets?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringCreates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context. - POSTcontentwarehouse.projects.locations.documents.fetchAcl
/v1/:resource:fetchAcl?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringGets the access control policy for a resource. Returns NOT_FOUND error if the resource does not exist. Returns an empty policy if the resource exists but does… - POSTcontentwarehouse.projects.locations.documents.setAcl
/v1/:resource:setAcl?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=stringSets the access control policy for a resource. Replaces any existing policy.
API details
- Base URL
https://contentwarehouse.googleapis.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
OAuth 2.0 (authorization code flow) with 1 scope - Operations
- 20 operations on 15 pathsPOST 14GET 4PATCH 1DELETE 1
- Main resources
- projects 20
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Document AI Warehouse API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Document AI Warehouse API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “contentwarehouse.projects.locations.initialize” (POST /v1/:location:initialize?$.xgafv=1&access_token=string&alt=json&callback=string&fields=string&key=string&oauth_token=string&prettyPrint=true"aUser=string&upload_protocol=string&uploadType=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Document AI Warehouse API?
Document AI Warehouse API endpoints from Google It is listed under AI & machine learning and has 20 endpoints.
Who publishes the Document AI Warehouse API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Document AI Warehouse API?
Requests go to https://contentwarehouse.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Document AI Warehouse API?
It accepts 2 methods: OAuth 2.0 (implicit flow) with 1 scope; OAuth 2.0 (authorization code flow) with 1 scope.
How many endpoints does the Document AI Warehouse API have?
20 operations on 15 paths (14 POST, 4 GET, 1 PATCH, 1 DELETE). The largest groups are projects.
Is forking the Document AI Warehouse API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.