› DocAI Studio › DocAI solutions › Configure settings › Configure import channels › Use REST API for document import

Use REST API for document import

Use the procedure in this topic to configure and apply an external REST API for your DocAI solution.

Before you begin

Before you use the REST API for document import, publish your solution.

Procedure

  1. Select the Settings menu on the ribbon.
  2. Select Import Channels > REST API.

    All the information needed to configure the REST API outside of DocAI Studio is available on the following tabs:

    • General: Provides the name of the API call as well as a summary, samples, and content type.

    • Parameters: Lists all required parameters and a JSON payload sample that is populated with specific information from your solution after it is published. This sample is specialized for the value of document or folder value selected from the Settings > Processing > Mode setting.

    • Response: Provides content type sample code or examples.

    • Response messages: Lists the typical error messages, HTTP status codes, and reasons for the response code, that can help troubleshoot your API configuration.

Next steps