Skip to main content
GET
/
api
/
v3
/
agents
/
{id}
/
tags
List tags used in workspaces for an agent
curl --request GET \
  --url https://paradigm.lighton.ai/api/v3/agents/{id}/tags \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "auto_assign": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "document_count": 123
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

ID of the agent

Query Parameters

​
auto_assign
boolean

Filter tags by auto_assign flag

​
tag
string

Filter tags by tag title (case-insensitive partial match)

Response

200 - application/json
​
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