Skip to navigation
Agents (Jockey)Knowledge store itemsItem tags

Create an item tag

This method tags a moment or a range of a video item and returns the tag. Set start_sec to tag a moment. Set start_sec and end_sec to tag a range. A video item holds up to 100 tags. The method returns a 422 error for an item that is not a video item, and when the item already holds 100 tags.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Path parameters

knowledge_store_idstringRequired
The unique identifier of the knowledge store.
item_idstringRequired
The unique identifier of the knowledge store item.

Request

This endpoint expects an object.
start_secdoubleRequired>=0
The start of the tag, in seconds from the start of the video. It must be less than the duration of the video.
tag_metadatamap from strings to strings or integers or doubles or booleans or lists of stringsRequired

The custom metadata of the tag, as key-value pairs. Send at least one key. Up to 50 pairs. Keys are strings of up to 128 characters. String values can have up to 8192 characters. Values can be a string, a number, a boolean, or an array of strings. A nested object, an array containing anything other than strings, and a null value are rejected. An integer must fit in 53 bits (-9007199254740991 to 9007199254740991). Send a wider integer, or an identifier that must be preserved verbatim, as a string.

end_secdouble or nullOptional

The end of the range, in seconds from the start of the video. It must be greater than start_sec. It must not exceed the duration of the video. Omit it, or send null, to tag a single moment.

Response

The item tag has been successfully created.
_idstringRead-only
The unique identifier of the item tag.
knowledge_store_idstring
The unique identifier of the knowledge store.
item_idstring
The unique identifier of the knowledge store item that holds the tag.
start_secdouble
The start of the tag, in seconds from the start of the video.
end_secdouble or null

The end of the range, in seconds from the start of the video. The value is null for a tag on a single moment.

tag_metadatamap from strings to strings or integers or doubles or booleans or lists of strings
The custom metadata of the tag. Keys are strings. Each value is a string, a number, a boolean, or an array of strings.
created_atstringRead-onlyformat: "date-time"
The date and time when the tag was created, in the RFC 3339 format.
updated_atstringRead-onlyformat: "date-time"
The date and time when the tag was last updated, in the RFC 3339 format.

Errors

400
Bad Request Error
404
Not Found Error
422
Unprocessable Entity Error