> ## 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.

# API Methods

> Browse the full set of ABBYY FlexiCapture Web Services API methods, grouped by sessions, projects, batches, tasks, documents, pages, users, files, and more.

API methods are used to control the Application Server.

| [Sessions](/flexi-capture/api/methods/methods#sessions) | [Projects](/flexi-capture/api/methods/methods#projects)              | [Batch Types](/flexi-capture/api/methods/methods#batchtypes) |
| ------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------ |
| [Batches](/flexi-capture/api/methods/methods#batches)   | [Tasks](/flexi-capture/api/methods/methods#tasks)                    | [Documents](/flexi-capture/api/methods/methods#documents)    |
| [Pages](/flexi-capture/api/methods/methods#pages)       | [Licensing tickets](/flexi-capture/api/methods/methods#tickets)      | [Users](/flexi-capture/api/methods/methods#users)            |
| [Files](/flexi-capture/api/methods/methods#files)       | [Attachments](/flexi-capture/api/methods/methods#attachments)        | [Log](/flexi-capture/api/methods/methods#log)                |
| [Document Definitions](#templates)                      | [Server Requests](/flexi-capture/api/methods/methods#serverrequests) | [Other](/flexi-capture/api/methods/methods#other)            |

## <a id="sessions" />Sessions

| [CloseSession](/flexi-capture/api/methods/close-session)        | Closes a session                                         |
| --------------------------------------------------------------- | -------------------------------------------------------- |
| [GetSessionInfo](/flexi-capture/api/methods/get-session-info)   | Gets information about a session                         |
| [IsSessionExists](/flexi-capture/api/methods/is-session-exists) | Checks if a session exists                               |
| [OpenSession](/flexi-capture/api/methods/open-session)          | Opens a session and specifies the role types and station |

## <a id="projects" />Projects

| [CloseProject](/flexi-capture/api/methods/close-project)               | Closes a project                                                   |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------ |
| [GetProjects](/flexi-capture/api/methods/get-projects)                 | Gets a list of projects loaded onto the Application Server         |
| [GetProjectsForUser](/flexi-capture/api/methods/get-projects-for-user) | Gets the set of records listing the projects available to the user |
| [OpenProject](/flexi-capture/api/methods/open-project)                 | Opens a project                                                    |

## <a id="batchtypes" />Batch Types

| [GetAllowedBatchTypes](/flexi-capture/api/methods/get-allowed-batch-types)    | Gets a list of available batch types                                   |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| [GetBatchType](/flexi-capture/api/methods/get-batchtype)                      | Gets information about a batch type                                    |
| [GetBatchTypes](/flexi-capture/api/methods/get-batch-types)                   | Gets a list of batch types                                             |
| [GetProcessingStages](/flexi-capture/api/methods/get-processing-stages)       | Gets extended information about processing stages                      |
| [HasRightsForBatchType](/flexi-capture/api/methods/has-rights-for-batch-type) | Checks if the user role has access permissions to a certain batch type |

## <a id="batches" />Batches

| [AddNewBatch](/flexi-capture/api/methods/add-new-batch)                            | Adds a new batch and specifies its owner                 |
| ---------------------------------------------------------------------------------- | -------------------------------------------------------- |
| [AddNewImage](/flexi-capture/api/methods/add-new-image)                            | Adds an image into a batch                               |
| [CloseBatch](/flexi-capture/api/methods/close-batch)                               | Closes (unlocks) a batch                                 |
| [DeleteBatch](/flexi-capture/api/methods/delete-batch)                             | Deletes a batch                                          |
| [GetBatch](/flexi-capture/api/methods/get-batch)                                   | Gets information about a batch                           |
| [GetBatches](/flexi-capture/api/methods/get-batches)                               | Gets information about batches in a project              |
| [GetBatchIdsRange](/flexi-capture/api/methods/get-batch-ids-range)                 | Reserves a set of IDs in a batch                         |
| [GetBatchPercentCompleted](/flexi-capture/api/methods/get-batch-percent-completed) | Gets information about the processing of a batch         |
| [GetFilteredBatches](/flexi-capture/get-filtered-batches)                          | Get the filtered list of batches from a server in groups |
| [OpenBatch](/flexi-capture/api/methods/open-batch)                                 | Opens (locks) a batch                                    |
| [ProcessBatch](/flexi-capture/api/methods/process-batch)                           | Starts processing a batch                                |
| [UpdateBatch](/flexi-capture/api/methods/update-batch)                             | Update the header of the batch                           |

## <a id="tasks" />Tasks

| [CancelTask](/flexi-capture/api/methods/cancel-task)                                     | Cancels a task                                                                                                                                                       |
| ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [CloseTask](/flexi-capture/api/methods/close-task)                                       | Closes a task                                                                                                                                                        |
| [CreateTask](/flexi-capture/api/methods/create-task)                                     | Creates a task                                                                                                                                                       |
| [GetAvailableTasks](/flexi-capture/api/methods/get-available-tasks)                      | Get the list of available tasks for the selected stage type. Allows restricting the set of available batches.                                                        |
| [GetAvailableTasksByStageId](/flexi-capture/api/methods/get-available-tasks-by-stage-id) | Get the list of available tasks for the specified processing stages. Allows restricting the set of available batches                                                 |
| [GetAvailableQueues](/flexi-capture/api/methods/get-available-queues)                    | Gets the set of records listing the processing stages available to the user                                                                                          |
| [GetCurrentTask](/flexi-capture/api/methods/get-current-task)                            | Gets the ID of the task obtained with the [GetTask](/flexi-capture/api/methods/get-task) method and not yet processed                                                |
| [GetPostponedTasks](/flexi-capture/api/methods/get-postponed-tasks)                      | Gets a list of postponed tasks                                                                                                                                       |
| [GetTask](/flexi-capture/api/methods/get-task)                                           | Select the task with the highest priority at the processing stages of the selected type and open it for processing. Allows restricting the set of available batches. |
| [GetTaskByStageId](/flexi-capture/api/methods/get-task-by-stage-id)                      | Select the task with the highest priority at the specified processing stages and open it for processing                                                              |
| [GetTaskDocuments](/flexi-capture/api/methods/get-task-documents)                        | Gets a list of documents in a task                                                                                                                                   |
| [GetTaskInfo](/flexi-capture/api/methods/get-task-info)                                  | Gets extended information about a task                                                                                                                               |
| [OpenTask](/flexi-capture/api/methods/open-task)                                         | Opens a task                                                                                                                                                         |
| [PostponeTask](/flexi-capture/api/methods/postpone-task)                                 | Postpones a task                                                                                                                                                     |
| [SendTask](/flexi-capture/api/methods/send-task)                                         | Sends the task to the specified processing stage                                                                                                                     |
| [SendTaskToException](/flexi-capture/api/methods/send-task-to-exception)                 | Sends a task to Exceptions                                                                                                                                           |
| [SetTaskPriority](/flexi-capture/api/methods/set-task-priority)                          | Changes the task priority                                                                                                                                            |

## <a id="documents" />Documents

| [AddNewDocument](/flexi-capture/api/methods/add-new-document)               | Add a new document and specify additional information                         |
| --------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| [AddNewImage](/flexi-capture/api/methods/add-new-image)                     | Adds an image into a batch                                                    |
| [DeleteDocument](/flexi-capture/api/methods/delete-document)                | Deletes a document                                                            |
| [GetDocument](/flexi-capture/api/methods/get-document)                      | Gets information about a document                                             |
| [GetDocumentResultsList](/flexi-capture/get-document-results-list)          | Gets a list of files into which the document processing results were exported |
| [GetDocuments](/flexi-capture/api/methods/get-documents)                    | Gets a list of documents in a batch                                           |
| [LoadDocumentResult](/flexi-capture/api/methods/load-document-result)       | Gets the file into which the document processing results were exported        |
| [SetDocumentProperties](/flexi-capture/api/methods/set-document-properties) | Specifies registration parameters for a document                              |
| [SetDocumentPriority](/flexi-capture/api/methods/set-document-priority)     | Changes document priority                                                     |

## <a id="pages" />Pages

| [AddNewPage](/flexi-capture/api/methods/add-new-page)             | Adds a page image to a document and includes a description |
| ----------------------------------------------------------------- | ---------------------------------------------------------- |
| [DeletePage](/flexi-capture/api/methods/delete-page)              | Deletes a page from a document                             |
| [ReplacePageImage](/flexi-capture/api/methods/replace-page-image) | Replaces a page image                                      |

## <a id="tickets" />Licensing tickets

| [GetNewTicket](/flexi-capture/api/methods/get-new-ticket)  | Gets a new licensing ticket              |
| ---------------------------------------------------------- | ---------------------------------------- |
| [ReleaseTicket](/flexi-capture/api/methods/release-ticket) | Releases a licensing ticket              |
| [UpdateTicket](/flexi-capture/api/methods/update-ticket)   | Updates the status of a licensing ticket |

## <a id="users" />Users

| [AddUserIfNotExist](/flexi-capture/api/methods/add-user-if-not-exist)         | Gets the ID of the current user and creates a database record if required                                                                  |
| ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| [FindUser](/flexi-capture/api/methods/find-user)                              | Gets the user ID and user name                                                                                                             |
| [GetAvailableQueues](/flexi-capture/api/methods/get-available-queues)         | Gets the set of records listing the processing stages available to the user                                                                |
| [GetAvailableUsers](/flexi-capture/api/methods/get-available-users)           | Gets a list of users or groups allowed to process a specified stage                                                                        |
| [GetProjectsForStationType](/flexi-capture/get-projects-for-station-type)     | Finds projects where a user has at least one role associated with a particular type of station                                             |
| [GetProjectsForUser](/flexi-capture/api/methods/get-projects-for-user)        | Gets the set of records listing the projects available to the user                                                                         |
| [GetRoles](/flexi-capture/api/methods/get-roles)                              | Gets list of all roles in the project                                                                                                      |
| [GetUser](/flexi-capture/api/methods/get-user)                                | Gets information about the user based on the user ID                                                                                       |
| [GetUserRoles](/flexi-capture/api/methods/get-user-roles)                     | Gets list of IDs of the user roles available to the current user in the given project                                                      |
| [GetUsers](/flexi-capture/api/methods/get-users)                              | Gets the list of users                                                                                                                     |
| [GetUserStatistics](/flexi-capture/api/methods/get-user-statistics)           | Gets a set of records listing the the number of batches, documents and pages whose state changed to "processed" for a given period of time |
| [HasRightsForBatchType](/flexi-capture/api/methods/has-rights-for-batch-type) | Checks if the user role has access permissions to a certain batch type                                                                     |

## <a id="files" />Files

| [GetCustomFileNames](/flexi-capture/api/methods/get-custom-file-names) | Gets a list of user files stored on the Application Server |
| ---------------------------------------------------------------------- | ---------------------------------------------------------- |
| [LoadCustomFile](/flexi-capture/api/methods/load-custom-file)          | Loads a user file from the Application Server              |
| [RemoveCustomFile](/flexi-capture/api/methods/remove-custom-file)      | Deletes a user file from the Application Server            |
| [SaveCustomFile](/flexi-capture/api/methods/save-custom-file)          | Saves a user file on the Application Server                |

## <a id="attachments" />Attachments

| [GetAttachmentNames](/flexi-capture/api/methods/get-attachment-names) | Gets a list of attachments on the Application Server |
| --------------------------------------------------------------------- | ---------------------------------------------------- |
| [LoadAttachment](/flexi-capture/api/methods/load-attachment)          | Loads an attachment from the Application Server      |
| [RemoveAttachment](/flexi-capture/api/methods/remove-attachment)      | Deletes an attachment from the Application Server    |
| [SaveAttachment](/flexi-capture/api/methods/save-attachment)          | Saves an attachment on the Application Server        |

## <a id="templates" />Document Definitions

| [GetTemplates](/flexi-capture/api/methods/get-templates)                     | Get the set of Document Definitions of the project                                 |
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [GetBatchTypeTemplates](/flexi-capture/api/methods/get-batch-type-templates) | Returns the set of identifiers for Document Definitions attached to the batch type |

## <a id="log" />Log

| [WriteToLog](/flexi-capture/api/methods/write-to-log) | Writes information about events into the Application Server's log |
| ----------------------------------------------------- | ----------------------------------------------------------------- |

## <a id="serverrequests" />Server Requests

| [CreateRequest](/flexi-capture/api/methods/create-request-api-methods) | Creates a request to the Application Server                              |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| [DeleteRequest](/flexi-capture/api/methods/delete-request)             | Deletes a request to the Application Server.                             |
| [GetRequests](/flexi-capture/api/methods/get-requests)                 | Gets a list of requests to the Application Server in the current session |
| [GetRequestStatus](/flexi-capture/api/methods/get-request-status)      | Gets the status of a request to the Application Server                   |
| [SetRequestStatus](/flexi-capture/api/methods/set-request-status)      | Changes the status of a request to the Application Server                |

## <a id="other" />Other

| [GetSettingValue](/flexi-capture/api/methods/get-setting-value) | Gets a named parameter from the database |
| --------------------------------------------------------------- | ---------------------------------------- |
| [SetSettingValue](/flexi-capture/api/methods/set-setting-value) | Saves a named parameter in the database  |