Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

HttpRequest sends HTTP requests containing application/x-www-form-urlencoded, text, or binary data to external services.

​
Properties

NameTypeAccessDescription
UrlstringRead-writeThe resource URL.
MethodstringRead-writeThe request type (for example, GET or POST).
AuthTokenstringRead-writeAuthentication token if the external service requires authentication.
AuthSchemestringRead-writeAuthentication scheme.
ThrowExceptionOnFailedbooleanRead-writeIf true (default), HTTP response status codes outside 200–299 raise an exception. See note below.
TimeoutnumberRead-writeRequest timeout in minutes. Default is 1 minute.
ResponseTextstringRead-onlyThe response body in text format.
ResponseTypestringRead-onlyThe content type of the response (for example, application/json).
StatusnumberRead-onlyThe HTTP response status code from the external service.
When ThrowExceptionOnFailed is false, exceptions aren’t raised for 4xx/5xx responses — inspect Status to check the HTTP status code yourself. A response with an error code means the external service is reachable and responding. Errors related to service availability or connection failures always raise a program exception, regardless of this property — in those cases no HTTP status code is available.
If ThrowExceptionOnFailed is true and the response is an error code, the transaction is interrupted and the error message appears in Skill Monitor.
The Timeout value can’t exceed the script runtime limit (600 seconds).

​
Methods

​
SetHeader

void SetHeader(string name, string value);
Sets an additional HTTP header for the request. Call once per header.

​
Send

void Send();
Sends the HTTP request.

​
SetFileContent

void SetFileContent(DocumentExportResult documentExportResult, string mediaType?);
void SetFileContent(BinaryFile binaryFile, string mediaType?);
Initializes a file-based HTTP request body. The content type is detected from the file extension (for example, application/json, application/pdf). To override, pass mediaType.
  • The first overload sends exported data (from Document.Exports) as a file.
  • The second overload sends binary data — either a source image from when the transaction was created, or an image from a field of type Picture.

​
SetSourceFileContent

void SetSourceFileContent(string mediaType?);
Initializes a binary-data request with the source image imported when the transaction was created. The content type is detected from the file extension. Override with mediaType if needed.
SetSourceFileContent is deprecated — it only accesses the first file in a transaction. Use SetFileContent instead.

​
SetStringContent

void SetStringContent(string content, ContentEncoding contentEncoding?, string mediaType?);
Initializes a string-based HTTP request body. Defaults to Content-Type: application/json and UTF-8 encoding. Override either using the optional parameters.

​
SetUrlFormEncodedContent

void SetUrlFormEncodedContent(any content);
Initializes the request body from a JavaScript object and encodes it as application/x-www-form-urlencoded. The object should be a simple set of property/value pairs: 
var form = {};
form.grant_type = "password";
form.scope = "openid permissions";
form.client_id = "value of client_id";
form.client_secret = "value of client_secret";
form.password = "Password";
form.username = "User Name";
request.SetUrlFormEncodedContent(form);

Context

Global object for transaction data, HTTP requests, and secrets.

MultipartFormDataRequest

Make multipart/form-data HTTP requests from Custom activity scripts.

BinaryFile

File data in binary format — typically the pre-preprocessing source image.

DocumentExportResult

Access exported document files (JSON, PDF, images) from a script.

ContentEncoding

Encoding types available for string-based HTTP requests.

Object model

Full JavaScript object reference for Custom activity scripts.