Paperless-ngx icon

Paperless-ngx

Consume documents and metadata from Paperless-ngx API

Tag → Create a Tag

AI-generated

Summary

Create a new tag in Paperless-ngx

Inputs

  • name (required) — Name of the tag
  • matching_algorithm — Algorithm used to match documents; options include Auto, Exact, etc.
  • match — Expression to match documents when matching_algorithm is set

Output shape

a single tag object

Contains fields defined by the tag resource; typically includes id and name; optional fields may be omitted

Examples

Example 1: Create a tag named 'Invoices' with default matching algorithm

name='Invoices', matching_algorithm=6

Example 2: Create a tag using Exact matching with expression 'invoice'

name='Support', matching_algorithm=3, match='invoice'

Example 3: Create a tag with a custom matching expression

name='Legal', matching_algorithm=1, match='contracts due'

Links

Discussion