OCR Web Service connects to a Nagent workspace. Once it is connected, agents can call 4 OCR Web Service actions, such as "Get Account Credentials", "Get Account Information" and "OCR Web Service Log". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against OCR Web Service, with input parameters and output schema.
OCR_WEB_SERVICE_GET_ACCOUNT_CREDENTIALSTool to extract OCRWebService credentials (user_name, license_code) from connection metadata. Always call this before invoking OCR_WEB_SERVICE_RECOGNIZE or OCR_WEB_SERVICE_GET_ACCOUNT_INFORMATION rather than reusing cached values, as credentials may become stale. Use OCR_WEB_SERVICE_GET_ACCOUNT_INFORMATION to verify account status and quota before submitting large jobs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OCR_WEB_SERVICE_GET_ACCOUNT_INFORMATIONRetrieve OCRWebService account information including remaining pages, subscription plan, and expiration date. Use this tool to check your account status before large OCR jobs — exhausted page quotas will cause OCR_WEB_SERVICE_RECOGNIZE to fail mid-run. Returns details about your subscription including pages remaining and plan expiration. If credentials are invalid or stale, retrieve fresh user_name and license_code via OCR_WEB_SERVICE_GET_ACCOUNT_CREDENTIALS before retrying. Requires valid OCRWebService credentials (username and license code).
Input parameters
OCRWebService account username for authentication
OCRWebService account license code (API key) for authentication
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OCR_WEB_SERVICE_LOGTool to retrieve OCR processing logs for a date range on your account. Invalid credentials or bad date ranges return empty data rather than an error, so an empty result may indicate incorrect inputs rather than no logs.
Input parameters
End date for log (YYYY-MM-DD)
Reserved values, if any
Start date for log (YYYY-MM-DD)
Account user name
Account license code
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
OCR_WEB_SERVICE_RECOGNIZETool to call SOAP Recognize operation. Use when performing OCR on an image to retrieve text, output document, word coordinates, and errors. Consumes page quota per call; returns HTTP 429 when limits exceeded. Check quota via OCR_WEB_SERVICE_GET_ACCOUNT_INFORMATION before large jobs; batch large PDFs in ~25–50 page chunks.
Input parameters
OCRWebService account username
OCR processing settings (languages, output, options)
OCRWebService account license code
Input file container (name + data)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 4 OCR Web Service actions on Nagent, including "Get Account Credentials", "Get Account Information" and "OCR Web Service Log". Get Account Credentials: Extract OCRWebService credentials (user_name, license_code) from connection metadata. Each action is listed on this page with its input parameters and its output.
It returns data, error and successful.