> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/tags.md).

# Tags

Tags

## Search Tags

> Search for Tags viewable by this user

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"tags","description":"Tags"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Tag":{"properties":{"tagId":{"description":"The Tag ID","type":"integer"},"tag":{"description":"The Tag Name","type":"string"},"isSystem":{"description":"Flag, whether the tag is a system tag","type":"integer"},"isRequired":{"description":"Flag, whether the tag requires additional values","type":"integer"},"options":{"description":"An array of options assigned to this Tag"}}}}},"paths":{"/tag":{"get":{"tags":["tags"],"summary":"Search Tags","description":"Search for Tags viewable by this user","operationId":"tagSearch","parameters":[{"schema":{"type":"integer"},"name":"tagId","in":"query","description":"Filter by Tag Id","required":false},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Filter by partial Tag","required":false},{"schema":{"type":"string"},"name":"exactTag","in":"query","description":"Filter by exact Tag","required":false},{"schema":{"type":"integer"},"name":"isSystem","in":"query","description":"Filter by isSystem flag","required":false},{"schema":{"type":"integer"},"name":"isRequired","in":"query","description":"Filter by isRequired flag","required":false},{"schema":{"type":"integer"},"name":"haveOptions","in":"query","description":"Set to 1 to show only results that have options set","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}}}}}}}
```

## Add a new Tag

> Add a new Tag

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"tags","description":"Tags"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Tag":{"properties":{"tagId":{"description":"The Tag ID","type":"integer"},"tag":{"description":"The Tag Name","type":"string"},"isSystem":{"description":"Flag, whether the tag is a system tag","type":"integer"},"isRequired":{"description":"Flag, whether the tag requires additional values","type":"integer"},"options":{"description":"An array of options assigned to this Tag"}}}}},"paths":{"/tag":{"post":{"tags":["tags"],"summary":"Add a new Tag","description":"Add a new Tag","operationId":"tagAdd","responses":{"201":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"isRequired":{"type":"integer","description":"A flag indicating whether value selection on assignment is required"},"options":{"type":"string","description":"A comma separated string of Tag options"}},"required":[]}}}}}}}}
```

## Edit existing Tag

> Edit existing Tag

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"tags","description":"Tags"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Tag":{"properties":{"tagId":{"description":"The Tag ID","type":"integer"},"tag":{"description":"The Tag Name","type":"string"},"isSystem":{"description":"Flag, whether the tag is a system tag","type":"integer"},"isRequired":{"description":"Flag, whether the tag requires additional values","type":"integer"},"options":{"description":"An array of options assigned to this Tag"}}}}},"paths":{"/tag/{tagId}":{"put":{"tags":["tags"],"summary":"Edit existing Tag","description":"Edit existing Tag","operationId":"tagEdit","responses":{"201":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"isRequired":{"type":"integer","description":"A flag indicating whether value selection on assignment is required"},"options":{"type":"string","description":"A comma separated string of Tag options"}},"required":[]}}}}}}}}
```

## Delete Tag

> Delete a Tag

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"tags","description":"Tags"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/tag/{tagId}":{"delete":{"tags":["tags"],"summary":"Delete Tag","description":"Delete a Tag","operationId":"tagDelete","parameters":[{"schema":{"type":"integer"},"name":"tagId","in":"path","description":"The Tag ID to delete","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/integrate/openapi/tags.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.