Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Properties

Create property

Creates property and property values for given team.

post/api/v2/teams/{team_slug}/properties

Path parameters

team_slugstring required

Team's sluggified name

Request body

annotation_class_idinteger

Annotation class id

dataset_idsinteger[]

List of dataset ids associated with the property. Can be set only when granularity is item

descriptionstring

Description of property

granularity'item' | 'annotation' | 'section'
max_duration_secondsnumber nullable

Maximum recording duration in seconds. Only allowed on audio properties. Must be greater than 0 and at most 3600 (1 hour). Null means no upper bound; on update, an explicit null clears the bound while omitting the field leaves it unchanged.

min_duration_secondsnumber nullable

Minimum recording duration in seconds. Only allowed on audio properties. Must be greater than 0, at most 3600 (1 hour), and not exceed max_duration_seconds. Null means no lower bound; on update, an explicit null clears the bound while omitting the field leaves it unchanged.

namestring required

Name of property

parent_property_idstring uuid nullable

UUID of the parent property for nested properties

positioninteger

Position of property in list

requiredboolean

Indicates if property is required

type'single_select' | 'multi_select' | 'boolean' | 'text' | 'audio' required

Response

Annotations.Property.PropertyResponse

annotation_class_idinteger nullable required

Annotation class id

dataset_idsinteger[] required

List of dataset ids associated with the property. Can be set only when granularity is item

descriptionstring

Description of property

granularity'item' | 'annotation' | 'section' required
idstring uuid required
inserted_atstring date-time required

DateTime in RFC3339 format

max_duration_secondsnumber nullable

Maximum recording duration in seconds. Only allowed on audio properties. Must be greater than 0 and at most 3600 (1 hour). Null means no upper bound; on update, an explicit null clears the bound while omitting the field leaves it unchanged.

min_duration_secondsnumber nullable

Minimum recording duration in seconds. Only allowed on audio properties. Must be greater than 0, at most 3600 (1 hour), and not exceed max_duration_seconds. Null means no lower bound; on update, an explicit null clears the bound while omitting the field leaves it unchanged.

namestring required

Name of property

parent_property_idstring uuid nullable

UUID of the parent property. Null for top-level properties.

positioninteger nullable

Position of property in list

requiredboolean required

Indicates if property is required

slugstring required

Name's slug of property

team_idinteger required

Team id

type'single_select' | 'multi_select' | 'boolean' | 'text' | 'audio' required

Example response

{
  "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "inserted_at": "2020-01-20T14:00:00Z",
  "property_values": [
    {
      "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    }
  ]
}