Create a new tag for the company

Create a new tag for the authenticated user’s company. The auto_assign flag determines if the tag can be automatically assigned by the system (True) or only manually (False). Requires tag creation permission.

POST /api/v3/tags

Create a new tag for the company

cURL

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>"
}
'

import requests

url = "https://paradigm.lighton.ai/api/v3/tags"

payload = {
    "name": "<string>",
    "description": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: '<string>'})
};

fetch('https://paradigm.lighton.ai/api/v3/tags', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

201

application/json

Tag created successfully

Serializer for listing tags.

id · integer · required · read-only

name · string · required

Tag name

description · string · required · read-only

Description of the tag (max 500 characters).

auto_assign · boolean · required · read-only

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 · read-only

Timestamp when the tag was created.

updated_at · string<date-time> · required · read-only

Timestamp when the tag was last updated.

document_count · integer · required · read-only

Number of visible documents with this tag