Stay organized with collections
Save and categorize content based on your preferences.
This is the REST API reference for the Optical Character Recognition pre-trained API that is included with
Vertex AI on Google Distributed Cloud (GDC) air-gapped. Use this guide to programmatically detect text in files and images.
Service: Optical Character Recognition (OCR)
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and URIs that are relative to this service endpoint:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis guide is the REST API reference for the Optical Character Recognition (OCR) pre-trained API in Vertex AI on Google Distributed Cloud (GDC) air-gapped.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for this OCR API is \u003ccode\u003ehttps://\u003c/code\u003e\u003cvar translate=no\u003eOCR_ENDPOINT\u003c/var\u003e, which needs to be replaced with your specific endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe API enables programmatic detection of text in both files and images using the \u003ccode\u003eannotate\u003c/code\u003e method via POST requests.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides various resources, including \u003ccode\u003ev1.files\u003c/code\u003e, \u003ccode\u003ev1.images\u003c/code\u003e, \u003ccode\u003ev1.projects.files\u003c/code\u003e, \u003ccode\u003ev1.projects.images\u003c/code\u003e, \u003ccode\u003ev1.projects.locations.files\u003c/code\u003e, and \u003ccode\u003ev1.projects.locations.images\u003c/code\u003e, to perform OCR on different input scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe main function of the API is to perform image detection and annotation for batches of files and images.\u003c/p\u003e\n"]]],[],null,["# Vertex AI Optical Character Recognition API\n\nThis is the REST API reference for the Optical Character Recognition pre-trained API that is included with\nVertex AI on Google Distributed Cloud (GDC) air-gapped. Use this guide to programmatically detect text in files and images.\n\nService: Optical Character Recognition (OCR)\n--------------------------------------------\n\n### Service endpoint\n\nA service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and URIs that are relative to this service endpoint:\n\n- `https://`\u003cvar translate=\"no\"\u003eOCR_ENDPOINT\u003c/var\u003e\n\n\nReplace \u003cvar translate=\"no\"\u003eOCR_ENDPOINT\u003c/var\u003e with the endpoint used to access\nVertex AI OCR API.\nFor more information, see\n[View\nVertex AI service statuses and endpoints](/distributed-cloud/hosted/docs/latest/gdch/application/ao-user/vertex-ai-api-status).\n\nREST Resource: [v1.files](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/ocr/rest/v1/files)\n------------------------------------------------------------------------------------------------------\n\nREST Resource: [v1.images](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/ocr/rest/v1/images)\n--------------------------------------------------------------------------------------------------------\n\nREST Resource: [v1.projects.files](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/ocr/rest/v1/projects.files)\n------------------------------------------------------------------------------------------------------------------------\n\nREST Resource: [v1.projects.images](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/ocr/rest/v1/projects.images)\n--------------------------------------------------------------------------------------------------------------------------\n\nREST Resource: [v1.projects.locations.files](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/ocr/rest/v1/projects.locations.files)\n--------------------------------------------------------------------------------------------------------------------------------------------\n\nREST Resource: [v1.projects.locations.images](/distributed-cloud/hosted/docs/latest/gdch/apis/vertex-ai/ocr/rest/v1/projects.locations.images)\n----------------------------------------------------------------------------------------------------------------------------------------------"]]
