Skip to main content
POST
/
api
/
v3
/
tags
Create a new tag for the company
curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": 3,
  "created_at": "2024-01-16T11:00:00Z",
  "updated_at": "2024-01-16T11:00:00Z",
  "name": "Project Alpha",
  "description": "Documents related to the development and release of Project Alpha",
  "auto_assign": true,
  "document_count": 0
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Serializer for creating a tag.

​
name
string
required

Tag name

​
description
string
required
​
auto_assign
boolean
default:true

If True, this tag can be automatically assigned by the system. If False, it can only be assigned by a user.

Response

Tag created successfully

Serializer for listing tags.

​
id
integer
required
​
name
string
required

Tag name

​
description
string
required

Description of the tag (max 500 characters).

​
auto_assign
boolean
required

If True, this tag can be automatically assigned by the system. If False, it can only be assigned by a user.

​
created_at
string<date-time>
required

Timestamp when the tag was created.

​
updated_at
string<date-time>
required

Timestamp when the tag was last updated.

​
document_count
integer
required

Number of visible documents with this tag