Get image detail by coactive image id or dataset id and image path. Either coactive image id or or a combination of dataset id and image path can be used to uniquely identify an image.

Get image detail

Get video detail by coactive image id or dataset id and video path. Either coactive video id or or a combination of dataset id and video path can be used to uniquely identify a video.

Get video detail

Asset

Classify an image downloadable via a public url for specific concepts or all concepts within a dataset

Threshold above which classification is positive

Classify image at public url

Classification

Get paginated concepts, optionally filtered by datasets

List concepts

Create concept

Get concept

Delete concept

Update concept

List of labels types to include, leave blank to return all

Get labels

Update labels for a concept. Label requests containing coactive image ids or image paths already in use will overwrite existing labels. Label requests with an empty label value will delete an existing label for that image/keyframe identifier.

Update labels

Get images and keyframes to label in order to improve the concept

The concept id to get candidates to label

Get label candidates

A higher value results in wider confidence intervals, with more confidence of correctness. A lower value results in narrower confidence intervals, with less confidence of correctness

A higher value makes estimation slower, but more accurate. A lower value makes estimation faster, but less accurate

Get concept's prediction estimation

Concept

Add credentials to access data in your Amazon Web Services account

Body_add_aws_credentials_api_v1_credentials_aws_post

Add AWS credentials

Add credentials to access data in your Google Cloud Platform account

Body_add_gcp_credentials_api_v1_credentials_gcp_post

Add GCP credentials

Validate AWS or GCP credentials previously added to Coactive are configured properly

Validate credentials

Credentials

List datasets

Create dataset

Get dataset

Delete dataset

Update dataset

Get images

Get videos

Add images and/or videos to an existing dataset

Add assets

Update image and/or video metadata in an existing dataset

Update asset metadata

The coactive unique identifier for the image to delete

Delete image

The coactive unique identifier for the video to delete

Delete video

Dataset

Get paginated categories, optionally filtered by datasets

List categories

Create category

Get paginated dynamic tags, filtered by datasets

List dynamic tags

Create dynamic tag

Get category by id

Get information about a specific dynamic tag using the id

The unique identifier for the dynamic tag

Get dynamic tag by id

Triggers the update of a dynamic tag's prompts in our platform. Notice that the results may take a while to be reflected in the system. On success, no content is returned in the response.

Update a dynamic tag's prompts

Images most similar to text and visual prompts of the provided dynamic tag

Get Top Content

Dynamic Tags

Get paginated list of queries. If query ids are provided, the returned list will include only those queries. Queries not found from the provided ids list will be ignored.

List queries

Create and enqueue the execution of a SQL query

Create query

Get query including paginated results if the query execution is complete

Max number of items to return in the results

Optionally exclude results from the response

Get query

Delete query

Stop the execution of a running or waiting query

Stop query

Get a url to download query results as a CSV

Get query results url

Query

Perform a visual and audio search of a dataset using a natural language (text) query

The encoder to use to search within this dataset.Only applicable if dataset has multiple embeddings.Will use default dataset embedding if None.

JSON string containing a list of metadata filters

Search dataset

Get the images most similar to the image provided within the same dataset

A public url to an image not in this dataset to use for similarity search

A coactive image id in this dataset to use for similarity search

An image path in this dataset to use for similarity search

Get similar images in dataset

Search

AddAssetsConfirmation

Unique request id for this group of assets.

Details about an image to add to a dataset

AddImageRequest

Details about an video to add to a dataset

AddVideoRequest

Confirmation of an image added to the dataset

AddedImage

The datetime the resource was last updated

Confirmation of a video added to the dataset

AddedVideo

AppSharedV0SchemaShot

The start time in milliseconds from the beginning of the video

The end time in milliseconds from the beginning of the video

AssetTypeEnum

AudioSegment

The start time in milliseconds of the beginning of the audio clip

The end time in milliseconds of the end of the audio clip

BasicDescription

A list of selected images or video keyframes to label to improve the accuracy of the
concept

CandidatesToLabel

Data about a category that can be used to query many datasets and dynamic tags

CategoryResponse

A classification of an asset for one or more concepts

Classifications of images for the relevant concept(s)

A classification of an asset for a single concept

ClassificationScore

The threshold used to determine if it's a positive example

The classification score in the range [0, 1]

Data about a concept that can be used to query a dataset

How strongly the model adapts to the training labels. Regularization strength. Lower value means the model fits more heavily to the training data

An association of an image or video keyframe to a concept

ConceptLabel

The label for the image or video keyframe

The labelled image (if the labelled image is not a video keyframe)

The labelled video keyframe (if the labelled image is a video keyframe)

ConceptLabelEnum

An request to associate an image or video keyframe to a concept

ConceptLabelRequest

The id of image or video keyframe to label

The label for the image or video keyframe. "negative" means the image or keyframe is not an example of the concept. "positive" means the image or keyframe is example of the concept. An empty value indicates the label should be removed if one exists.

ConceptPredictionResponse

Each tuple represents the bounds of a bin we estimated number of assets for

Number of assets belonging to each probability range

Lower/upper bounds representing respective ranges that the actual number of assets is in

Credentials used to access data in your organization's cloud account

A response for a test of the configuration of an IAM role for a given data path

CredentialsValidation

The absolute path to the data in cloud storage to use to test access

True if data can be read at the specified data path using the credentials

True if the dataset is in a state in which it can be deleted

The number of fully processed images in the dataset

The number of fully processed videos in the dataset

The name of the encoder to transform your image and video data

DatasetStatusEnum

The base model for any single resource HTTP response

DynamicTagResponse

The list of text prompts for this dynamic tag

The list of visual prompts for this dynamic tag

EncoderNameEnum

ErrorResponse

HTTPValidationError

Image

ImageOrKeyframe

ImageOrKeyframeCandidate

KeyTypeEnum

Keyframe

The timestamp of the keyframe in the video in milliseconds

PagedCategories

PagedConceptLabels

PagedConcepts

PagedDatasets

PagedDynamicTags

A paginated list of images in the dataset

PagedImages

PagedLinksResponse

PagedMetaResponse

Helpful links to other pages in the pagination

Ordered list of fields to sort on, order of list determines priority

PagedPageDetailsResponse

Max page number based on limit and total number of items

PagedQueries

A paginated list of videos in the dataset

PagedVideos

PreviewImages

A max 200px × max 200px preview of the asset

Defines if the query is in an active state or not

QueryResult

Metadata for the pagination of the query result

QueryResultsDownloadUrl

QueryRow

QueryStatusEnum

QueryWithResult

SearchResult

SearchTypeEnum

Shot

SortDirectionEnum

Metadata about the sort order of the response

SortItem

TextPrompt

The unique identifier of the dynamic tag this text prompt belongs to

UpdateAssetsMetadataConfirmation

A request to fully replace the metadata for an image. Provide one of image path or coactive
image id.

UpdateImageMetadataRequest

A request to fully replace the metadata for a video. Provide one of video path or coactive
video id.

1	curl -X PUT https://app.coactive.ai/api/v1/datasets/dataset_id/assets-metadata \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"images": [
6	{
7	"path": "s3://coactive-public/logo.png",
8	"metadata": {
9	"artist": "Marc Simonetti"
10	}
11	}
12	],
13	"videos": [
14	{
15	"path": "s3://your-s3-bucket/path/to/video.mp4",
16	"metadata": {
17	"artist": "Marc Simonetti"
18	}
19	}
20	]
21	}'

1	{
2	"requestGroupId": "5b9a8217-2c73-41cf-9b3c-8a10b6ade206",
3	"images": [
4	{
5	"createdUserId": "user_example",
6	"createdDt": "2018-09-11T15:11:45Z",
7	"updatedUserId": "user_example",
8	"updatedDt": "2018-09-11T15:11:45Z",
9	"coactiveImageId": "a6894d72-612d-4c20-b4d0-8f3f21c2bb10",
10	"path": "s3://your-s3-bucket/path/to/video.mp4",
11	"id": "some-id",
12	"metadata": {
13	"artist": "Marc Simonetti"
14	},
15	"requestId": "dd631c39-daba-4f46-be46-ab6c38a02e0f",
16	"requestDt": "2018-09-11T15:11:45Z"
17	}
18	],
19	"videos": [
20	{
21	"createdUserId": "user_example",
22	"createdDt": "2018-09-11T15:11:45Z",
23	"updatedUserId": "user_example",
24	"updatedDt": "2018-09-11T15:11:45Z",
25	"path": "s3://your-s3-bucket/path/to/video.mp4",
26	"coactiveVideoId": "5cf18348-8336-4db7-bb35-db7fbfe8951d",
27	"metadata": {
28	"show": "The Boys",
29	"season": 1,
30	"episode": 1,
31	"title": "The Name of the Game"
32	},
33	"requestId": "dd631c39-daba-4f46-be46-ab6c38a02e0f",
34	"requestDt": "2018-09-11T15:11:45Z"
35	}
36	]
37	}

Path parameters

Request

Response