Get dynamic tag by id — Coactive AI

Get information about a specific dynamic tag using the id

Path parameters

category_idstringRequired

The unique identifier for the category

dynamic_tag_idstringRequired

The unique identifier for the dynamic tag

Response

This endpoint returns an object.

createdUserIdstring

The user that created the resource

createdDtdatetime

The created datetime of the resource

updatedUserIdstring

The user that last updated the resource

updatedDtdatetime

The datetime the resource was last updated

dynamicTagIdstring

The unique identifier of the dynamic tag

namestring

The name of the dynamic tag

categoryNamestring

Category name associated with tag

datasetslist of objects

The datasets associated with tag

textPromptslist of objectsOptional

The list of text prompts for this dynamic tag

visualPromptslist of objectsOptional

The list of visual prompts for this dynamic tag

1 curl https://app.coactive.ai/api/v1/dynamic-tag-categories/category_id/dynamic-tags/dynamic_tag_id \ 2 -H "Authorization: Bearer <token>"

1 { 2 "createdUserId": "user_example", 3 "createdDt": "2018-09-11T15:11:45Z", 4 "updatedUserId": "user_example", 5 "updatedDt": "2018-09-11T15:11:45Z", 6 "dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044", 7 "name": "Husky", 8 "categoryName": "Dog", 9 "datasets": [ 10 { 11 "id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e", 12 "name": "GameOfThrones" 13 } 14 ], 15 "textPrompts": [ 16 { 17 "dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044", 18 "text": "text prompt example" 19 } 20 ], 21 "visualPrompts": [ 22 { 23 "assetType": "image", 24 "coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10", 25 "previewImages": { 26 "thumb": { 27 "url": "/path/to/kingslanding_041711.jpeg?size=thumb" 28 }, 29 "small": { 30 "url": "/path/to/kingslanding_041711.jpeg?size=small" 31 }, 32 "regular": { 33 "url": "/path/to/kingslanding_041711.jpeg?size=regular" 34 }, 35 "full": { 36 "url": "/path/to/kingslanding_041711.jpeg?size=full" 37 } 38 }, 39 "createdDt": "2018-09-11T15:11:45Z", 40 "updatedDt": "2018-09-11T15:11:45Z", 41 "dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044", 42 "path": "s3://coactive-public/logo.png", 43 "video": { 44 "url": "/path/to/kingslanding_041711.jpeg", 45 "id": "5cf18348-8336-4db7-bb35-db7fbfe8951d", 46 "startTimeMs": 0, 47 "endTimeMs": 1000 48 }, 49 "shot": { 50 "id": "5007b9b7-0d74-4054-bbc7-cd9d2333ca8f", 51 "startTimeMs": 0, 52 "endTimeMs": 1000 53 }, 54 "sensitive": true, 55 "audioSegment": { 56 "startTimeMs": 0, 57 "endTimeMs": 1000, 58 "speechToTextTranscription": "Winter is coming." 59 }, 60 "similaritySearchScore": 0.3, 61 "imageId": "some-id", 62 "format": ".jpg", 63 "metadata": { 64 "artist": "Marc Simonetti" 65 } 66 } 67 ] 68 }

1	curl https://app.coactive.ai/api/v1/dynamic-tag-categories/category_id/dynamic-tags/dynamic_tag_id \
2	-H "Authorization: Bearer <token>"

1	{
2	"createdUserId": "user_example",
3	"createdDt": "2018-09-11T15:11:45Z",
4	"updatedUserId": "user_example",
5	"updatedDt": "2018-09-11T15:11:45Z",
6	"dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
7	"name": "Husky",
8	"categoryName": "Dog",
9	"datasets": [
10	{
11	"id": "c40276f0-024b-4a3f-b3e6-dcf0d304843e",
12	"name": "GameOfThrones"
13	}
14	],
15	"textPrompts": [
16	{
17	"dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
18	"text": "text prompt example"
19	}
20	],
21	"visualPrompts": [
22	{
23	"assetType": "image",
24	"coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
25	"previewImages": {
26	"thumb": {
27	"url": "/path/to/kingslanding_041711.jpeg?size=thumb"
28	},
29	"small": {
30	"url": "/path/to/kingslanding_041711.jpeg?size=small"
31	},
32	"regular": {
33	"url": "/path/to/kingslanding_041711.jpeg?size=regular"
34	},
35	"full": {
36	"url": "/path/to/kingslanding_041711.jpeg?size=full"
37	}
38	},
39	"createdDt": "2018-09-11T15:11:45Z",
40	"updatedDt": "2018-09-11T15:11:45Z",
41	"dynamicTagId": "f5fc1a7b-0eb2-43e2-9e0b-185cc31df044",
42	"path": "s3://coactive-public/logo.png",
43	"video": {
44	"url": "/path/to/kingslanding_041711.jpeg",
45	"id": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
46	"startTimeMs": 0,
47	"endTimeMs": 1000
48	},
49	"shot": {
50	"id": "5007b9b7-0d74-4054-bbc7-cd9d2333ca8f",
51	"startTimeMs": 0,
52	"endTimeMs": 1000
53	},
54	"sensitive": true,
55	"audioSegment": {
56	"startTimeMs": 0,
57	"endTimeMs": 1000,
58	"speechToTextTranscription": "Winter is coming."
59	},
60	"similaritySearchScore": 0.3,
61	"imageId": "some-id",
62	"format": ".jpg",
63	"metadata": {
64	"artist": "Marc Simonetti"
65	}
66	}
67	]
68	}