Workflows

Create a Workflow

post/v1/templates

Request

  • Base URL: https://api.documentpro.ai
  • URL: https://api.documentpro.ai/v1/templates
  • Auth: API key in header x-api-key

Request body

template_titlestring required

Must be unique within your account.

template_typestring required
webhook_urlstring uri nullable

Example request

{
  "template_type": "invoice",
  "parser_config": {
    "date_format": "%Y-%m-%d",
    "query_config": {
      "query_model": "gpt-4o-mini",
      "page_ranges": "1-3,5,7-9"
    }
  }
}

Response

Workflow created.

template_idstring uuid

template_id and workflow_id are used interchangeably.

template_titlestring
template_typestring
template_categorystring
email_idstring email

Auto-generated address for forwarding documents to this Workflow.

webhook_urlstring uri nullable
created_atstring date-time

Example response

{
  "parser_config": {
    "date_format": "%Y-%m-%d",
    "query_config": {
      "query_model": "gpt-4o-mini",
      "page_ranges": "1-3,5,7-9"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.