{"openapi":"3.1.0","info":{"title":"API Reference","version":"1.0.0"},"paths":{"/api/v0/chat":{"post":{"operationId":"chat","summary":"Chat","description":"Chat endpoint that processes user input with LLM and MCP video search integration for select datasets in the org. Please contact Coactive Support to configure the datasets required.","tags":["agentic-search > agenticSearch"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agentic-search:ChatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agentic-search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/agentic-search:ChatRequest"}}}}}},"/api/v0/chat/dataset/{dataset_id}":{"post":{"operationId":"chat-dataset","summary":"Chat Dataset","description":"Chat endpoint that processes user input with LLM and MCP video search integration for a specific dataset.","tags":["agentic-search > agenticSearch"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agentic-search:ChatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/agentic-search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/agentic-search:ChatRequest"}}}}}},"/api/v0/celebrity-detection/person/{person_id}":{"get":{"operationId":"get-person-api-v-0-celebrity-detection-person-person-id-get","summary":"Get a person by id","tags":["celebrity-detection"],"parameters":[{"name":"person_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:GetPersonResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}}}},"/api/v0/celebrity-detection/persons":{"get":{"operationId":"get-persons-in-org-api-v-0-celebrity-detection-persons-get","summary":"Get all enrolled persons in org","tags":["celebrity-detection"],"parameters":[{"name":"page","in":"query","description":"Page number (1-indexed)","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","description":"Number of items per page","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"sort_field","in":"query","description":"Field to sort by","required":false,"schema":{"type":["string","null"]}},{"name":"sort_direction","in":"query","description":"Sort direction","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/celebrity-detection:SortDirection"},{"type":"null"}]}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:GetPersonsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}}}},"/api/v0/celebrity-detection/faces-with-person":{"get":{"operationId":"get-faces-with-person-api-v-0-celebrity-detection-faces-with-person-get","summary":"Get faces with a person","tags":["celebrity-detection"],"parameters":[{"name":"person_id","in":"query","description":"Person ID","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"person_name","in":"query","description":"Person name","required":false,"schema":{"type":["string","null"]}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:GetFacesWithPersonResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}}}},"/api/v0/celebrity-detection/persons/by-names-and-aliases":{"get":{"operationId":"get-persons-by-names-and-aliases-api-v-0-celebrity-detection-persons-by-names-and-aliases-get","summary":"Get person IDs from a list of names or aliases","tags":["celebrity-detection"],"parameters":[{"name":"person_names_or_aliases","in":"query","description":"List of person names or aliases to search for","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:GetPersonsByNamesAliasesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}}}},"/api/v0/celebrity-detection/persons-in-image/{image_id}":{"get":{"operationId":"get-persons-in-image-api-v-0-celebrity-detection-persons-in-image-image-id-get","summary":"Get persons in an image","tags":["celebrity-detection"],"parameters":[{"name":"image_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:GetPersonsInImageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}}}},"/api/v0/celebrity-detection/identify":{"get":{"operationId":"identify-celebrities-in-external-image-api-v-0-celebrity-detection-identify-get","summary":"Identify celebrities in an external image","tags":["celebrity-detection"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:IdentifyCelebritiesInExternalImageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:IdentifyCelebritiesInExternalImageRequest"}}}}}},"/api/v0/celebrity-detection/person/aliases":{"put":{"operationId":"update-person-aliases-api-v-0-celebrity-detection-person-aliases-put","summary":"Update person aliases","tags":["celebrity-detection"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:GetPersonResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/celebrity-detection:UpdatePersonAliasesRequest"}}}}}},"/api/v1/classify/image/url":{"post":{"operationId":"classify-image-at-url","summary":"Classify image at public url","description":"Classify an image downloadable via a public url for specific concepts or all concepts within a dataset","tags":["classification"],"parameters":[{"name":"threshold","in":"query","description":"Threshold above which classification is positive","required":false,"schema":{"type":"number","format":"double","default":0.5}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Result of the classification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Classification"}}}},"404":{"description":"Dataset not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUrlClassificationRequest"}}}}}},"/api/v1/concepts":{"post":{"operationId":"create","summary":"Create concept","description":"Create a new concept","tags":["concept"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The created concept","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"400":{"description":"Invalid concept name","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConceptRequest"}}}}},"get":{"operationId":"list","summary":"List concepts","description":"Get paginated concepts, optionally filtered by datasets","tags":["concept"],"parameters":[{"name":"datasets","in":"query","description":"Datasets to use to filter concepts","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid4"}}},{"name":"offset","in":"query","description":"Starting index to return","required":false,"schema":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0}},{"name":"limit","in":"query","description":"Max number of items to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":9223372036854776000,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"All concepts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedConcepts"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/concepts/{concept_id}":{"delete":{"operationId":"delete","summary":"Delete concept","description":"Delete concept","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The unique identifier for the concept","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"operationId":"get","summary":"Get concept","description":"Get concept","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The unique identifier for the concept","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Concept details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"operationId":"update","summary":"Update concept","description":"Update concept","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The unique identifier for the concept","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Concept details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConceptRequest"}}}}}},"/api/v1/concepts/{concept_id}/prediction_estimation":{"get":{"operationId":"get-concept-prediction","summary":"Get concept's prediction estimation","description":"Get concept's prediction estimation","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The unique identifier for the concept","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"threshold","in":"query","description":"Threshold above which classification is positive","required":false,"schema":{"type":"number","format":"double","default":0.5}},{"name":"confidence_level","in":"query","description":"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","required":false,"schema":{"type":"number","format":"double","default":0.95}},{"name":"estimation_fidelity","in":"query","description":"A higher value makes estimation slower, but more accurate. A lower value makes estimation faster, but less accurate","required":false,"schema":{"type":"integer","default":1000}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Concept prediction estimation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConceptPredictionResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/concepts/{concept_id}/candidates":{"get":{"operationId":"get-label-candidates","summary":"Get label candidates","description":"Get images and keyframes to label in order to improve the concept","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The concept id to get candidates to label","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"limit","in":"query","description":"Max number of items to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":20,"default":1}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Candidates to label in order to improve the concept","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CandidatesToLabel"}}}},"404":{"description":"Concept not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/concepts/{concept_id}/labels":{"get":{"operationId":"get-labels","summary":"Get labels","description":"Get all labels for a concept","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The unique identifier for the concept","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"offset","in":"query","description":"Starting index to return","required":false,"schema":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0}},{"name":"limit","in":"query","description":"Max number of items to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":9223372036854776000,"default":100}},{"name":"labels_to_include","in":"query","description":"List of labels types to include, leave blank to return all","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ConceptLabelEnum"}}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Paginated labels for the concept","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedConceptLabels"}}}},"404":{"description":"Concept not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"operationId":"update-labels","summary":"Update labels","description":"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.","tags":["concept"],"parameters":[{"name":"concept_id","in":"path","description":"The unique identifier for the concept","required":true,"schema":{"type":"string","format":"uuid4"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated concept","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Concept"}}}},"404":{"description":"Concept not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConceptLabelsRequest"}}}}}},"/api/v0/connections":{"post":{"operationId":"create-connection-api-v-0-connections-post","summary":"Create Connection","description":"Create a new connection to an external data source","tags":["connections > connections"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:GetConnectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:Connections_create_connection_api_v0_connections_post_Request"}}}}},"get":{"operationId":"list-connections-api-v-0-connections-get","summary":"List Connections","description":"List all connections with optional filtering","tags":["connections > connections"],"parameters":[{"name":"status","in":"query","description":"Filter by connection status","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/connections:ConnectionStatus"},{"type":"null"}]}},{"name":"connection_type","in":"query","description":"Filter by connection type","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/connections:ConnectionType"},{"type":"null"}]}},{"name":"offset","in":"query","description":"Number of items to skip","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Maximum number of items to return","required":false,"schema":{"type":"integer","default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:ListConnectionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":["array","null"],"items":{"type":"string","format":"uuid"}}}}}}},"/api/v0/connections/{connection_name_or_id}":{"delete":{"operationId":"delete-connection-api-v-0-connections-connection-name-or-id-delete","summary":"Delete Connection","description":"Delete a connection","tags":["connections > connections"],"parameters":[{"name":"connection_name_or_id","in":"path","description":"The connection name or UUID","required":true,"schema":{"$ref":"#/components/schemas/connections:ApiV0ConnectionsConnectionNameOrIdDeleteParametersConnectionNameOrId"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:GetConnectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}}},"get":{"operationId":"get-connection-api-v-0-connections-connection-name-or-id-get","summary":"Get Connection","description":"Retrieve a connection by name or ID","tags":["connections > connections"],"parameters":[{"name":"connection_name_or_id","in":"path","description":"The connection name or UUID","required":true,"schema":{"$ref":"#/components/schemas/connections:ApiV0ConnectionsConnectionNameOrIdGetParametersConnectionNameOrId"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:GetConnectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}}},"patch":{"operationId":"update-connection-api-v-0-connections-connection-name-or-id-patch","summary":"Update Connection","description":"Update a connection's name or description","tags":["connections > connections"],"parameters":[{"name":"connection_name_or_id","in":"path","description":"The connection name or UUID","required":true,"schema":{"$ref":"#/components/schemas/connections:ApiV0ConnectionsConnectionNameOrIdPatchParametersConnectionNameOrId"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:GetConnectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:UpdateConnectionRequest"}}}}}},"/api/v0/connections/{connection_name_or_id}/credentials":{"get":{"operationId":"get-connection-credentials-api-v-0-connections-connection-name-or-id-credentials-get","summary":"Get Connection Credentials","description":"Get temporary AWS credentials for a connection","tags":["connections > connections"],"parameters":[{"name":"connection_name_or_id","in":"path","description":"The connection name or UUID","required":true,"schema":{"$ref":"#/components/schemas/connections:ApiV0ConnectionsConnectionNameOrIdCredentialsGetParametersConnectionNameOrId"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:GetConnectionCredentialsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}}}},"/api/v0/connections/{connection_name_or_id}/list":{"post":{"operationId":"list-with-connection-api-v-0-connections-connection-name-or-id-list-post","summary":"List With Connection","description":"List S3 bucket contents using the connection credentials","tags":["connections > connections"],"parameters":[{"name":"connection_name_or_id","in":"path","description":"The connection name or UUID","required":true,"schema":{"$ref":"#/components/schemas/connections:ApiV0ConnectionsConnectionNameOrIdListPostParametersConnectionNameOrId"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:ListWithConnectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:ListWithConnectionRequest"}}}}}},"/api/v0/connections/{connection_name_or_id}/test":{"post":{"operationId":"test-connection-api-v-0-connections-connection-name-or-id-test-post","summary":"Test Connection","description":"Test a connection to verify it works correctly","tags":["connections > connections"],"parameters":[{"name":"connection_name_or_id","in":"path","description":"The connection name or UUID","required":true,"schema":{"$ref":"#/components/schemas/connections:ApiV0ConnectionsConnectionNameOrIdTestPostParametersConnectionNameOrId"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:GetConnectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connections:TestConnectionRequest"}}}}}},"/api/v1/datasets/{dataset_id}/videos/external-identifier/{asset_identifier_value}/ad-segments":{"post":{"operationId":"create-ad-segments","summary":"Create ad segments for a video","description":"Creates ad segments for the video identified by the provided asset identifier value.","tags":["context-studio > adSegments"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"asset_identifier_value","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:VideoAdSegmentsCreateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:VideoAdSegmentsCreateRequest"}}}}},"delete":{"operationId":"delete-ad-segments","summary":"Delete ad segment metadata for a video","description":"Soft-deletes the ad-segment composite for the video identified by the provided asset identifier value. If no ad segments exist for the video, the request still succeeds with 204 No Content.","tags":["context-studio > adSegments"],"parameters":[{"name":"dataset_id","in":"path","description":"The Coactive-internal unique identifier for the dataset the video belongs to.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"asset_identifier_value","in":"path","description":"The customer's own internal asset identifier for the video.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"401":{"description":"Missing or invalid authentication.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:HTTPValidationError"}}}},"403":{"description":"Caller is not authorized to delete assets in this dataset.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:HTTPValidationError"}}}},"404":{"description":"No video found matching the provided asset_identifier_value, or the dataset does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:HTTPValidationError"}}}},"422":{"description":"Invalid path parameter, missing gateway identity headers, or multiple videos match the provided asset_identifier_value.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:HTTPValidationError"}}}}}},"get":{"operationId":"get-ad-segments","summary":"Retrieve ad segments for a video","description":"Returns all ad segments stored for the video identified by the provided asset identifier value.","tags":["context-studio > adSegments"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"asset_identifier_value","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:VideoAdSegmentsGetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/context-studio:HTTPValidationError"}}}}}}},"/api/v1/datasets":{"post":{"operationId":"create-dataset-api-v-1-datasets-post","summary":"Create Dataset","description":"Create a new dataset","tags":["datasets > dataset"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetCreateRequest"}}}}},"get":{"operationId":"get-datasets-api-v-1-datasets-get","summary":"Get Datasets","description":"Get all datasets in a paginated list","tags":["datasets > dataset"],"parameters":[{"name":"dataset_ids","in":"query","required":false,"schema":{"type":["array","null"],"items":{"type":"string","format":"uuid"}}},{"name":"status","in":"query","required":false,"schema":{"type":["array","null"],"items":{"$ref":"#/components/schemas/datasets:DatasetStatusEnum"}}},{"name":"allowed_asset_types","in":"query","required":false,"schema":{"type":["array","null"],"items":{"$ref":"#/components/schemas/datasets:AssetTypeEnum"}}},{"name":"keyframe_sampling_method","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/datasets:KeyframeSamplingMethodEnum"},{"type":"null"}]}},{"name":"store_original","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"store_preview","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"created_before","in":"query","required":false,"schema":{"type":["string","null"],"format":"date-time"}},{"name":"created_after","in":"query","required":false,"schema":{"type":["string","null"],"format":"date-time"}},{"name":"last_updated_before","in":"query","required":false,"schema":{"type":["string","null"],"format":"date-time"}},{"name":"last_updated_after","in":"query","required":false,"schema":{"type":["string","null"],"format":"date-time"}},{"name":"name_pattern","in":"query","required":false,"schema":{"type":["string","null"]}},{"name":"new_video_data_model","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"celebrity_detection_enabled","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"context_studio_enabled","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":100}},{"name":"include_deleted","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetGetManyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:HTTPValidationError"}}}}}}},"/api/v1/datasets/{dataset_id}":{"delete":{"operationId":"delete-dataset-by-id-api-v-1-datasets-dataset-id-delete","summary":"Delete Dataset By Id","description":"Delete a dataset by its unique identifier","tags":["datasets > dataset"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:HTTPValidationError"}}}}}},"get":{"operationId":"get-dataset-by-id-api-v-1-datasets-dataset-id-get","summary":"Get Dataset By Id","description":"Get a dataset by its unique identifier","tags":["datasets > dataset"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_deleted","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:HTTPValidationError"}}}}}},"patch":{"operationId":"update-dataset-by-id-api-v-1-datasets-dataset-id-patch","summary":"Update Dataset By Id","description":"Update a dataset by its unique identifier","tags":["datasets > dataset"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetUpdateRequest"}}}}}},"/api/v1/datasets/{dataset_id}/config":{"get":{"operationId":"get-dataset-config-api-v-1-datasets-dataset-id-config-get","summary":"Get Dataset Config","description":"Retrieve configuration for a dataset from the dataset_config JSONB column.","tags":["datasets > datasetConfig"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_deleted","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:DatasetConfigResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/datasets:HTTPValidationError"}}}}}}},"/api/v1/encoders":{"get":{"operationId":"list-available-encoders-api-v-1-encoders-get","summary":"List Available Encoders","description":"List available encoders","tags":["datasets > encoder"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/datasets:EncoderDescription"}}}}}}}},"/api/v3/dynamic-tags/groups":{"get":{"operationId":"list-groups","summary":"Retrieve a paginated list of groups","description":"Retrieves a paginated list of dynamic tag groups. Supports filtering by name, version name, or status.","tags":["dynamicTags"],"parameters":[{"name":"name","in":"query","description":"Filter by group name","required":false,"schema":{"type":["string","null"]}},{"name":"name_contains","in":"query","description":"Filter by group name containing this string","required":false,"schema":{"type":["string","null"]}},{"name":"version_name","in":"query","description":"Filter by version name","required":false,"schema":{"type":["string","null"]}},{"name":"group_status","in":"query","description":"Filter by status","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/DynamicTagGroupVersionStatus"},{"type":"null"}]}},{"name":"group_ids","in":"query","description":"Filter by group IDs","required":false,"schema":{"type":["array","null"],"items":{"type":"string","format":"uuid"}}},{"name":"visual_encoder","in":"query","description":"Filter by visual encoder","required":false,"schema":{"type":["string","null"]}},{"name":"transcript_encoder","in":"query","description":"Filter by transcript encoder","required":false,"schema":{"type":["string","null"]}},{"name":"exclude_group_ids","in":"query","description":"Exclude groups with these IDs","required":false,"schema":{"type":["array","null"],"items":{"type":"string","format":"uuid"}}},{"name":"is_shareable","in":"query","description":"Whether to return only shareable groups","required":false,"schema":{"type":"boolean","default":false}},{"name":"created_user_id","in":"query","description":"Filter by user who created the group","required":false,"schema":{"type":["string","null"]}},{"name":"created_dt_from","in":"query","description":"Filter groups created on or after this date","required":false,"schema":{"type":["string","null"],"format":"date-time"}},{"name":"created_dt_to","in":"query","description":"Filter groups created before this date","required":false,"schema":{"type":["string","null"],"format":"date-time"}},{"name":"training_dataset_id","in":"query","description":"Filter by associated training dataset ID","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"page","in":"query","description":"Page number (1-indexed)","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","description":"Number of items per page","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25}},{"name":"sort_field","in":"query","description":"Field to sort by","required":false,"schema":{"type":"string","default":"name"}},{"name":"sort_direction","in":"query","description":"Sort direction","required":false,"schema":{"$ref":"#/components/schemas/DynamicTagSortDirection"}},{"name":"include_training_datasets","in":"query","description":"Include at most 10 associated datasets in the response","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_versions","in":"query","description":"Include the latest draft and published versions of the group in the response","required":false,"schema":{"type":"boolean","default":false}},{"name":"include_tags","in":"query","description":"Include at most 10 tag names in the response","required":false,"schema":{"type":"boolean","default":false}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicTagGetGroupsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v0/delete/assets":{"post":{"operationId":"delete-assets","summary":"Delete Assets","description":"Delete assets from a dataset by creating deletion jobs.  Supports deletion of up to 100 assets per request.  Assets can be identified by their Coactive Video/Image ID or path string.","tags":["ingestion"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Deletion jobs enqueued","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAssetsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAssetsRequest"}}}}}},"/api/v1/ingestion/metadata":{"post":{"operationId":"create-ingest-job-for-metadata-api-v-1-ingestion-metadata-post","summary":"Add/Update Metadata","description":"Update metadata for ingested assets","tags":["ingestion > ingest"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobForMetadataRequest"}}}}}},"/api/v1/ingestion/assets":{"post":{"operationId":"create-ingest-job-from-assets-api-v-1-ingestion-assets-post","summary":"Create Ingest Job From Assets","description":"Ingest assets directly, using a batch/list specification","tags":["ingestion > ingest"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobFromAssetsRequest"}}}}}},"/api/v1/ingestion/buckets":{"post":{"operationId":"create-ingest-job-from-bucket-api-v-1-ingestion-buckets-post","summary":"Create Ingest Job From Bucket","description":"Ingest assets from a bucket scan","tags":["ingestion > ingest"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobFromBucketRequest"}}}}}},"/api/v1/ingestion/files":{"post":{"operationId":"create-ingest-job-from-file-api-v-1-ingestion-files-post","summary":"Create Ingest Job From File","description":"Ingest assets from a CSV or JSON file","tags":["ingestion > ingest"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobFromFileRequest"}}}}}},"/api/v1/ingestion/images":{"post":{"operationId":"create-ingest-job-from-images-api-v-1-ingestion-images-post","summary":"Create Ingest Job From Images","description":"Ingest assets directly, using a batch/list specification","tags":["ingestion > ingest"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobFromImagesRequest"}}}}}},"/api/v1/ingestion/videos":{"post":{"operationId":"create-ingest-job-from-videos-api-v-1-ingestion-videos-post","summary":"Create Ingest Job From Videos","description":"Ingest assets directly, using a batch/list specification","tags":["ingestion > ingest"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:CreateIngestJobFromVideosRequest"}}}}}},"/api/v1/ingestion/jobs/{ingest_job_id}":{"get":{"operationId":"get-by-ingest-job-id-api-v-1-ingestion-jobs-ingest-job-id-get","summary":"Get By Ingest Job Id","description":"Returns Ingest Job by Ingest Job ID.","tags":["ingestion > status"],"parameters":[{"name":"ingest_job_id","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","minLength":24,"maxLength":24}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:GetOneIngestJobResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/datasets/{dataset_id}/assets/status":{"post":{"operationId":"get-dataset-assets-status-api-v-1-ingestion-datasets-dataset-id-assets-status-post","summary":"Get Dataset Assets Status","description":"Returns the ingestion status for assets in dataset by source path.","tags":["ingestion > status"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filter","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ingestion:EventFilter"},{"type":"null"}]}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:Status_get_dataset_assets_status_api_v1_ingestion_datasets__dataset_id__assets_status_post_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ingestion:GetDatasetAssetsStatusRequest"},{"type":"null"}]}}}}}},"/api/v1/ingestion/datasets/{dataset_id}/assets/status/count":{"get":{"operationId":"get-dataset-assets-status-count-api-v-1-ingestion-datasets-dataset-id-assets-status-count-get","summary":"Get Dataset Assets Status Count","description":"Returns the ingestion status count for assets in a dataset.","tags":["ingestion > status"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:DatasetAssetsStatusCountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/datasets/{dataset_id}/assets/status/summary":{"get":{"operationId":"get-dataset-assets-status-summary-api-v-1-ingestion-datasets-dataset-id-assets-status-summary-get","summary":"Get Dataset Assets Status Summary","description":"Returns the ingestion status summaries for assets.","tags":["ingestion > status"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"filter","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ingestion:EventFilter"},{"type":"null"}]}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:Status_get_dataset_assets_status_summary_api_v1_ingestion_datasets__dataset_id__assets_status_summary_get_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/datasets/{dataset_id}/status":{"get":{"operationId":"get-dataset-status-api-v-1-ingestion-datasets-dataset-id-status-get","summary":"Get Dataset Status","description":"Returns the ingestion status of a dataset.","tags":["ingestion > status"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:Status_get_dataset_status_api_v1_ingestion_datasets__dataset_id__status_get_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/images/{asset_id}/status":{"get":{"operationId":"get-image-asset-status-api-v-1-ingestion-images-asset-id-status-get","summary":"Get Image Asset Status","description":"Returns the ingestion status of an image asset.","tags":["ingestion > status"],"parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:Status_get_image_asset_status_api_v1_ingestion_images__asset_id__status_get_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/jobs":{"get":{"operationId":"get-ingest-jobs-api-v-1-ingestion-jobs-get","summary":"Get Ingest Jobs","description":"Returns (all) Ingest Jobs.","tags":["ingestion > status"],"parameters":[{"name":"dataset_id","in":"query","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"status","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/ingestion:IngestJobStatusEnum"},{"type":"null"}]}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:GetManyIngestJobsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/jobs/{ingest_job_id}/status":{"get":{"operationId":"get-job-status-api-v-1-ingestion-jobs-ingest-job-id-status-get","summary":"Get Job Status","description":"Returns the ingestion status of a job in a dataset.","tags":["ingestion > status"],"parameters":[{"name":"ingest_job_id","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","minLength":24,"maxLength":24}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","exclusiveMinimum":0,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:Status_get_job_status_api_v1_ingestion_jobs__ingest_job_id__status_get_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/ingestion/videos/{asset_id}/status":{"get":{"operationId":"get-video-asset-status-api-v-1-ingestion-videos-asset-id-status-get","summary":"Get Video Asset Status","description":"Returns the ingestion status of a video asset.","tags":["ingestion > status"],"parameters":[{"name":"asset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:Status_get_video_asset_status_api_v1_ingestion_videos__asset_id__status_get_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ingestion:HTTPValidationError"}}}}}}},"/api/v1/queries/{query_id}/cancel":{"post":{"operationId":"cancel-query-api-v-1-queries-query-id-cancel-post","summary":"Cancel Query","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/queries":{"post":{"operationId":"create-query-api-v-1-queries-post","summary":"Create Query","tags":["queries"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__CreateQueryRequest"}}}}},"get":{"operationId":"list-queries-api-v-1-queries-get","summary":"List Queries","tags":["queries"],"parameters":[{"name":"status","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/queries:QueryStatus"},{"type":"null"}]}},{"name":"dataset_id","in":"query","required":false,"schema":{"type":["string","null"],"format":"uuid"}},{"name":"exclude_no_code","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"exclude_code","in":"query","required":false,"schema":{"type":["boolean","null"]}},{"name":"query_types","in":"query","required":false,"schema":{"oneOf":[{"$ref":"#/components/schemas/queries:QueryType"},{"type":"null"}]}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__ListQueriesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:Body_list_queries_api_v1_queries_get"}}}}}},"/api/v1/queries/{query_id}":{"delete":{"operationId":"delete-query-api-v-1-queries-query-id-delete","summary":"Delete Query","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}},"get":{"operationId":"get-query-api-v-1-queries-query-id-get","summary":"Get Query","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/queries/{query_id}/exports":{"post":{"operationId":"export-query-api-v-1-queries-query-id-exports-post","summary":"Export Query","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__ExportQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:ExportQueryRequest"}}}}}},"/api/v1/queries/{query_id}/results":{"get":{"operationId":"get-query-results-url-api-v-1-queries-query-id-results-get","summary":"Get Query Results Url","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"url_format","in":"query","required":false,"schema":{"$ref":"#/components/schemas/queries:ApiV1QueriesQueryIdResultsGetParametersUrlFormat"}},{"name":"expiration_seconds","in":"query","required":false,"schema":{"type":"integer","default":900}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:GetQueryResultsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/datasets/{dataset_id}/tables/{table_name}":{"get":{"operationId":"get-table-api-v-1-datasets-dataset-id-tables-table-name-get","summary":"Get Table","tags":["queries"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"table_name","in":"path","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:Table"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/datasets/{dataset_id}/tables":{"get":{"operationId":"list-tables-api-v-1-datasets-dataset-id-tables-get","summary":"List Tables","tags":["queries"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:ListTablesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/queries/{query_id}/run":{"post":{"operationId":"run-query-api-v-1-queries-query-id-run-post","summary":"Run Query","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/queries/{query_id}/stop":{"post":{"operationId":"stop-query-api-v-1-queries-query-id-stop-post","summary":"Stop Query","tags":["queries"],"parameters":[{"name":"query_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/queries:HTTPValidationError"}}}}}}},"/api/v1/search/audio":{"post":{"operationId":"audio-search","summary":"Audio Search","description":"Find video segments where the spoken content matches a natural-language query. Use this to find moments by what was said, for example, thank you for your time or breaking news.Returns matching audio segments with the parent video, the transcript text, and timestamps so you can jump straight to the moment.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:app__api__routes__search__v1__schema__native_video_model_schema__SearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:AudioSearchRequest"}}}}}},"/api/v1/search/audio-sound":{"post":{"operationId":"audio-sound-search","summary":"Audio Sounds Search","description":"Find video segments containing a specific audio sound class, for example, Music, Dog, gunfire, or clapping.Returns ranked segments with timestamps and a confidence score.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:AudioSoundSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:AudioSoundSearchRequest"}}}}}},"/api/v1/search/celebrity/matches":{"post":{"operationId":"celebrity-matches-api-v-1-search-celebrity-matches-post","summary":"Celebrity Matches Search","description":"Find video frames that match a reference set of face images.Provide 15–100 upload IDs of reference images and get back ranked keyframe matches across the dataset's videos.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:NileSearchKeyframeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:CelebrityMatchesRequest"}}}}}},"/api/v1/search/text-to-hybrid-search":{"post":{"operationId":"hybrid-search","summary":"Hybrid Search","description":"Search images using a text query that scores results against both visual content and text metadata (titles, captions, descriptions, and other text fields).This endpoint is in beta and requires special access, please contact the support team.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HybridSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HybridSearchRequest"}}}}}},"/api/v1/search/image-to-image":{"post":{"operationId":"image-to-image","summary":"Image to Image Search","description":"Find visually similar images using a reference image. Provide the reference as either a coactive_image_id (an asset already in the dataset) or a public_url.Useful for finding visually related assets.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:app__api__routes__search__v1__schema__schema__SearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:ImageSearchRequest"}}}}}},"/api/v1/search/image-to-keyframes":{"post":{"operationId":"image-to-keyframes","summary":"Image to Keyframes Search","description":"Find video keyframes that look similar to a reference image. Provide the reference as a public_url or upload_id.Returns a ranked list of matching frames with their parent video.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:NileSearchKeyframeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:ImageToKeyframeSearchRequest"}}}}}},"/api/v1/search/text-to-image/by-person":{"post":{"operationId":"text-to-image-search-by-person","summary":"Text to Image by Person Search","description":"Search for video keyframes that match a text query and contain a specific enrolled person — for example, Jane Doe at a press conference. Specify the person via either person_ids or person_names_or_aliases.The person must already be enrolled in your organization. Returns matching assets plus a video-level list aggregated by best matching keyframe score.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:TextSearchByPersonResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:TextSearchByPersonRequest"}}}}}},"/api/v1/search/text-to-image":{"post":{"operationId":"text-search-api-v-1-search-text-to-image-post","summary":"Text to Image Search","description":"Search a dataset with a natural-language query and get back the images that best match it. Use this when you want to find visuals by describing what's in them.For example, search for a sunset at the beach or Jalen Hurts holding the Vince Lombardi trophy. Pair the text query with exact-match metadata filters to narrow results further.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:app__api__routes__search__v1__schema__schema__SearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:TextSearchRequest"}}}}}},"/api/v1/search/text-to-keyframes":{"post":{"operationId":"text-to-keyframes-search-api-v-1-search-text-to-keyframes-post","summary":"Text to Keyframes Search","description":"Search across all video frames in a dataset using a natural-language query. Returns the keyframes that best match the description.Use this when you want all the keyframe-level results from your videos rather than one-result-per-video.","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:NileSearchKeyframeResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:TextSearchRequest"}}}}}},"/api/v1/search/text-to-transcript/exact-match":{"post":{"operationId":"transcript-exact-match","summary":"Transcript Exact Match","description":"Performs an exact text match search on video transcripts using a natural language text query (e.g., 'thank you for your time' or 'my name is John') within a specified dataset (dataset_id). This searches for exact occurrences of the provided text within video transcript data, not semantic or approximate matching. Returns videos grouped by their exact transcript matches, where each match includes the composite slice (shot or scene) containing the match, the matched transcript text, timestamps, frame numbers, and a coverage score indicating how much of the composite's transcript is covered by the query (1.0 means the query matches the entire transcript).","tags":["search > search"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:TranscriptTextMatchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search:TranscriptMatchRequest"}}}}}},"/api/v0/search/metadata-filters/audio-sound":{"post":{"operationId":"search-audio-sound-with-metadata-filters","summary":"Audio Sound (with Metadata Filters)","description":"Triggers an asynchronous search for video segments containing the specified `audio_class` (e.g., 'Music', 'Dog', 'Explosion') within the specified dataset (`dataset_id`), restricted to videos whose metadata matches every entry in `metadata_filters` (e.g., `genre = documentary`). Audio chunks are scored using the Audio Spectrogram Transformer (AST) model, which predicts confidence scores for 527 AudioSet sound classes across fixed-length audio segments extracted from ingested videos; no text embedding is computed. Returns the Databricks `run_id` immediately; use the status and result endpoints to poll for the final ranked list of sound segments (each with the parent video, time boundaries, the nearest keyframe, score, and optional moderation score).","tags":["search-metadata-filter"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchTriggerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSoundSearchRequest"}}}}}},"/api/v0/search/metadata-filters/job/result/{run_id}":{"get":{"operationId":"get-metadata-filter-search-result","summary":"Job Result","tags":["search-metadata-filter"],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"dataset_id","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:get_metadata_filter_search_result_Response_200"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}}}},"/api/v0/search/metadata-filters/job/status/{run_id}":{"get":{"operationId":"get-metadata-filter-search-status","summary":"Job Status","tags":["search-metadata-filter"],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"dataset_id","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchStatusResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}}}},"/api/v0/search/metadata-filters/text-to-image":{"post":{"operationId":"search-text-to-image-with-metadata-filters","summary":"Text to Image (with Metadata Filters)","description":"Triggers an asynchronous text-to-image search within the specified dataset (`dataset_id`), restricted to image assets matching every entry in `metadata_filters` (e.g., `category = sports`, `tag contains outdoor`). The `text_query` is encoded into an embedding using the dataset's configured vision-language encoder (e.g., CLIP, SigLIP, Perception Encoder) and ranked against image embeddings via vector similarity, while the metadata filters are applied as a pre-scoring constraint on the asset metadata fields. Returns the Databricks `run_id` immediately; use the status and result endpoints to poll for the final ranked list of images (each with the asset id, path, metadata, relevance score, and optional moderation score).","tags":["search-metadata-filter"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchTriggerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchRequest"}}}}}},"/api/v0/search/metadata-filters/text-to-keyframe":{"post":{"operationId":"search-text-to-keyframe-with-metadata-filters","summary":"Text to Keyframe (with Metadata Filters)","tags":["search-metadata-filter"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchTriggerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchRequest"}}}}}},"/api/v0/search/metadata-filters/text-to-shot":{"post":{"operationId":"search-text-to-shot-with-metadata-filters","summary":"Text to Shot (with Metadata Filters)","tags":["search-metadata-filter"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchTriggerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchRequest"}}}}}},"/api/v0/search/metadata-filters/text-to-transcript":{"post":{"operationId":"search-text-to-transcript-with-metadata-filters","summary":"Text to Transcript (with Metadata Filters)","description":"Triggers an asynchronous transcript search within the specified dataset (`dataset_id`), restricted to videos whose metadata matches every entry in `metadata_filters` (e.g., `rating = PG`, `genre = documentary`). When `match_mode=\"semantic\"`, the `text_query` is encoded with the dataset's configured audio/transcript encoder (e.g., sentence transformers, Qwen) and ranked against transcript embeddings via vector similarity. When `match_mode=\"exact\"`, no embedding is computed and the raw `text_query` is matched lexically against transcript text. Returns the Databricks `run_id` immediately; use the status and result endpoints to poll for the final ranked list of transcript segments (each with the parent video, audio segment, timestamp, score, coverage score, and optional moderation score).","tags":["search-metadata-filter"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchTriggerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataTranscriptSearchRequest"}}}}}},"/api/v0/search/metadata-filters/text-to-video":{"post":{"operationId":"search-text-to-video-with-metadata-filters","summary":"Text to Video (with Metadata Filters)","description":"Triggers an asynchronous text-to-video search within the specified dataset (`dataset_id`), restricted to assets matching every entry in `metadata_filters` (e.g., `genre = musical`, `rating != PG`, `headline contains olympics`, `impressions > 1000`). The `text_query` is encoded into an embedding using the dataset's configured vision-language encoder (e.g., CLIP, SigLIP, Perception Encoder) and ranked against video keyframe embeddings via vector similarity, while the metadata filters are applied as a pre-scoring constraint on the asset metadata fields. Returns the Databricks `run_id` immediately; use the status and result endpoints to poll for the final ranked list of videos (each with the parent video, top composite slice, top keyframe, metadata, score, and optional moderation score).","tags":["search-metadata-filter"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchTriggerResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-metadata-filter:MetadataSearchRequest"}}}}}},"/api/v1/search/video":{"get":{"operationId":"get-video-details","summary":"Get Detailed Video Search By Id","description":"Retrieves composite slices (shots, scenes, etc.) within a specific video ranked by their similarity to a text query. Given a video_id and text_query, this endpoint performs a drill-down search to find moments within that video. The text query is encoded using the dataset's configured shot-level encoder (e.g., Perception Encoder or other vision-language embedding models), then searched against shot embeddings for that specific video. Returns a ranked list of composite slices ordered by similarity score, including timestamps (start_time_ms, end_time_ms), frame numbers, and representative keyframes.","tags":["search-video > searchVideo"],"parameters":[{"name":"dataset_id","in":"query","description":"Dataset identifier","required":true,"schema":{"type":"string"}},{"name":"text_query","in":"query","description":"Text query for search","required":true,"schema":{"type":"string","minLength":2}},{"name":"video_id","in":"query","description":"Video identifier","required":true,"schema":{"type":"string"}},{"name":"composite_type","in":"query","description":"Type of composite","required":false,"schema":{"type":"string","default":"shot"}},{"name":"limit","in":"query","description":"Maximum number of slices to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":10}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-video:VideoCompositeDrillDownResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-video:HTTPValidationError"}}}}}},"post":{"operationId":"search-videos","summary":"Video Search","description":"Executes a semantic video search using a natural language text query (e.g., 'person walking in park' or 'cityscape at sunset') within a specified dataset (dataset_id). The text query is encoded into an embedding using the dataset's configured encoder (e.g., Perception Encoder or other vision-language embedding models for visual modalities, or Qwen or other text encoders for audio transcript modality), then searched against video content embeddings using vector similarity. The search behavior is controlled by the modality parameter: 'video' (default) searches video-level embeddings for overall video similarity, 'shot' searches shot-level embeddings to find videos with similar scenes, 'image' searches frame-level embeddings to find videos with similar individual frames, and 'audio_speech_to_text' searches transcript text embeddings for spoken content. All modalities return one result per video, surfacing the most relevant composite slice (shot or scene) and a preview frame. Results can be filtered using optional metadata filters and include the composite slice with start/end timestamps, frame numbers, relevance scores, and video metadata.","tags":["search-video > searchVideo"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-video:VideoSearchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-video:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/search-video:VideoSearchRequest"}}}}}},"/api/v1/auth-management/clients":{"post":{"operationId":"create-credentials","summary":"Create Credentials","description":"Create new system-level credentials. System-level credentials are not tied to a specific\nuser and never expire.\n\nThe access of the system-level credentials are scoped to the specified roles. **If no\nroles are provided, the system-level credentials will have full access to all resources**.\n\nThe client id and client secret of the created credentials can be exchanged for access tokens\nwhich can be used to make requests to the API. These credentials should only be used for\nprogrammatic access to the API as they are not tied to a specific user.","tags":["systemCredentials"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The details of the created system-level credentials, including the client ID and secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateClientRequest"}}}}},"get":{"operationId":"list-credentials","summary":"List Credentials","description":"List all system-level credentials in the organization.\n\nSystem-level credentials are not tied to a specific user and never expire.","tags":["systemCredentials"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of system-level credentials","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ClientResponse"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}}},"/api/v1/auth-management/clients/{client_id}":{"delete":{"operationId":"delete-credentials","summary":"Delete Credentials","description":"Delete system-level credentials.\n\nThis endpoint permanently deletes the system-level credentials and revokes all associated tokens.\nThis action cannot be undone.","tags":["systemCredentials"],"parameters":[{"name":"client_id","in":"path","description":"The client ID of the system-level credentials","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}},"get":{"operationId":"get-credentials","summary":"Get Credentials","description":"Get specific system-level credentials by id.\n\nThis endpoint retrieves the details of specific system-level credentials,\nincluding its roles and configuration.","tags":["systemCredentials"],"parameters":[{"name":"client_id","in":"path","description":"The client ID of the system-level credentials","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The details of a specific system-level credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}},"put":{"operationId":"update-credentials","summary":"Update Credentials","description":"Update system-level credentials.\n\nThis endpoint allows updating the name and roles of existing system-level credentials.\n\nThe access of the system-level credentials is scoped to its roles. **If no roles are provided,\nthe system-level credentials will have full access to all resources**. If the credentials\nwas previously assigned roles and no roles are provided in the update request, the credentials\nwill gain full access to all resources.","tags":["systemCredentials"],"parameters":[{"name":"client_id","in":"path","description":"The client ID of the system-level credentials","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated system-level credentials details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateClientRequest"}}}}}},"/api/v1/auth-management/user-invitations":{"post":{"operationId":"create-invitation","summary":"Create Invitation","description":"Create a new user invitation.\n\nThis endpoint creates a new invitation for a user to join the organization.\nThe invitation will be sent to the specified email address.","tags":["userManagement"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"The created invitation details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInvitation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserInvitationRequest"}}}}},"get":{"operationId":"list-invitations","summary":"List Invitations","description":"List all pending user invitations.\nThis endpoint retrieves a list of all pending invitations in the organization.","tags":["userManagement"],"parameters":[{"name":"offset","in":"query","description":"Number of records to skip (for pagination)","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","description":"Number of invitations to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated list of pending user invitations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInvitationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}}},"/api/v1/auth-management/user-invitations/{invitation_id}":{"delete":{"operationId":"delete-invitation","summary":"Delete Invitation","description":"Delete a user invitation.\n\nThis endpoint cancels a pending invitation before it is accepted.\nThe invitation will no longer be valid.","tags":["userManagement"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation to delete","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}},"get":{"operationId":"get-invitation","summary":"Get Invitation","description":"Get a user invitation.\n\nGet the details of a pending user invitation.","tags":["userManagement"],"parameters":[{"name":"invitation_id","in":"path","description":"The unique identifier of the invitation to retrieve","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The details of a pending user invitation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserInvitation"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}}},"/api/v1/auth-management/roles":{"get":{"operationId":"list-roles","summary":"List Roles","description":"List all assignable roles.\n\nThe roles returned are scoped to the roles context.\nFor example, if the roles_context is \"dataset:123\", the endpoint will return all roles\nthat are assignable to dataset with id \"123\". If the roles_context is \"system\", the endpoint\nwill return all system-level roles that are assignable in the organization.\n\nIf no roles_context is provided, the endpoint will return all system-level and dataset-level\nroles in the organization.","tags":["userManagement"],"parameters":[{"name":"roles_context","in":"query","description":"Context for the roles to include in the response. This can either be 'system' for system-level roles or 'dataset:{dataset_id}' for dataset-level roles.","required":false,"schema":{"type":["string","null"]}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of assignable roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RolesListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}}},"/api/v1/auth-management/users":{"get":{"operationId":"list-users","summary":"List Users","description":"List users in the organization.\n\nThis endpoint retrieves a paginated list of users in the organization.\nThe response can be filtered by a search query and optionally include user roles.","tags":["userManagement"],"parameters":[{"name":"query","in":"query","description":"Search query to match names and emails","required":false,"schema":{"type":["string","null"],"pattern":"^[a-zA-Z0-9@._\\-\\s*?]+$","minLength":3,"maxLength":50}},{"name":"user_ids","in":"query","description":"List of user IDs to filter by","required":false,"schema":{"type":["array","null"],"items":{"type":"string"}}},{"name":"offset","in":"query","description":"Number of records to skip (for pagination)","required":false,"schema":{"type":"integer","minimum":0,"default":0}},{"name":"limit","in":"query","description":"Number of users to return","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":100}},{"name":"include_roles","in":"query","description":"Include user roles in the response","required":false,"schema":{"type":"boolean","default":false}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated list of users in the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}}},"/api/v1/auth-management/users/{user_id}":{"delete":{"operationId":"remove-user","summary":"Remove User","description":"Remove a user from the organization.\n\nThis endpoint permanently removes a user from the organization.\nThe user will no longer have access to any organization resources.","tags":["userManagement"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user to remove","required":true,"schema":{"type":"string","pattern":"^auth0\\|[A-Za-z0-9]+$"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}}}},"/api/v1/auth-management/users/{user_id}/roles":{"put":{"operationId":"update-user-roles","summary":"Update User Roles","description":"Replace a user's roles.\n\nThis endpoint allows administrators to replace the roles assigned to a user.\n\nThe roles can be scoped to a specific context (e.g., dataset or system).\nIf a context is provided, the roles will only be replaced within that context.\nIf no context is provided, all roles (system-level and dataset-level) will be replaced.\n\nTo replace roles at the system level, use the \"system\" context.\nTo replace roles at the dataset level, use the \"dataset:{dataset_id}\" context.","tags":["userManagement"],"parameters":[{"name":"user_id","in":"path","description":"The ID of the user to update","required":true,"schema":{"type":"string","pattern":"^auth0\\|[A-Za-z0-9]+$"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The updated user profile with new roles","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError1"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRolesRequest"}}}}}},"/api/v0/video-narrative-metadata/metadata":{"post":{"operationId":"create-metadata-api-v-0-video-narrative-metadata-metadata-post","summary":"Create a metadata value","description":"Create a metadata value.\n\n- Genre: The overall story category or narrative style of the content.\n- Mood: The emotional tone or feeling the content creates.\n- Subject: The main topic or theme the content focuses on.\n- Format: The structural style or production type of the content.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:CreateMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:CreateMetadataRequest"}}}}},"get":{"operationId":"get-metadata-api-v-0-video-narrative-metadata-metadata-get","summary":"List metadata values by type","description":"List metadata values by type.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"metadata_type","in":"query","description":"Metadata type to list","required":true,"schema":{"$ref":"#/components/schemas/video-narative-metadata:MetadataType"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GetMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}}}},"/api/v0/video-narrative-metadata/metadata/{metadata_id}":{"delete":{"operationId":"delete-metadata-api-v-0-video-narrative-metadata-metadata-metadata-id-delete","summary":"Delete a metadata value","description":"Delete a metadata value.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:DeleteMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}}},"patch":{"operationId":"update-metadata-api-v-0-video-narrative-metadata-metadata-metadata-id-patch","summary":"Update a metadata value","description":"Update a metadata value.\n\n- Genre: The overall story category or narrative style of the content.\n- Mood: The emotional tone or feeling the content creates.\n- Subject: The main topic or theme the content focuses on.\n- Format: The structural style or production type of the content.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:UpdateMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:UpdateMetadataRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/composite-slices/{composite_slice_id}/summary":{"post":{"operationId":"generate-composite-slice-summary-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-composite-slices-composite-slice-id-summary-post","summary":"Generate a composite slice summary","description":"Generate a composite slice summary.\n\nSummary: A clear, structured overview of the main events in the shot, following their chronological order from beginning to end. It mentions the main characters by name (if identifiable) and describes their roles, actions, and relationships. It summarizes the key moments, turning points, and overall narrative arc, so that the reader can understand the full story, its progression including the ending.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"composite_slice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateCompositeSliceSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateCompositeSliceSummaryRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/description":{"post":{"operationId":"generate-video-description-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-description-post","summary":"Generate a video description","description":"Generate a video description.\n\nDescription: A very detailed, factual account of what is visually, verbally, and audibly happening in the video. It accurately describes scenes, actions, environments, sounds, and dialogues without interpretation.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateVideoDescriptionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateVideoDescriptionRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/summary":{"post":{"operationId":"generate-video-summary-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-summary-post","summary":"Generate a video summary","description":"Generate a video summary.\n\nSummary: A clear, structured overview of the main events in the video, following their chronological order from beginning to end. It mentions the main characters by name (if identifiable) and describes their roles, actions, and relationships. It summarizes the key moments, turning points, and overall narrative arc, so that the reader can understand the full story, its progression including the ending.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateVideoSummaryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateVideoSummaryRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/synopsis":{"post":{"operationId":"generate-video-synopsis-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-synopsis-post","summary":"Generate a video synopsis","description":"Generate a video synopsis.\n\nSynopsis: A short, engaging, spoiler-free overview designed for someone deciding whether to watch the video. It focuses on the premise, intrigue, mood, and tone, but does not reveal major plot twists or the ending. It highlights the main characters and setup of the story, giving a sense of the emotional or thematic focus without detailing the resolution.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateVideoSynopsisResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:GenerateVideoSynopsisRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/composite-slices/{composite_slice_id}/format":{"post":{"operationId":"predict-composite-slice-format-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-composite-slices-composite-slice-id-format-post","summary":"Predict composite slice format(s)","description":"Predict composite slice format(s).\n\nFormat: The structural style or production type of the content.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"composite_slice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictCompositeSliceFormatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictCompositeSliceFormatRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/composite-slices/{composite_slice_id}/mood":{"post":{"operationId":"predict-composite-slice-mood-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-composite-slices-composite-slice-id-mood-post","summary":"Predict composite slice mood(s)","description":"Predict composite slice mood(s).\n\nMood: The emotional tone or feeling the content creates.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"composite_slice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictCompositeSliceMoodResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictCompositeSliceMoodRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/composite-slices/{composite_slice_id}/subject":{"post":{"operationId":"predict-composite-slice-subject-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-composite-slices-composite-slice-id-subject-post","summary":"Predict composite slice subject(s)","description":"Predict composite slice subject(s).\n\nSubject: The main topic or theme the content focuses on.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"composite_slice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictCompositeSliceSubjectResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictCompositeSliceSubjectRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/format":{"post":{"operationId":"predict-video-format-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-format-post","summary":"Predict video format(s)","description":"Predict video format(s).\n\nFormat: The structural style or production type of the content.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoFormatResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoFormatRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/genre":{"post":{"operationId":"predict-video-genre-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-genre-post","summary":"Predict video genre(s)","description":"Predict video genre(s).\n\nGenre: The overall story category or narrative style of the content.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoGenreResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoGenreRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/mood":{"post":{"operationId":"predict-video-mood-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-mood-post","summary":"Predict video mood(s)","description":"Predict video mood(s).\n\nMood: The emotional tone or feeling the content creates.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoMoodResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoMoodRequest"}}}}}},"/api/v0/video-narrative-metadata/datasets/{dataset_id}/videos/{video_id}/subject":{"post":{"operationId":"predict-video-subject-api-v-0-video-narrative-metadata-datasets-dataset-id-videos-video-id-subject-post","summary":"Predict video subject(s)","description":"Predict video subject(s).\n\nSubject: The main topic or theme the content focuses on.","tags":["video-narative-metadata > videoNarrativeMetadata"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoSubjectResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:PredictVideoSubjectRequest"}}}}}},"/api/v0/video-summarization/datasets/{dataset_id}/videos/{video_id}/caption-keyframes":{"post":{"operationId":"caption-video-keyframes-api-v-0-video-summarization-datasets-dataset-id-videos-video-id-caption-keyframes-post","summary":"Request keyframe captioning for a video","description":"Request keyframe captioning for a video.","tags":["video-narative-metadata > videoSummarization"],"parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:CaptionVideoKeyframesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-narative-metadata:HTTPValidationError"}}}}}}},"/api/v0/video-scores/groups/{group_id}/tags/{tag_id}/versions/{version_id}/videos/{video_id}/shot-scores":{"get":{"operationId":"get-video-shot-scores","summary":"Get shot scores for a video","description":"Retrieve shot-level scores for a given video and tag version: score, start/end time, and duration for each shot (only shots with score >= min_conf).","tags":["video-scores > videoScores"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the Dynamic Tag group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tag_id","in":"path","description":"The ID of the tag within the group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"version_id","in":"path","description":"The tag version ID.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"video_id","in":"path","description":"The Coactive Video ID to retrieve shot scores for.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataset_id","in":"query","description":"Dataset ID (used to locate the shot scores table).","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"min_conf","in":"query","description":"Minimum confidence threshold (score >= min_conf). Must be greater than 0.1.","required":false,"schema":{"type":"number","format":"double","maximum":1,"exclusiveMinimum":0.1,"default":0.5}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:GetVideoShotScoresResponse"}}}},"404":{"description":"Shot scores table not found for dataset","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:HTTPValidationError"}}}}}}},"/api/v0/video-scores/groups/{group_id}/tags/{tag_id}/aggregations/{aggregation_id}/result":{"get":{"operationId":"get-video-scores-result","summary":"Get video scores result","description":"Retrieve video scores based on an existing aggregation ID with pagination support.","tags":["video-scores > videoScores"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the Dynamic Tag group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tag_id","in":"path","description":"The ID of the tag within the group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"aggregation_id","in":"path","description":"The ID of the aggregation to retrieve results for.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"page","in":"query","description":"Page number (1-indexed).","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"per_page","in":"query","description":"Number of items per page.","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000,"default":100}},{"name":"sort_order","in":"query","description":"Sort order for scores (ascending or descending).","required":false,"schema":{"$ref":"#/components/schemas/video-scores:SortDirection"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:GetVideoScoresResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:HTTPValidationError"}}}}}}},"/api/v0/video-scores/groups/{group_id}/tags/{tag_id}/aggregations/{aggregation_id}/result/count":{"get":{"operationId":"get-video-scores-result-count","summary":"Get video scores result count","description":"Retrieve the count of video scores based on an aggregation ID with filtering options.","tags":["video-scores > videoScores"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the Dynamic Tag group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tag_id","in":"path","description":"The ID of the tag within the group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"aggregation_id","in":"path","description":"The ID of the aggregation to retrieve count for.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"criteria_met","in":"query","description":"Filter by whether criteria were met.","required":false,"schema":{"type":"boolean","default":true}},{"name":"accepted","in":"query","description":"Filter by whether the score was accepted.","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:GetVideoScoresResultCountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:HTTPValidationError"}}}}}}},"/api/v0/video-scores/groups/{group_id}/tags/{tag_id}/aggregations/-/result":{"get":{"operationId":"get-video-scores-result-preview","summary":"Get video scores result preview","description":"Retrieve a preview of video scores based on aggregation strategy. Use this endpoint to preview results before creating an aggregation.","tags":["video-scores > videoScores"],"parameters":[{"name":"group_id","in":"path","description":"The ID of the Dynamic Tag group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tag_id","in":"path","description":"The ID of the tag within the group.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"tag_version_id","in":"query","description":"The version ID of the tag.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dataset_id","in":"query","description":"The ID of the dataset to query.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"strategy","in":"query","description":"The aggregation strategy/methodology to use.","required":true,"schema":{"$ref":"#/components/schemas/video-scores:AggregationMethodology"}},{"name":"min_conf","in":"query","description":"Minimum confidence threshold.","required":true,"schema":{"type":"number","format":"double","maximum":1,"exclusiveMinimum":0}},{"name":"coverage_threshold","in":"query","description":"Coverage threshold (required for COVERAGE_THRESHOLD strategy).","required":false,"schema":{"type":"number","format":"double","maximum":1,"exclusiveMinimum":0}},{"name":"engine","in":"query","description":"Backend engine used to query shot scores. DUCKDB (default) supports all strategies; PINOT supports ANY_HIT and COVERAGE_THRESHOLD only.","required":false,"schema":{"$ref":"#/components/schemas/video-scores:AggregationEngine"}},{"name":"max_shot_length","in":"query","description":"Maximum shot length in seconds. Videos with any shot longer than this value are excluded from results. Omit or set to null to disable filtering.","required":false,"schema":{"type":"integer","exclusiveMinimum":0}},{"name":"Authorization","in":"header","description":"Bearer authentication","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:GetVideoScoresResponse"}}}},"400":{"description":"Bad Request - LONGEST_RUN strategy is not supported with PINOT engine","content":{"application/json":{"schema":{"description":"Any type"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/video-scores:HTTPValidationError"}}}}}}}},"servers":[{"url":"https://api.coactive.ai","description":"Production"},{"url":"https://app.coactive.ai","description":"Production"}],"components":{"schemas":{"agentic-search:ChatRequest":{"type":"object","properties":{"chat_request_text":{"type":["string","null"],"description":"User's chat input text"},"upload_id":{"type":["string","null"],"description":"Upload ID of the user's input image"},"history_chat_messages":{"type":["array","null"],"items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"Conversation history (does not include current message)"}},"description":"Request schema for chat endpoint.","title":"ChatRequest"},"agentic-search:ToolName":{"type":"string","enum":["video_search_search_videos","video_search_get_video_details","apollo_search_image_to_image","apollo_search_image_to_keyframes","apollo_search_hybrid_search","apollo_search_transcript_exact_match","apollo_search_audio_search","apollo_search_audio_sound_search","apollo_search_text_to_image_search_by_person","metadata_filter_search_text_to_video_with_metadata_filters","metadata_filter_search_text_to_transcript_with_metadata_filters","metadata_filter_search_audio_sound_with_metadata_filters","metadata_filter_search_text_to_image_with_metadata_filters"],"description":"Enum of available MCP tool names.","title":"ToolName"},"agentic-search:DatasetType":{"type":"string","enum":["native_video","legacy"],"description":"Dataset type enum.","title":"DatasetType"},"agentic-search:VideoMetadata":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"description":"Any type"}}},"description":"Metadata associated with a video.","title":"VideoMetadata"},"agentic-search:VideoSearchResultItemMetadata":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:VideoMetadata"},{"type":"object","additionalProperties":{"description":"Any type"}}],"title":"VideoSearchResultItemMetadata"},"agentic-search:CompositeSlice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"index":{"type":["integer","null"]},"start_frame_num":{"type":["integer","null"]},"end_frame_num":{"type":["integer","null"]},"start_time_ms":{"type":["integer","null"]},"end_time_ms":{"type":["integer","null"]},"composite_id":{"type":["string","null"],"format":"uuid"},"composite_type":{"type":"string"}},"required":["id","composite_type"],"description":"Composite slice details (used by both video search and transcript matching).","title":"CompositeSlice"},"agentic-search:VideoKeyframe":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"frame_time_ms":{"type":["integer","null"]}},"required":["id"],"description":"Video keyframe details.","title":"VideoKeyframe"},"agentic-search:VideoSearchResultItem":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"text_query":{"type":"string"},"video_id":{"type":"string","format":"uuid"},"source_path":{"type":"string"},"video_score":{"type":["number","null"],"format":"double"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:VideoSearchResultItemMetadata"},{"type":"null"}]},"top_composite_slice":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:CompositeSlice"},{"type":"null"}]},"top_keyframe":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:VideoKeyframe"},{"type":"null"}]},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["dataset_id","text_query","video_id","source_path"],"description":"Single video search result item.","title":"VideoSearchResultItem"},"agentic-search:VideoSearchResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:VideoSearchResultItem"}}},"description":"Response schema for search_videos tool.","title":"VideoSearchResponse"},"agentic-search:Video":{"type":"object","properties":{"coactive_video_id":{"type":"string","format":"uuid"},"path":{"type":["string","null"]},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["coactive_video_id"],"description":"Video asset metadata.","title":"Video"},"agentic-search:Shot":{"type":"object","properties":{"shot_id":{"type":"string","format":"uuid"},"start_time_ms":{"type":"integer"},"end_time_ms":{"type":"integer"}},"required":["shot_id","start_time_ms","end_time_ms"],"description":"Metadata about a video shot.","title":"Shot"},"agentic-search:AudioSegment":{"type":"object","properties":{"start_time_ms":{"type":"integer"},"end_time_ms":{"type":"integer"},"speech_to_text_transcription":{"type":"string"}},"required":["start_time_ms","end_time_ms","speech_to_text_transcription"],"description":"Metadata about a video audio segment.","title":"AudioSegment"},"agentic-search:ImageKeyframeSearchResultItem":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"path":{"type":["string","null"]},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"moderation_score":{"type":["number","null"],"format":"double"},"video":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:Video"},{"type":"null"}]},"shot":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:Shot"},{"type":"null"}]},"audio_segment":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:AudioSegment"},{"type":"null"}]},"timestamp":{"type":["integer","null"]}},"required":["coactive_image_id"],"description":"Base result item with common fields for image and keyframe search results.","title":"ImageKeyframeSearchResultItem"},"agentic-search:ImageKeyframeSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:ImageKeyframeSearchResultItem"}}},"description":"Response schema for image and keyframe search tools.","title":"ImageKeyframeSearchResponse"},"agentic-search:KeyframeSearchResultItem":{"type":"object","properties":{"keyframe_id":{"type":"string","format":"uuid"},"score":{"type":"number","format":"double"},"asset_type":{"type":"string"},"dataset_id":{"type":"string","format":"uuid"},"video_id":{"type":"string","format":"uuid"},"composite_slice_id":{"type":["string","null"],"format":"uuid"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["keyframe_id","score","asset_type","dataset_id","video_id"],"description":"Single keyframe search result item.","title":"KeyframeSearchResultItem"},"agentic-search:KeyframeSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:KeyframeSearchResultItem"}}},"description":"Response schema for keyframe search tool.","title":"KeyframeSearchResponse"},"agentic-search:VideoTranscriptMatch":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"video":{"$ref":"#/components/schemas/agentic-search:Video"},"audio_segment":{"$ref":"#/components/schemas/agentic-search:AudioSegment"},"coverage_score":{"type":["number","null"],"format":"double"},"timestamp":{"type":["integer","null"]},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["coactive_image_id","video","audio_segment"],"description":"A single transcript match result with keyframe and slice information.","title":"VideoTranscriptMatch"},"agentic-search:TranscriptExactMatchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:VideoTranscriptMatch"}}},"description":"Response schema for apollo_search_transcript_exact_match tool.","title":"TranscriptExactMatchResponse"},"agentic-search:HybridSearchResultItem":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"path":{"type":["string","null"]},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"moderation_score":{"type":["number","null"],"format":"double"},"relevance_score":{"type":"number","format":"double"}},"required":["coactive_image_id","relevance_score"],"description":"Single hybrid search result item.","title":"HybridSearchResultItem"},"agentic-search:HybridSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:HybridSearchResultItem"}}},"description":"Response schema for hybrid search tool.","title":"HybridSearchResponse"},"agentic-search:CompositeSliceWithScore":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"index":{"type":["integer","null"]},"start_frame_num":{"type":["integer","null"]},"end_frame_num":{"type":["integer","null"]},"start_time_ms":{"type":["integer","null"]},"end_time_ms":{"type":["integer","null"]},"composite_id":{"type":["string","null"],"format":"uuid"},"composite_type":{"type":"string"},"composite_slice_score":{"type":["number","null"],"format":"double"}},"required":["id","composite_type"],"description":"Composite slice details with drill-down information.","title":"CompositeSliceWithScore"},"agentic-search:GetVideoDetailsResponse":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"text_query":{"type":"string"},"video_id":{"type":"string","format":"uuid"},"composite_type":{"type":"string"},"source_path":{"type":"string"},"slices":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:CompositeSliceWithScore"}}},"required":["dataset_id","text_query","video_id","composite_type","source_path"],"description":"Response schema for get_video_details tool.","title":"GetVideoDetailsResponse"},"agentic-search:TextToImageSearchByPersonResultItem":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"asset_type":{"type":"string"},"dataset_id":{"type":"string","format":"uuid"},"video_id":{"type":["string","null"],"format":"uuid"},"composite_slice_id":{"type":["string","null"],"format":"uuid"},"composite_type":{"type":["string","null"]},"composite_start_time_ms":{"type":["integer","null"]},"composite_end_time_ms":{"type":["integer","null"]},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["coactive_image_id","asset_type","dataset_id"],"description":"Single result item for text-to-image search by person.","title":"TextToImageSearchByPersonResultItem"},"agentic-search:TextToImageSearchByPersonVideoResult":{"type":"object","properties":{"video_id":{"type":"string","format":"uuid"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["video_id"],"description":"Video result aggregated from person search results.","title":"TextToImageSearchByPersonVideoResult"},"agentic-search:TextToImageSearchByPersonResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:TextToImageSearchByPersonResultItem"}},"videos":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:TextToImageSearchByPersonVideoResult"}}},"description":"Response schema for text_to_image_search_by_person tool.","title":"TextToImageSearchByPersonResponse"},"agentic-search:MetadataFilterTriggerResponse":{"type":"object","properties":{"run_id":{"type":"integer"}},"required":["run_id"],"description":"All metadata-filter search tools now return an async job run_id.","title":"MetadataFilterTriggerResponse"},"agentic-search:AudioChunk":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"video":{"$ref":"#/components/schemas/agentic-search:Video"},"start_time_ms":{"type":"integer"},"end_time_ms":{"type":"integer"},"score":{"type":"number","format":"double"},"timestamp":{"type":["integer","null"]},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["coactive_image_id","video","start_time_ms","end_time_ms","score"],"description":"A single audio chunk result.","title":"AudioChunk"},"agentic-search:AudioSoundSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:AudioChunk"}}},"description":"Response schema for apollo_search_audio_sound_search tool.","title":"AudioSoundSearchResponse"},"agentic-search:ToolResultResult":{"oneOf":[{"$ref":"#/components/schemas/agentic-search:VideoSearchResponse"},{"$ref":"#/components/schemas/agentic-search:ImageKeyframeSearchResponse"},{"$ref":"#/components/schemas/agentic-search:KeyframeSearchResponse"},{"$ref":"#/components/schemas/agentic-search:TranscriptExactMatchResponse"},{"$ref":"#/components/schemas/agentic-search:HybridSearchResponse"},{"$ref":"#/components/schemas/agentic-search:GetVideoDetailsResponse"},{"$ref":"#/components/schemas/agentic-search:TextToImageSearchByPersonResponse"},{"$ref":"#/components/schemas/agentic-search:MetadataFilterTriggerResponse"},{"$ref":"#/components/schemas/agentic-search:AudioSoundSearchResponse"}],"description":"Result from the MCP tool invocation","title":"ToolResultResult"},"agentic-search:ToolResult":{"type":"object","properties":{"tool_name":{"$ref":"#/components/schemas/agentic-search:ToolName","description":"Name of the MCP tool that was invoked"},"dataset_id":{"type":"string","format":"uuid","description":"ID of the dataset that the tool was invoked for"},"dataset_type":{"$ref":"#/components/schemas/agentic-search:DatasetType","description":"Type of the dataset that the tool was invoked for"},"invocation_timestamp":{"type":"string","description":"Timestamp of the MCP tool invocation (ISO 8601 format)"},"result":{"$ref":"#/components/schemas/agentic-search:ToolResultResult","description":"Result from the MCP tool invocation"}},"required":["tool_name","dataset_id","dataset_type","invocation_timestamp","result"],"description":"Result from a MCP tool invocation.","title":"ToolResult"},"agentic-search:ChatResponse":{"type":"object","properties":{"chat_response_text":{"type":"string","description":"LLM response text"},"tool_results":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:ToolResult"},"description":"Results from MCP tools invoked during this request. "},"history_chat_messages":{"type":"array","items":{"type":"object","additionalProperties":{"description":"Any type"}},"description":"Conversation history (includes current message)"},"suggested_follow_ups":{"type":"array","items":{"type":"string"},"description":"Suggested follow-up messages to continue the conversation"}},"required":["chat_response_text","tool_results","history_chat_messages","suggested_follow_ups"],"description":"Response schema for chat endpoint.","title":"ChatResponse"},"agentic-search:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"agentic-search:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"agentic-search:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/agentic-search:ValidationError"}}},"title":"HTTPValidationError"},"celebrity-detection:IngestedImage":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"dataset_id":{"type":"string","format":"uuid"}},"required":["coactive_image_id","dataset_id"],"title":"IngestedImage"},"celebrity-detection:EnrollmentStatus":{"type":"string","enum":["draft","active","failed","in_progress"],"title":"EnrollmentStatus"},"celebrity-detection:GetPersonResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Person ID"},"name":{"type":"string","description":"Person name"},"aliases":{"type":"array","items":{"type":"string"},"description":"Person aliases"},"upload_ids":{"type":"array","items":{"type":"string"},"description":"Upload IDs of the person's images"},"ingested_images":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:IngestedImage"},"description":"Ingested images of the person"},"status":{"$ref":"#/components/schemas/celebrity-detection:EnrollmentStatus","description":"Person status"},"created_user_id":{"type":"string","description":"User ID who created the person"},"created_dt":{"type":"string","format":"date-time","description":"Date and time the person was created"}},"required":["id","name","aliases","upload_ids","ingested_images","status","created_user_id","created_dt"],"title":"GetPersonResponse"},"celebrity-detection:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"celebrity-detection:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"celebrity-detection:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:ValidationError"}}},"title":"HTTPValidationError"},"celebrity-detection:SortDirection":{"type":"string","enum":["asc","desc"],"description":"Sort direction.","title":"SortDirection"},"celebrity-detection:PagedPageDetailsResponse":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number (1-indexed)"},"per_page":{"type":"integer","description":"Number of items per page"}},"required":["page","per_page"],"description":"Pagination metadata.","title":"PagedPageDetailsResponse"},"celebrity-detection:PagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/celebrity-detection:PagedPageDetailsResponse","description":"Details about pagination"},"has_next_page":{"type":"boolean","default":false,"description":"Whether another page exists"}},"required":["page"],"description":"Metadata about the paginated response.","title":"PagedMetaResponse"},"celebrity-detection:SortField":{"type":"object","properties":{"field":{"type":"string","description":"Field name to sort by"},"direction":{"$ref":"#/components/schemas/celebrity-detection:SortDirection","description":"Sort direction"}},"required":["field"],"description":"Sort field details.","title":"SortField"},"celebrity-detection:GetPersonsResponse":{"type":"object","properties":{"meta":{"oneOf":[{"$ref":"#/components/schemas/celebrity-detection:PagedMetaResponse"},{"type":"null"}],"description":"Metadata for pagination"},"data":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:GetPersonResponse"},"description":"The paginated data"},"sort":{"type":["array","null"],"items":{"$ref":"#/components/schemas/celebrity-detection:SortField"},"description":"Sort details"}},"required":["data"],"title":"GetPersonsResponse"},"celebrity-detection:BoundingBox":{"type":"object","properties":{"x1":{"type":"number","format":"double"},"y1":{"type":"number","format":"double"},"x2":{"type":"number","format":"double"},"y2":{"type":"number","format":"double"}},"required":["x1","y1","x2","y2"],"title":"BoundingBox"},"celebrity-detection:Face":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Face ID"},"image_id":{"type":"string","format":"uuid","description":"Asset ID (image_id or keyframe_id)"},"dataset_id":{"type":"string","format":"uuid","description":"Dataset ID"},"bbox":{"$ref":"#/components/schemas/celebrity-detection:BoundingBox","description":"Relative bounding box coordinates (x1, y1, x2, y2)"},"confidence":{"type":"number","format":"double","description":"Confidence score of the face identification"}},"required":["id","image_id","dataset_id","bbox","confidence"],"title":"Face"},"celebrity-detection:GetFacesWithPersonResponse":{"type":"object","properties":{"faces":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:Face"},"description":"List of faces associated with the person (id, image_id, dataset_id, bbox, confidence)"}},"required":["faces"],"title":"GetFacesWithPersonResponse"},"celebrity-detection:PersonNameMatch":{"type":"object","properties":{"name":{"type":"string","description":"The name or alias that was searched"},"person_id":{"type":["string","null"],"format":"uuid","description":"The matched person ID, or None if not found"}},"required":["name","person_id"],"title":"PersonNameMatch"},"celebrity-detection:GetPersonsByNamesAliasesResponse":{"type":"object","properties":{"matches":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:PersonNameMatch"},"description":"List of name to person_id mappings"}},"required":["matches"],"title":"GetPersonsByNamesAliasesResponse"},"celebrity-detection:Person":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Person ID"},"name":{"type":"string","description":"Person name"},"aliases":{"type":"array","items":{"type":"string"},"description":"Person aliases"},"bbox":{"$ref":"#/components/schemas/celebrity-detection:BoundingBox","description":"Relative bounding box coordinates (x1, y1, x2, y2)"}},"required":["id","name","aliases","bbox"],"title":"Person"},"celebrity-detection:GetPersonsInImageResponse":{"type":"object","properties":{"persons":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:Person"},"description":"List of persons identified in the image"}},"required":["persons"],"title":"GetPersonsInImageResponse"},"celebrity-detection:IdentifyCelebritiesInExternalImageRequest":{"type":"object","properties":{"image":{"type":"string","description":"Base64 encoded JPEG image"}},"required":["image"],"title":"IdentifyCelebritiesInExternalImageRequest"},"celebrity-detection:IdentifyCelebritiesInExternalImageResponse":{"type":"object","properties":{"persons":{"type":"array","items":{"$ref":"#/components/schemas/celebrity-detection:Person"},"description":"List of persons identified in the image"}},"required":["persons"],"title":"IdentifyCelebritiesInExternalImageResponse"},"celebrity-detection:UpdatePersonAliasesRequest":{"type":"object","properties":{"person_id":{"type":"string","format":"uuid","description":"Person ID"},"aliases":{"type":"array","items":{"type":"string"},"description":"Updated list of person aliases"}},"required":["person_id"],"title":"UpdatePersonAliasesRequest"},"PublicUrlClassificationRequest":{"type":"object","properties":{"url":{"type":"string","description":"A public url for downloading the image"},"conceptIds":{"type":["array","null"],"items":{"type":"string","format":"uuid4"},"description":"The ids of concepts to use to classify an image"},"datasetId":{"type":["string","null"],"format":"uuid4","description":"The id of the dataset related to the concepts to use to classify an image"}},"required":["url"],"description":"A request to classify a publicly downloadable image for specific concepts or all concepts\nfor a dataset. Either concept ids of a dataset id must be provided.","title":"PublicUrlClassificationRequest"},"ClassificationScore":{"type":"object","properties":{"conceptName":{"type":"string","description":"The concept name"},"conceptId":{"type":"string","format":"uuid4","description":"The concept id"},"threshold":{"type":"number","format":"double","description":"The threshold used to determine if it's a positive example"},"positive":{"type":"boolean","description":"If the sample is classified as positive"},"score":{"type":"number","format":"double","description":"The classification score in the range [0, 1]"}},"required":["conceptName","conceptId","threshold","positive","score"],"description":"A classification of an asset for a single concept","title":"ClassificationScore"},"Classification":{"type":"object","properties":{"scores":{"type":"array","items":{"$ref":"#/components/schemas/ClassificationScore"},"description":"Classifications of images for the relevant concept(s)"}},"required":["scores"],"description":"A classification of an asset for one or more concepts","title":"Classification"},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"Details about the encountered error"}},"required":["detail"],"description":"Details about an error that occurred","title":"ErrorResponse"},"ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"},{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}},"title":"HTTPValidationError"},"CreateConceptRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the concept, which will become available as the column name in SQL"},"description":{"type":["string","null"],"description":"A description for the concept"},"threshold":{"type":["number","null"],"format":"double","default":0.8,"description":"Threshold above which classification is positive"},"regularization":{"type":["number","null"],"format":"double","default":0.0625,"description":"How strongly the model adapts to the training labels. Regularization strength. Lower value means the model fits more heavily to the training data"},"datasetId":{"type":"string","format":"uuid4","description":"The id of the dataset"}},"required":["name","datasetId"],"description":"An object used to create a concept in Coactive's system","title":"CreateConceptRequest"},"Concept":{"type":"object","properties":{"createdUserId":{"type":"string","description":"The user that created the resource"},"createdDt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updatedUserId":{"type":"string","description":"The user that last updated the resource"},"updatedDt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"name":{"type":"string","description":"The name of the concept"},"description":{"type":["string","null"],"description":"A description for the concept"},"threshold":{"type":["number","null"],"format":"double","default":0.8,"description":"Threshold above which classification is positive"},"regularization":{"type":["number","null"],"format":"double","default":0.0625,"description":"How strongly the model adapts to the training labels. Regularization strength. Lower value means the model fits more heavily to the training data"},"conceptId":{"type":"string","format":"uuid4","description":"The unique identifier for the concept"},"datasetId":{"type":"string","format":"uuid4","description":"The unique identifier for the dataset"}},"required":["createdUserId","createdDt","updatedUserId","updatedDt","name","conceptId","datasetId"],"description":"Data about a concept that can be used to query a dataset","title":"Concept"},"ConceptPredictionResponse":{"type":"object","properties":{"probabilityRanges":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}},"description":"Each tuple represents the bounds of a bin we estimated number of assets for"},"estimates":{"type":"array","items":{"type":"integer"},"description":"Number of assets belonging to each probability range"},"confidenceIntervals":{"type":["array","null"],"items":{"type":"array","items":{"type":"integer"}},"description":"Lower/upper bounds representing respective ranges that the actual number of assets is in"}},"required":["probabilityRanges","estimates"],"description":"Base model for all schema","title":"ConceptPredictionResponse"},"CandidatesToLabel":{"type":"object","properties":{"data":{"type":"array","items":{"description":"Any type"},"description":"Images and video keyframes to label"}},"required":["data"],"description":"A list of selected images or video keyframes to label to improve the accuracy of the\nconcept","title":"CandidatesToLabel"},"ConceptLabelEnum":{"type":"string","enum":["positive","negative"],"description":"Concept label values","title":"ConceptLabelEnum"},"PagedPageDetailsResponse":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Current page number"},"lastPage":{"type":["integer","null"],"description":"Max page number based on limit and total number of items"},"limit":{"type":"integer","description":"Number of items to return"},"offset":{"type":"integer","description":"Starting index to return"},"total":{"type":["integer","null"],"description":"Total number of items"}},"required":["currentPage","limit","offset"],"description":"Pagination metadata","title":"PagedPageDetailsResponse"},"PagedLinksResponse":{"type":"object","properties":{"prev":{"type":["string","null"],"description":"Link to previous page"},"next":{"type":["string","null"],"description":"Link to next page"},"first":{"type":["string","null"],"description":"Link to first page"},"last":{"type":["string","null"],"description":"Link to last page"}},"description":"Metadata for retrieving paginated data","title":"PagedLinksResponse"},"SortDirection":{"type":"string","enum":["asc","desc"],"description":"Possible sort orders\n\nasc: ascending\n desc: descending","title":"SortDirection"},"SortItem":{"type":"object","properties":{"direction":{"$ref":"#/components/schemas/SortDirection","description":"The sort order"},"field":{"type":"string","description":"Which field to sort on"}},"required":["direction","field"],"description":"Metadata about the sort order of the response","title":"SortItem"},"PagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PagedPageDetailsResponse","description":"Details about the total set of data"},"links":{"$ref":"#/components/schemas/PagedLinksResponse","description":"Helpful links to other pages in the pagination"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/SortItem"},"description":"Ordered list of fields to sort on, order of list determines priority"}},"required":["page","links","sort"],"description":"Metadata about the paginated response","title":"PagedMetaResponse"},"ImageMetadata":{"type":"object","properties":{},"description":"The user provided metadata for the image","title":"ImageMetadata"},"Image":{"type":"object","properties":{"createdUserId":{"type":"string","description":"The user that created the resource"},"createdDt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updatedUserId":{"type":"string","description":"The user that last updated the resource"},"updatedDt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"coactiveImageId":{"type":"string","format":"uuid4","description":"The coactive image id"},"path":{"type":"string","description":"The original path of the image"},"id":{"type":["string","null"],"description":"The user provided image id"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/ImageMetadata"},{"type":"null"}],"description":"The user provided metadata for the image"}},"required":["createdUserId","createdDt","updatedUserId","updatedDt","coactiveImageId"],"description":"An image asset response","title":"Image"},"VideoMetadata":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"description":"Any type"}}},"description":"Metadata associated with a video shot.","title":"VideoMetadata"},"Video":{"type":"object","properties":{"createdUserId":{"type":"string","description":"The user that created the resource"},"createdDt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updatedUserId":{"type":"string","description":"The user that last updated the resource"},"updatedDt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"path":{"type":["string","null"],"description":"The original path of the video"},"coactiveVideoId":{"type":"string","format":"uuid4","description":"The coactive video id"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/VideoMetadata"},{"type":"null"}],"description":"The user provided metadata for the video"}},"required":["createdUserId","createdDt","updatedUserId","updatedDt","coactiveVideoId"],"description":"A video asset response","title":"Video"},"app__shared__v1__schema__Shot":{"type":"object","properties":{"shotId":{"type":"string","format":"uuid4","description":"The unique shot id"},"startTimeMs":{"type":"integer","description":"The start time in milliseconds from the beginning of the video"},"endTimeMs":{"type":"integer","description":"The end time in milliseconds from the beginning of the video"}},"required":["shotId","startTimeMs","endTimeMs"],"description":"Metadata about a video shot","title":"app__shared__v1__schema__Shot"},"app__shared__v1__schema__AudioSegment":{"type":"object","properties":{"startTimeMs":{"type":"integer","description":"The start time in milliseconds of the beginning of the audio clip"},"endTimeMs":{"type":"integer","description":"The end time in milliseconds of the end of the audio clip"},"speechToTextTranscription":{"type":"string","description":"The text transcription of the audio clip"}},"required":["startTimeMs","endTimeMs","speechToTextTranscription"],"description":"Metadata about a video audio segment","title":"app__shared__v1__schema__AudioSegment"},"Keyframe":{"type":"object","properties":{"coactiveImageId":{"type":"string","format":"uuid4","description":"The coactive image id"},"video":{"$ref":"#/components/schemas/Video","description":"The video the keyframe belongs to"},"shot":{"$ref":"#/components/schemas/app__shared__v1__schema__Shot","description":"The video shot metadata"},"audioSegment":{"oneOf":[{"$ref":"#/components/schemas/app__shared__v1__schema__AudioSegment"},{"type":"null"}],"description":"Audio segment associated with the keyframe (if the asset_type is 'keyframe')"},"timestamp":{"type":["integer","null"],"description":"The timestamp of the keyframe in the video in milliseconds"}},"required":["coactiveImageId","video","shot"],"description":"A keyframe asset response","title":"Keyframe"},"ConceptLabel":{"type":"object","properties":{"createdUserId":{"type":"string","description":"The user that created the resource"},"createdDt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updatedUserId":{"type":"string","description":"The user that last updated the resource"},"updatedDt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"labelId":{"type":"string","format":"uuid4","description":"The label id"},"label":{"$ref":"#/components/schemas/ConceptLabelEnum","description":"The label for the image or video keyframe"},"image":{"oneOf":[{"$ref":"#/components/schemas/Image"},{"type":"null"}],"description":"The labelled image (if the labelled image is not a video keyframe)"},"keyframe":{"oneOf":[{"$ref":"#/components/schemas/Keyframe"},{"type":"null"}],"description":"The labelled video keyframe (if the labelled image is a video keyframe)"}},"required":["createdUserId","createdDt","updatedUserId","updatedDt","labelId","label"],"description":"An association of an image or video keyframe to a concept","title":"ConceptLabel"},"PagedConceptLabels":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ConceptLabel"},"description":"The paginated data"}},"required":["meta","data"],"description":"A paginated list of labels","title":"PagedConceptLabels"},"PagedConcepts":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Concept"},"description":"The paginated concepts"}},"required":["meta","data"],"description":"A response containing paged data","title":"PagedConcepts"},"UpdateConceptRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"A replacement name for the concept"},"description":{"type":["string","null"],"description":"A replacement description for the concept"},"threshold":{"type":["number","null"],"format":"double","description":"A replacement decision threshold for the concept"},"regularization":{"type":["number","null"],"format":"double","description":"How strongly the model adapts to the training labels. Regularization strength. Lower value means the model fits more heavily to the training data"}},"description":"Base model for all schema","title":"UpdateConceptRequest"},"ConceptLabelRequest":{"type":"object","properties":{"coactiveImageId":{"type":["string","null"],"format":"uuid4","description":"The id of image or video keyframe to label"},"imagePath":{"type":["string","null"],"description":"The path of an image to label"},"label":{"oneOf":[{"$ref":"#/components/schemas/ConceptLabelEnum"},{"type":"null"}],"description":"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."}},"description":"An request to associate an image or video keyframe to a concept","title":"ConceptLabelRequest"},"UpdateConceptLabelsRequest":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/ConceptLabelRequest"},"description":"Labels for the concept. A label with an empty label value will delete any existing labels associate with the provided image or keyframe"},"autosampledNumNegativeLabels":{"type":["integer","null"],"description":"The number of negative labels to add"}},"required":["labels"],"description":"An request to update labels for a concept","title":"UpdateConceptLabelsRequest"},"connections:ConnectionType":{"type":"string","enum":["https_basic","https_bearer","aws_iam_role"],"description":"The type of connection","title":"ConnectionType"},"connections:HTTPSBasicAuthConfig":{"type":"object","properties":{"hostname":{"type":"string","pattern":"^[a-z0-9][a-z0-9\\.\\-]+[a-z0-9]$","minLength":1,"maxLength":255,"description":"The hostname to connect to"},"username":{"type":"string","minLength":1,"maxLength":255,"description":"The username for authentication"},"password":{"type":"string","minLength":1,"maxLength":255,"description":"The password for authentication"}},"required":["hostname","username","password"],"title":"HTTPSBasicAuthConfig"},"connections:CreateHTTPSBasicAuthConnectionRequest":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]+[a-z0-9]","minLength":3,"maxLength":255,"description":"The connection name (3-255 characters, lowercase alphanumeric with underscores)"},"description":{"type":["string","null"],"description":"Optional description for the connection"},"test_location":{"type":["string","null"],"description":"Optional location to test the connection"},"type":{"$ref":"#/components/schemas/connections:ConnectionType"},"config":{"$ref":"#/components/schemas/connections:HTTPSBasicAuthConfig"}},"required":["name","config"],"title":"CreateHTTPSBasicAuthConnectionRequest"},"connections:HTTPSBearerAuthConfig":{"type":"object","properties":{"hostname":{"type":"string","pattern":"^[a-z0-9][a-z0-9\\.\\-]+[a-z0-9]$","minLength":1,"maxLength":255,"description":"The hostname to connect to"},"bearer_token":{"type":"string","minLength":1,"maxLength":255,"description":"The bearer token for authentication"}},"required":["hostname","bearer_token"],"title":"HTTPSBearerAuthConfig"},"connections:CreateHTTPSBearerAuthConnectionRequest":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]+[a-z0-9]","minLength":3,"maxLength":255,"description":"The connection name (3-255 characters, lowercase alphanumeric with underscores)"},"description":{"type":["string","null"],"description":"Optional description for the connection"},"test_location":{"type":["string","null"],"description":"Optional location to test the connection"},"type":{"$ref":"#/components/schemas/connections:ConnectionType"},"config":{"$ref":"#/components/schemas/connections:HTTPSBearerAuthConfig"}},"required":["name","config"],"title":"CreateHTTPSBearerAuthConnectionRequest"},"connections:AWSIAMRoleScope":{"type":"string","enum":["s3","bedrock"],"description":"The scope of permissions for an AWS IAM role connection","title":"AWSIAMRoleScope"},"connections:AWSIAMRoleConfig":{"type":"object","properties":{"iam_role_arn":{"type":"string","pattern":"^arn:aws:iam::\\d{12}:role\\/[\\w+=,.@\\-_/]+$","description":"The ARN of the IAM role to assume"},"scope":{"$ref":"#/components/schemas/connections:AWSIAMRoleScope","description":"The scope of permissions for the IAM role. Defaults to s3."},"bucket_name":{"type":["string","null"],"pattern":"^[a-z0-9][a-z0-9\\.\\-]+[a-z0-9]","minLength":3,"maxLength":63,"description":"The S3 bucket name associated with this connection"},"session_ttl_seconds":{"type":"integer","minimum":60,"maximum":3600,"default":3600,"description":"Session duration in seconds (60-3600)"}},"required":["iam_role_arn"],"title":"AWSIAMRoleConfig"},"connections:CreateAWSConnectionRequest":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]+[a-z0-9]","minLength":3,"maxLength":255,"description":"The connection name (3-255 characters, lowercase alphanumeric with underscores)"},"description":{"type":["string","null"],"description":"Optional description for the connection"},"test_location":{"type":["string","null"],"description":"Optional location to test the connection"},"type":{"$ref":"#/components/schemas/connections:ConnectionType"},"config":{"$ref":"#/components/schemas/connections:AWSIAMRoleConfig"}},"required":["name","config"],"title":"CreateAWSConnectionRequest"},"connections:Connections_create_connection_api_v0_connections_post_Request":{"oneOf":[{"$ref":"#/components/schemas/connections:CreateHTTPSBasicAuthConnectionRequest"},{"$ref":"#/components/schemas/connections:CreateHTTPSBearerAuthConnectionRequest"},{"$ref":"#/components/schemas/connections:CreateAWSConnectionRequest"}],"title":"Connections_create_connection_api_v0_connections_post_Request"},"connections:ConnectionStatus":{"type":"string","enum":["pending","ready","error"],"description":"The status of a connection","title":"ConnectionStatus"},"connections:GetConnectionResponseConfig":{"oneOf":[{"$ref":"#/components/schemas/connections:HTTPSBasicAuthConfig"},{"$ref":"#/components/schemas/connections:HTTPSBearerAuthConfig"},{"$ref":"#/components/schemas/connections:AWSIAMRoleConfig"}],"description":"The connection configuration","title":"GetConnectionResponseConfig"},"connections:GetConnectionResponse":{"type":"object","properties":{"connection_id":{"type":"string","format":"uuid","description":"The unique identifier for the connection"},"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]+[a-z0-9]","minLength":3,"maxLength":255,"description":"The connection name"},"description":{"type":["string","null"],"description":"The connection description"},"type":{"$ref":"#/components/schemas/connections:ConnectionType","description":"The type of connection"},"status":{"$ref":"#/components/schemas/connections:ConnectionStatus","description":"The current status of the connection"},"config":{"$ref":"#/components/schemas/connections:GetConnectionResponseConfig","description":"The connection configuration"},"created_dt":{"type":"string","format":"date-time","description":"When the connection was created"},"updated_dt":{"type":"string","format":"date-time","description":"When the connection was last updated"}},"required":["connection_id","name","type","status","config","created_dt","updated_dt"],"title":"GetConnectionResponse"},"connections:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"connections:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/connections:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"connections:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/connections:ValidationError"}}},"title":"HTTPValidationError"},"connections:ApiV0ConnectionsConnectionNameOrIdDeleteParametersConnectionNameOrId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"ApiV0ConnectionsConnectionNameOrIdDeleteParametersConnectionNameOrId"},"connections:ApiV0ConnectionsConnectionNameOrIdGetParametersConnectionNameOrId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"ApiV0ConnectionsConnectionNameOrIdGetParametersConnectionNameOrId"},"connections:ApiV0ConnectionsConnectionNameOrIdCredentialsGetParametersConnectionNameOrId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"ApiV0ConnectionsConnectionNameOrIdCredentialsGetParametersConnectionNameOrId"},"connections:GetConnectionCredentialsResponse":{"type":"object","properties":{"access_key_id":{"type":"string","description":"The AWS access key ID"},"secret_access_key":{"type":"string","description":"The AWS secret access key"},"session_token":{"type":"string","description":"The AWS session token"},"expires_in":{"type":"integer","description":"Number of seconds until the credentials expire"}},"required":["access_key_id","secret_access_key","session_token","expires_in"],"title":"GetConnectionCredentialsResponse"},"connections:PagedPageDetailsResponse":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"limit":{"type":"integer","description":"Number of items returned in the list response"},"offset":{"type":"integer","description":"Starting index returned for the list response"}},"required":["current_page","limit","offset"],"description":"Pagination metadata","title":"PagedPageDetailsResponse"},"connections:PagedLinksDetailsResponse":{"type":"object","properties":{"current":{"type":"string","description":"The current page link"},"previous":{"type":["string","null"],"description":"The previous page, if applicable"},"next":{"type":["string","null"],"description":"The next page link, if applicable"}},"required":["current","previous","next"],"description":"Pagination metadata","title":"PagedLinksDetailsResponse"},"connections:PagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/connections:PagedPageDetailsResponse","description":"Details about the response page"},"links":{"$ref":"#/components/schemas/connections:PagedLinksDetailsResponse","description":"Links for easy page traversal"}},"required":["page","links"],"description":"Metadata about the paginated response","title":"PagedMetaResponse"},"connections:ListConnectionsResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/connections:PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/connections:GetConnectionResponse"},"description":"The paginated data"}},"required":["meta","data"],"title":"ListConnectionsResponse"},"connections:ApiV0ConnectionsConnectionNameOrIdListPostParametersConnectionNameOrId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"ApiV0ConnectionsConnectionNameOrIdListPostParametersConnectionNameOrId"},"connections:ListWithConnectionRequest":{"type":"object","properties":{"bucket":{"type":"string","description":"The S3 bucket name"},"prefix":{"type":"string","description":"The S3 prefix to list"},"max_keys":{"type":"integer","default":1000,"description":"Maximum number of keys to return"},"continuation_token":{"type":["string","null"],"description":"Token for paginating results"}},"required":["bucket","prefix"],"title":"ListWithConnectionRequest"},"connections:ListWithConnectionResponse":{"type":"object","properties":{"bucket":{"type":"string","description":"The S3 bucket name"},"prefix":{"type":"string","description":"The S3 prefix that was listed"},"keys":{"type":"array","items":{"type":"string"},"description":"The list of object keys"},"common_prefixes":{"type":"array","items":{"type":"string"},"description":"Common prefixes (subdirectories)"},"continuation_token":{"type":["string","null"],"description":"Token for fetching the next page of results"}},"required":["bucket","prefix","keys","common_prefixes"],"title":"ListWithConnectionResponse"},"connections:ApiV0ConnectionsConnectionNameOrIdTestPostParametersConnectionNameOrId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"ApiV0ConnectionsConnectionNameOrIdTestPostParametersConnectionNameOrId"},"connections:TestConnectionRequest":{"type":"object","properties":{"location":{"type":"string","default":"/","description":"Specific location to use to test the connection"},"update_state":{"type":"boolean","default":true,"description":"Set to true update the status of the connection, false to dry run"}},"title":"TestConnectionRequest"},"connections:ApiV0ConnectionsConnectionNameOrIdPatchParametersConnectionNameOrId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"title":"ApiV0ConnectionsConnectionNameOrIdPatchParametersConnectionNameOrId"},"connections:UpdateConnectionRequest":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-z0-9][a-z0-9_]+[a-z0-9]","minLength":3,"maxLength":255,"description":"The new connection name"},"description":{"type":["string","null"],"description":"The new connection description"}},"required":["name"],"title":"UpdateConnectionRequest"},"context-studio:VideoAdSegmentMetadataRequest":{"type":"object","properties":{"segment_type":{"type":"string"},"segment_number":{"type":"integer"},"incode":{"type":"string"},"outcode":{"type":"string"}},"required":["segment_type","segment_number","incode","outcode"],"description":"Request model for ad segment metadata.","title":"VideoAdSegmentMetadataRequest"},"context-studio:VideoAdSegmentCreateRequest":{"type":"object","properties":{"segment_start_time_ms":{"type":"number","format":"double"},"segment_end_time_ms":{"type":"number","format":"double"},"segment_start_frame_number":{"type":"integer"},"segment_end_frame_number":{"type":"integer"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/context-studio:VideoAdSegmentMetadataRequest"},{"type":"null"}]}},"required":["segment_start_time_ms","segment_end_time_ms","segment_start_frame_number","segment_end_frame_number"],"description":"Request model for creating an ad segment.","title":"VideoAdSegmentCreateRequest"},"context-studio:VideoAdSegmentsCreateRequest":{"type":"object","properties":{"ad_segments":{"type":"array","items":{"$ref":"#/components/schemas/context-studio:VideoAdSegmentCreateRequest"}}},"required":["ad_segments"],"description":"Request model for creating ad segments for a video.","title":"VideoAdSegmentsCreateRequest"},"context-studio:AdSegmentInfo":{"type":"object","properties":{"segment_number":{"type":"integer"},"id":{"type":"string","format":"uuid"}},"required":["segment_number","id"],"description":"A single Break Pattern segment with its assigned ID.","title":"AdSegmentInfo"},"context-studio:VideoAdSegmentsCreateResponse":{"type":"object","properties":{"asset_identifier_value":{"type":"string"},"ad_segments_created":{"type":"integer"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/context-studio:AdSegmentInfo"}},"message":{"type":"string"}},"required":["asset_identifier_value","ad_segments_created","segments","message"],"description":"Response returned after ad segments are created.","title":"VideoAdSegmentsCreateResponse"},"context-studio:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"context-studio:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/context-studio:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"context-studio:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/context-studio:ValidationError"}}},"title":"HTTPValidationError"},"context-studio:VideoAdSegmentMetadataResponse":{"type":"object","properties":{"segment_type":{"type":"string"},"segment_number":{"type":"integer"},"incode":{"type":"string"},"outcode":{"type":"string"}},"required":["segment_type","segment_number","incode","outcode"],"description":"Response model for ad segment metadata stored in composite slice JSONB.","title":"VideoAdSegmentMetadataResponse"},"context-studio:VideoAdSegmentResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"segment_start_time_ms":{"type":"number","format":"double"},"segment_end_time_ms":{"type":"number","format":"double"},"segment_start_frame_number":{"type":"integer"},"segment_end_frame_number":{"type":"integer"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/context-studio:VideoAdSegmentMetadataResponse"},{"type":"null"}]}},"required":["id","segment_start_time_ms","segment_end_time_ms","segment_start_frame_number","segment_end_frame_number"],"description":"A single ad segment returned from the DB.","title":"VideoAdSegmentResponse"},"context-studio:VideoAdSegmentsGetResponse":{"type":"object","properties":{"ad_segments":{"type":"array","items":{"$ref":"#/components/schemas/context-studio:VideoAdSegmentResponse"}}},"required":["ad_segments"],"description":"Response wrapper for the GET ad-segments endpoint.","title":"VideoAdSegmentsGetResponse"},"datasets:VisualEncoderNameEnum":{"type":"string","enum":["multimodal","multimodal-tx-large2","multimodal-tx-large3","multimodal-tx-large4","nova2-multimodal","resnet-50","resnet-50-reduced"],"title":"VisualEncoderNameEnum"},"datasets:AssetTypeEnum":{"type":"string","enum":["image","video"],"description":"Indicates the type of asset","title":"AssetTypeEnum"},"datasets:KeyframeSamplingMethodEnum":{"type":"string","enum":["intelligent","uniform"],"description":"Indicates the method used to sample keyframes from a video","title":"KeyframeSamplingMethodEnum"},"datasets:CompositeSettings":{"type":"object","properties":{"maximum_slice_duration_seconds":{"type":"integer","description":"Maximum duration in seconds for a single composite slice."}},"required":["maximum_slice_duration_seconds"],"title":"CompositeSettings"},"datasets:ExtraConfig":{"type":"object","properties":{"composite_settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/datasets:CompositeSettings"},"description":"Mapping of composite type name to its settings."}},"required":["composite_settings"],"title":"ExtraConfig"},"datasets:HybridSearchConfig":{"type":"object","properties":{"weights":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"Weights for each modality used in hybrid search scoring."}},"required":["weights"],"title":"HybridSearchConfig"},"datasets:DatasetConfig":{"type":"object","properties":{"embedding_id":{"type":"object","additionalProperties":{"type":"string","format":"uuid"},"description":"Mapping from encoder modality to the UUID of the embedding model used for that modality."},"encoder_name":{"type":"object","additionalProperties":{"type":"string"},"description":"Mapping from encoder modality to the name of the encoder model used for that modality."},"extra_config":{"oneOf":[{"$ref":"#/components/schemas/datasets:ExtraConfig"},{"type":"null"}],"description":"Optional extra configuration for composite types."},"hybrid_search":{"oneOf":[{"$ref":"#/components/schemas/datasets:HybridSearchConfig"},{"type":"null"}],"description":"Optional hybrid search configuration specifying modality weights."},"context_studio_enabled":{"type":["boolean","null"],"default":false,"description":"Whether Context Studio is enabled for this dataset."},"metadata_fields_to_embed":{"type":["array","null"],"items":{"type":"string"},"description":"Metadata fields whose values are embedded."},"metadata_fields_to_index":{"type":["array","null"],"items":{"type":"string"},"description":"Metadata fields that are indexed for filtering and search."},"celebrity_detection_enabled":{"type":["boolean","null"],"default":false,"description":"Whether celebrity detection is enabled for this dataset."},"agentic_search_metadata_description":{"type":["object","null"],"additionalProperties":{"type":"string"},"description":"Per-key descriptions of metadata fields."},"asset_identifier_key":{"type":["string","null"],"description":"The metadata field name that uniquely identifies each asset in the dataset."},"context_studio_export_json_connection_name":{"type":["string","null"],"description":"The name of the connection required for external s3 export. (this is related to context_studio feature)."}},"required":["embedding_id","encoder_name"],"title":"DatasetConfig"},"datasets:DatasetCreateRequest":{"type":"object","properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9_]+$","minLength":1,"description":"Name of the dataset, must be unique per organization and must only contain alphanumeric and underscore characters."},"encoder_name":{"$ref":"#/components/schemas/datasets:VisualEncoderNameEnum","description":"The model used to extract visual and audio features from assets."},"description":{"type":["string","null"],"description":"A short summary of what the dataset includes or is intended for."},"allowed_asset_types":{"type":"array","items":{"$ref":"#/components/schemas/datasets:AssetTypeEnum"},"description":"Types of assets allowed in this dataset."},"keyframe_sampling_method":{"$ref":"#/components/schemas/datasets:KeyframeSamplingMethodEnum","description":"Sampling method to extract keyframes from videos in dataset."},"keyframe_uniform_fps_sampling_rate":{"type":["number","null"],"format":"double","minimum":0.00001,"maximum":5,"description":"If using uniform sampling method, number of keyframes/sec to sample from videos (allowed values: ≥ .00001 to 5 fps).","deprecated":true},"store_original":{"type":"boolean","default":true,"description":"Whether to store original files."},"store_preview":{"type":"boolean","default":true,"description":"Whether to store preview versions."},"metadata_fields_to_index":{"type":["array","null"],"items":{"type":"string"},"description":"The metadata fields to index for the dataset."},"metadata_fields_to_embed":{"type":["array","null"],"items":{"type":"string"},"description":"The metadata fields to embed for the dataset."},"dataset_config":{"oneOf":[{"$ref":"#/components/schemas/datasets:DatasetConfig"},{"type":"null"}]}},"required":["name","encoder_name"],"description":"Create a dataset schema","title":"DatasetCreateRequest"},"datasets:EncoderName":{"oneOf":[{"$ref":"#/components/schemas/datasets:VisualEncoderNameEnum"},{"type":"string"}],"description":"The model used to extract visual and audio features from assets.","title":"EncoderName"},"datasets:Encoder":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the encoder."},"name":{"$ref":"#/components/schemas/datasets:EncoderName","description":"The model used to extract visual and audio features from assets."},"modality":{"type":"string","description":"The supported modality of the encoder."},"modalities":{"type":"array","items":{"type":"string"},"description":"The supported modalities of the encoder."}},"required":["id","name","modality","modalities"],"title":"Encoder"},"datasets:DatasetStatusEnum":{"type":"string","enum":["active","inactive","deleting","deleted"],"description":"Indicates the operational status of a dataset","title":"DatasetStatusEnum"},"datasets:DatasetResponse":{"type":"object","properties":{"created_dt":{"type":"string","format":"date-time","description":"The created datetime of the resource in ISO 8601 format."},"updated_dt":{"type":["string","null"],"format":"date-time","description":"The datetime the resource was last updated in ISO 8601 format."},"created_by":{"type":"string","description":"ID of the user who added the asset to the dataset."},"updated_by":{"type":["string","null"],"description":"ID of the user who last updated the asset."},"deleted_dt":{"type":["string","null"],"format":"date-time","description":"Timestamp if the resource was deleted."},"deleted_by":{"type":["string","null"],"description":"ID of the user who deleted the resource."},"id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset."},"name":{"type":"string","description":"Name of the dataset, must be unique per organization and must only contain alphanumeric and underscore characters."},"embeddings":{"type":"array","items":{"$ref":"#/components/schemas/datasets:Encoder"},"description":"The encoders of the dataset."},"encoders":{"type":"array","items":{"$ref":"#/components/schemas/datasets:Encoder"},"description":"The encoders of the dataset."},"description":{"type":["string","null"],"description":"A short summary of what the dataset includes or is intended for."},"allowed_asset_types":{"type":"array","items":{"$ref":"#/components/schemas/datasets:AssetTypeEnum"},"description":"Types of assets allowed in this dataset."},"status":{"oneOf":[{"$ref":"#/components/schemas/datasets:DatasetStatusEnum"},{"type":"null"}],"description":"The status of the dataset."},"keyframe_sampling_method":{"$ref":"#/components/schemas/datasets:KeyframeSamplingMethodEnum","description":"Sampling method to extract keyframes from videos in dataset."},"keyframe_uniform_fps_sampling_rate":{"type":["number","null"],"format":"double","description":"FPS rate used for uniform sampling."},"store_original":{"type":"boolean","description":"Whether the original file is stored."},"store_preview":{"type":"boolean","description":"Whether preview files are stored."},"metadata_fields_to_index":{"type":["array","null"],"items":{"type":"string"},"description":"The metadata fields to index for the dataset."},"metadata_fields_to_embed":{"type":["array","null"],"items":{"type":"string"},"description":"The metadata fields to embed for the dataset."},"dataset_config":{"oneOf":[{"$ref":"#/components/schemas/datasets:DatasetConfig"},{"type":"null"}]}},"required":["created_dt","created_by","id","name","embeddings","encoders","description","allowed_asset_types","status","keyframe_sampling_method","store_original","store_preview"],"title":"DatasetResponse"},"datasets:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"datasets:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/datasets:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"datasets:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/datasets:ValidationError"}}},"title":"HTTPValidationError"},"datasets:PagedPageDetailsResponse":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"last_page":{"type":["integer","null"],"description":"Max page number based on limit and total number of items"},"limit":{"type":"integer","description":"Number of items to return"},"offset":{"type":"integer","description":"Starting index to return"},"total":{"type":["integer","null"],"description":"Total number of items"}},"required":["current_page","last_page","limit","offset","total"],"description":"Pagination metadata","title":"PagedPageDetailsResponse"},"datasets:PagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/datasets:PagedPageDetailsResponse","description":"Details about the total set of data"}},"required":["page"],"description":"Metadata about the paginated response","title":"PagedMetaResponse"},"datasets:DatasetGetManyResponse":{"type":"object","properties":{"meta":{"oneOf":[{"$ref":"#/components/schemas/datasets:PagedMetaResponse"},{"type":"null"}],"description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/datasets:DatasetResponse"},"description":"The paginated data"}},"required":["meta","data"],"title":"DatasetGetManyResponse"},"datasets:DatasetUpdateRequestStatus":{"type":"string","enum":["active","inactive"],"description":"The status of the dataset (ACTIVE or INACTIVE)","title":"DatasetUpdateRequestStatus"},"datasets:DatasetUpdateRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Name of the dataset, must be unique per organization and must only contain alphanumeric and underscore characters."},"description":{"type":["string","null"],"description":"A short summary of what the dataset includes or is intended for."},"status":{"$ref":"#/components/schemas/datasets:DatasetUpdateRequestStatus","description":"The status of the dataset (ACTIVE or INACTIVE)"},"store_original":{"type":["boolean","null"],"description":"Whether the original file is stored."},"store_preview":{"type":["boolean","null"],"description":"Whether preview files are stored."},"dataset_config":{"oneOf":[{"$ref":"#/components/schemas/datasets:DatasetConfig"},{"type":"null"}]}},"description":"Update a dataset schema","title":"DatasetUpdateRequest"},"datasets:DatasetConfigResponse":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"embedding_id":{"type":["object","null"],"additionalProperties":{"type":"string","format":"uuid"}},"encoder_name":{"type":["object","null"],"additionalProperties":{"type":"string"}},"hybrid_search":{"type":["object","null"],"additionalProperties":{"type":"object","additionalProperties":{"type":"number","format":"double"}}},"metadata_fields_to_embed":{"type":["array","null"],"items":{"type":"string"}},"metadata_fields_to_index":{"type":["array","null"],"items":{"type":"string"}},"new_video_data_model":{"type":["boolean","null"]},"celebrity_detection_enabled":{"type":["boolean","null"],"default":false},"context_studio_enabled":{"type":["boolean","null"],"default":false},"agentic_search_metadata_description":{"type":["object","null"],"additionalProperties":{"type":"string"}},"asset_identifier_key":{"type":["string","null"]}},"required":["dataset_id"],"description":"Response schema for the dataset_config JSONB column.","title":"DatasetConfigResponse"},"datasets:AudioEncoderNameEnum":{"type":"string","enum":["audio","text-llm"],"title":"AudioEncoderNameEnum"},"datasets:EncoderDescriptionName":{"oneOf":[{"$ref":"#/components/schemas/datasets:VisualEncoderNameEnum"},{"$ref":"#/components/schemas/datasets:AudioEncoderNameEnum"}],"description":"The name of the encoder.","title":"EncoderDescriptionName"},"datasets:ModalityEnum":{"type":"string","enum":["image","audio_speech_to_text","video"],"description":"Indicates the modality of an encoder","title":"ModalityEnum"},"datasets:EncoderDescription":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/datasets:EncoderDescriptionName","description":"The name of the encoder."},"description":{"type":["string","null"],"description":"A short summary of what the encoder is used for."},"modality":{"$ref":"#/components/schemas/datasets:ModalityEnum","description":"The modality of the encoder."}},"required":["name","modality"],"description":"An encoder","title":"EncoderDescription"},"DynamicTagGroupVersionStatus":{"type":"string","enum":["creating","updating","draft","unpublished_changes","published","validated","superseded","error","deleting","deleted"],"description":"Status of a group version.","title":"DynamicTagGroupVersionStatus"},"DynamicTagSortDirection":{"type":"string","enum":["asc","desc"],"description":"Sort direction.","title":"DynamicTagSortDirection"},"DynamicTagPagedPageDetailsResponse":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number (1-indexed)"},"per_page":{"type":"integer","description":"Number of items per page"}},"required":["page","per_page"],"description":"Pagination metadata.","title":"DynamicTagPagedPageDetailsResponse"},"DynamicTagPagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/DynamicTagPagedPageDetailsResponse","description":"Details about pagination"},"has_next_page":{"type":"boolean","default":false,"description":"Whether another page exists"}},"required":["page"],"description":"Metadata about the paginated response.","title":"DynamicTagPagedMetaResponse"},"DynamicTagTagVersionStatus":{"type":"string","enum":["creating","updating","draft","unpublished_changes","published","error","deleting","deleted"],"description":"Status of a tag version.","title":"DynamicTagTagVersionStatus"},"DynamicTagTagVersionSummary":{"type":"object","properties":{"tag_id":{"type":"string","format":"uuid","description":"Unique identifier for the tag"},"tag_version_id":{"type":"string","format":"uuid","description":"Unique identifier for the tag version"},"name":{"type":"string","description":"Name of the tag"},"status":{"$ref":"#/components/schemas/DynamicTagTagVersionStatus","description":"Status of the tag"}},"required":["tag_id","tag_version_id","name","status"],"description":"Response model for a tag with its current version.","title":"DynamicTagTagVersionSummary"},"DynamicTagGroupDatasetAssociationStatus":{"type":"string","enum":["unscored","queued","scoring","scored","error","deleting","deleted"],"description":"Status of association between group and dataset.","title":"DynamicTagGroupDatasetAssociationStatus"},"DynamicTagDataset":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Dataset identifier"},"status":{"$ref":"#/components/schemas/DynamicTagGroupDatasetAssociationStatus","description":"Dataset status"}},"required":["id","status"],"description":"Summary information about associated datasets.","title":"DynamicTagDataset"},"DynamicTagGroupVersionResponse":{"type":"object","properties":{"group_id":{"type":"string","format":"uuid","description":"Unique identifier for the group"},"group_version_id":{"type":"string","format":"uuid","description":"Version identifier"},"name":{"type":"string","description":"Name of the group"},"version_name":{"type":["string","null"],"description":"Human-readable version name"},"status":{"$ref":"#/components/schemas/DynamicTagGroupVersionStatus","description":"Current status of the group version"},"shareable":{"type":"boolean","description":"Whether the group can be shared across datasets"},"created_user_id":{"type":"string","description":"ID of the user who created this version"},"updated_user_id":{"type":"string","description":"ID of the user who last updated this version"},"created_dt":{"type":"string","format":"date-time","description":"Timestamp when the version was created"},"updated_dt":{"type":"string","format":"date-time","description":"Timestamp when the version was last updated"},"group_created_user_id":{"type":"string","description":"ID of the user who created this group"},"group_created_dt":{"type":"string","format":"date-time","description":"Timestamp when the group was created"},"group_description":{"type":["string","null"],"description":"Human-readable description of the group"},"tags_preview":{"type":["array","null"],"items":{"$ref":"#/components/schemas/DynamicTagTagVersionSummary"},"description":"The first 10 tags associated with the group version"},"tags_count":{"type":["integer","null"],"description":"Total number of tags associated with the group version"},"all_draft_tags_reviewed_dt":{"type":["string","null"],"format":"date-time","description":"Timestamp when all draft tags were reviewed"},"review_tags_visited_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when a user first visited the Review Tags section for this group version"},"training_datasets":{"type":["array","null"],"items":{"$ref":"#/components/schemas/DynamicTagDataset"},"description":"List of training datasets associated with the group version"}},"required":["group_id","group_version_id","name","status","shareable","created_user_id","updated_user_id","created_dt","updated_dt","group_created_user_id","group_created_dt","tags_preview","tags_count","all_draft_tags_reviewed_dt","review_tags_visited_at"],"description":"Response model for a group version.","title":"DynamicTagGroupVersionResponse"},"DynamicTagSortField":{"type":"object","properties":{"field":{"type":"string","description":"Field name to sort by"},"direction":{"$ref":"#/components/schemas/DynamicTagSortDirection","description":"Sort direction"}},"required":["field"],"description":"Sort field details.","title":"DynamicTagSortField"},"DynamicTagGetGroupsResponse":{"type":"object","properties":{"meta":{"oneOf":[{"$ref":"#/components/schemas/DynamicTagPagedMetaResponse"},{"type":"null"}],"description":"Metadata for pagination"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DynamicTagGroupVersionResponse"},"description":"The paginated data"},"sort":{"type":["array","null"],"items":{"$ref":"#/components/schemas/DynamicTagSortField"},"description":"Sort details"}},"required":["data"],"description":"Response model for retrieving a paginated list of groups.","title":"DynamicTagGetGroupsResponse"},"AssetType":{"type":"string","enum":["image","video"],"description":"An enumeration.","title":"AssetType"},"DeleteJobAssetIdentifier":{"oneOf":[{"type":"string","format":"uuid"},{"type":"string"}],"description":"Either the Coactive Video/Image ID of the asset or a path string","title":"DeleteJobAssetIdentifier"},"DeleteJobAsset":{"type":"object","properties":{"asset_type":{"$ref":"#/components/schemas/AssetType"},"identifier":{"$ref":"#/components/schemas/DeleteJobAssetIdentifier","description":"Either the Coactive Video/Image ID of the asset or a path string"}},"required":["asset_type","identifier"],"title":"DeleteJobAsset"},"DeleteAssetsRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"assets":{"type":"array","items":{"$ref":"#/components/schemas/DeleteJobAsset"}}},"required":["dataset_id","assets"],"title":"DeleteAssetsRequest"},"DeleteAssetsResponseAssetsItems":{"type":"object","properties":{"asset_type":{"$ref":"#/components/schemas/AssetType"},"identifier":{"$ref":"#/components/schemas/DeleteJobAssetIdentifier","description":"Either the Coactive Video/Image ID of the asset or a path string"},"delete_job_id":{"type":"string","description":"Beanie ObjectId as string"}},"required":["asset_type","identifier","delete_job_id"],"title":"DeleteAssetsResponseAssetsItems"},"DeleteAssetsResponse":{"type":"object","properties":{"org_id":{"type":"string"},"dataset_id":{"type":"string","format":"uuid"},"assets":{"type":"array","items":{"$ref":"#/components/schemas/DeleteAssetsResponseAssetsItems"}}},"required":["org_id","dataset_id","assets"],"title":"DeleteAssetsResponse"},"ingestion:ExplicitExternalAssetType":{"type":"string","enum":["image","video"],"title":"ExplicitExternalAssetType"},"ingestion:ExistingAssetMetadataUpdateMetadata":{"oneOf":[{"type":"boolean"},{"type":"integer"},{"type":"number","format":"double"},{"type":"string"},{"type":"string","format":"date-time"}],"title":"ExistingAssetMetadataUpdateMetadata"},"ingestion:ExistingAssetMetadataUpdate":{"type":"object","properties":{"asset_id":{"type":["string","null"],"format":"uuid"},"source_path":{"type":["string","null"]},"asset_type":{"$ref":"#/components/schemas/ingestion:ExplicitExternalAssetType"},"metadata":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ingestion:ExistingAssetMetadataUpdateMetadata"}}},"required":["asset_type"],"title":"ExistingAssetMetadataUpdate"},"ingestion:MetadataUpdateType":{"type":"string","enum":["overwrite","upsert","remove"],"title":"MetadataUpdateType"},"ingestion:CreateIngestJobForMetadataRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"update_assets":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ingestion:ExistingAssetMetadataUpdate"}},"source_path":{"type":["string","null"]},"update_type":{"$ref":"#/components/schemas/ingestion:MetadataUpdateType"}},"required":["dataset_id"],"title":"CreateIngestJobForMetadataRequest"},"ingestion:IngestJobType":{"type":"string","enum":["unspecified","assets","file","bucket","metadata"],"title":"IngestJobType"},"ingestion:IngestJobAssetMetadata":{"oneOf":[{"type":"boolean"},{"type":"integer"},{"type":"number","format":"double"},{"type":"string"},{"type":"string","format":"date-time"}],"title":"IngestJobAssetMetadata"},"ingestion:ExternalAssetType":{"type":"string","enum":["unspecified","image","video"],"title":"ExternalAssetType"},"ingestion:IngestJobAsset":{"type":"object","properties":{"source_path":{"type":"string"},"metadata":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ingestion:IngestJobAssetMetadata"}},"asset_type":{"$ref":"#/components/schemas/ingestion:ExternalAssetType"}},"required":["source_path"],"title":"IngestJobAsset"},"ingestion:AssetJobDetail":{"type":"object","properties":{"asset":{"$ref":"#/components/schemas/ingestion:IngestJobAsset"},"asset_id":{"type":["string","null"],"format":"uuid"},"error":{"type":["string","null"]}},"required":["asset"],"title":"AssetJobDetail"},"ingestion:AssetsJobDetails":{"type":"object","properties":{"assets":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:AssetJobDetail"}}},"required":["assets"],"title":"AssetsJobDetails"},"ingestion:ExternalFileType":{"type":"string","enum":["unspecified","csv","json"],"title":"ExternalFileType"},"ingestion:CreateIngestJobFromFileRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"source_path":{"type":"string"},"connection_name":{"type":["string","null"]},"file_type":{"$ref":"#/components/schemas/ingestion:ExternalFileType"}},"required":["dataset_id","source_path"],"title":"CreateIngestJobFromFileRequest"},"ingestion:FileJobDetails":{"type":"object","properties":{"file":{"$ref":"#/components/schemas/ingestion:CreateIngestJobFromFileRequest"}},"required":["file"],"title":"FileJobDetails"},"ingestion:ExternalCloudStorageProvider":{"type":"string","enum":["aws"],"title":"ExternalCloudStorageProvider"},"ingestion:BucketSpec":{"type":"object","properties":{"bucket":{"type":"string"},"prefix":{"type":"string","default":"/"},"provider":{"$ref":"#/components/schemas/ingestion:ExternalCloudStorageProvider"}},"required":["bucket"],"title":"BucketSpec"},"ingestion:BucketJobDetails":{"type":"object","properties":{"path":{"type":"string"},"spec":{"$ref":"#/components/schemas/ingestion:BucketSpec"},"max_depth":{"type":"integer","default":0}},"required":["path","spec"],"title":"BucketJobDetails"},"ingestion:InternalAssetMetadataUpdateMetadata":{"oneOf":[{"type":"boolean"},{"type":"integer"},{"type":"number","format":"double"},{"type":"string"},{"type":"string","format":"date-time"}],"title":"InternalAssetMetadataUpdateMetadata"},"ingestion:InternalAssetMetadataUpdate":{"type":"object","properties":{"asset_id":{"type":"string","format":"uuid"},"source_path":{"type":["string","null"]},"asset_type":{"$ref":"#/components/schemas/ingestion:ExplicitExternalAssetType"},"metadata":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ingestion:InternalAssetMetadataUpdateMetadata"}}},"required":["asset_id","source_path","asset_type"],"title":"InternalAssetMetadataUpdate"},"ingestion:MetadataUpdateJobDetails":{"type":"object","properties":{"accepted":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:InternalAssetMetadataUpdate"}},"invalid_assets":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:ExistingAssetMetadataUpdate"}}},"required":["accepted","invalid_assets"],"title":"MetadataUpdateJobDetails"},"ingestion:CreateIngestJobResponseDetails":{"oneOf":[{"$ref":"#/components/schemas/ingestion:AssetsJobDetails"},{"$ref":"#/components/schemas/ingestion:FileJobDetails"},{"$ref":"#/components/schemas/ingestion:BucketJobDetails"},{"$ref":"#/components/schemas/ingestion:MetadataUpdateJobDetails"}],"title":"CreateIngestJobResponseDetails"},"ingestion:RequestType":{"type":"string","enum":["submit"],"title":"RequestType"},"ingestion:IngestJobStatusEnum":{"type":"string","enum":["completed","failed","in_progress","pending","paused","stopping","stopped"],"description":"Enum of Ingest Job Status.","title":"IngestJobStatusEnum"},"ingestion:CreateIngestJobResponse":{"type":"object","properties":{"id":{"type":"string"},"org_id":{"type":"string"},"dataset_id":{"type":"string","format":"uuid"},"connection_name":{"type":["string","null"]},"job_type":{"$ref":"#/components/schemas/ingestion:IngestJobType"},"details":{"oneOf":[{"$ref":"#/components/schemas/ingestion:CreateIngestJobResponseDetails"},{"type":"null"}]},"request_type":{"$ref":"#/components/schemas/ingestion:RequestType"},"status":{"$ref":"#/components/schemas/ingestion:IngestJobStatusEnum"},"created_dt":{"type":"string","format":"date-time"},"updated_dt":{"type":["string","null"],"format":"date-time"},"total_assets":{"type":["integer","null"]},"processed_assets":{"type":"integer","default":0},"errored_assets":{"type":"integer","default":0},"request_id":{"type":["string","null"]}},"required":["id","org_id","dataset_id","job_type","details","created_dt"],"title":"CreateIngestJobResponse"},"ingestion:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"ingestion:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"ingestion:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:ValidationError"}}},"title":"HTTPValidationError"},"ingestion:CreateIngestJobFromAssetsRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"connection_name":{"type":["string","null"]},"assets":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:IngestJobAsset"}}},"required":["dataset_id","assets"],"title":"CreateIngestJobFromAssetsRequest"},"ingestion:CreateIngestJobFromBucketRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"connection_name":{"type":["string","null"]},"path":{"type":["string","null"]},"spec":{"oneOf":[{"$ref":"#/components/schemas/ingestion:BucketSpec"},{"type":"null"}]},"source_path":{"type":["string","null"]},"source_spec":{"oneOf":[{"$ref":"#/components/schemas/ingestion:BucketSpec"},{"type":"null"}]},"max_depth":{"type":"integer","minimum":0,"maximum":10,"default":0,"description":"Max depth of recursion under a prefix"}},"required":["dataset_id"],"title":"CreateIngestJobFromBucketRequest"},"ingestion:IngestJobImageMetadata":{"oneOf":[{"type":"boolean"},{"type":"integer"},{"type":"number","format":"double"},{"type":"string"},{"type":"string","format":"date-time"}],"title":"IngestJobImageMetadata"},"ingestion:IngestJobImage":{"type":"object","properties":{"source_path":{"type":"string"},"metadata":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ingestion:IngestJobImageMetadata"}}},"required":["source_path"],"title":"IngestJobImage"},"ingestion:CreateIngestJobFromImagesRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"connection_name":{"type":["string","null"]},"images":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:IngestJobImage"}}},"required":["dataset_id","images"],"title":"CreateIngestJobFromImagesRequest"},"ingestion:IngestJobVideoMetadata":{"oneOf":[{"type":"boolean"},{"type":"integer"},{"type":"number","format":"double"},{"type":"string"},{"type":"string","format":"date-time"}],"title":"IngestJobVideoMetadata"},"ingestion:IngestJobVideo":{"type":"object","properties":{"source_path":{"type":"string"},"metadata":{"type":["object","null"],"additionalProperties":{"$ref":"#/components/schemas/ingestion:IngestJobVideoMetadata"}}},"required":["source_path"],"title":"IngestJobVideo"},"ingestion:CreateIngestJobFromVideosRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"connection_name":{"type":["string","null"]},"videos":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:IngestJobVideo"}}},"required":["dataset_id","videos"],"title":"CreateIngestJobFromVideosRequest"},"ingestion:GetOneIngestJobResponseDetails":{"oneOf":[{"$ref":"#/components/schemas/ingestion:AssetsJobDetails"},{"$ref":"#/components/schemas/ingestion:FileJobDetails"},{"$ref":"#/components/schemas/ingestion:BucketJobDetails"},{"$ref":"#/components/schemas/ingestion:MetadataUpdateJobDetails"}],"title":"GetOneIngestJobResponseDetails"},"ingestion:AssetType":{"type":"string","enum":["unspecified","image","keyframe","video","audio","metadata","csv","json","s3_prefix"],"title":"AssetType"},"ingestion:GetOneIngestJobResponse":{"type":"object","properties":{"id":{"type":["string","null"]},"org_id":{"type":"string"},"dataset_id":{"type":"string","format":"uuid"},"connection_name":{"type":["string","null"]},"job_type":{"$ref":"#/components/schemas/ingestion:IngestJobType"},"details":{"oneOf":[{"$ref":"#/components/schemas/ingestion:GetOneIngestJobResponseDetails"},{"type":"null"}]},"source_type":{"oneOf":[{"$ref":"#/components/schemas/ingestion:AssetType"},{"type":"null"}]},"file_path":{"type":["string","null"]},"created_dt":{"type":["string","null"],"format":"date-time"},"updated_dt":{"type":["string","null"],"format":"date-time"},"started_dt":{"type":["string","null"],"format":"date-time"},"finished_dt":{"type":["string","null"],"format":"date-time"},"status":{"$ref":"#/components/schemas/ingestion:IngestJobStatusEnum"},"total_assets":{"type":["integer","null"]},"processed_assets":{"type":"integer","default":0},"errored_assets":{"type":"integer","default":0},"error_details":{"type":["string","null"]},"request_id":{"type":["string","null"]}},"required":["org_id","dataset_id","job_type","details","file_path","total_assets"],"title":"GetOneIngestJobResponse"},"ingestion:EventFilter":{"type":"string","enum":["completed","error","in_progress"],"title":"EventFilter"},"ingestion:GetDatasetAssetsStatusRequest":{"type":"object","properties":{"source_path":{"type":["string","null"]}},"title":"GetDatasetAssetsStatusRequest"},"ingestion:PagedPageDetailsResponse":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"last_page":{"type":["integer","null"],"description":"Max page number based on limit and total number of items"},"limit":{"type":"integer","description":"Number of items to return"},"offset":{"type":"integer","description":"Starting index to return"},"total":{"type":["integer","null"],"description":"Total number of items"}},"required":["current_page","last_page","limit","offset","total"],"description":"Pagination metadata","title":"PagedPageDetailsResponse"},"ingestion:PagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/ingestion:PagedPageDetailsResponse","description":"Details about the total set of data"}},"required":["page"],"description":"Metadata about the paginated response","title":"PagedMetaResponse"},"ingestion:AssetStatusEnum":{"type":"string","enum":["pending","in_progress","received","processing_started","completed","error"],"title":"AssetStatusEnum"},"ingestion:ErrorCode":{"type":"string","enum":["unknown","unknown_content_type","file_not_found","permission_denied","broken_url","file_too_large","video_too_short","video_too_long","resolution_out_of_spec","unsupported_format","unsupported_codec","unsupported_source_type","unsupported_uri_scheme","audio_processing_failed","asset_metadata_error","transcription_failed","composite_creation_failed","composite_slice_creation_failed"],"title":"ErrorCode"},"ingestion:EventName":{"type":"string","enum":["received","assets_enumerated","completed","processing_started","error","kind_determined","stored","metadata_stored","embedding_computed","embedding_stored","asset_copied","timecodes_computed","audio_extracted","audio_processing_started","audio_processing_finished","keyframe_generation_started","keyframe_generation_completed","shot_boundary_detection_started","shot_boundary_detection_completed","file_downloaded","keyframe_generated","transcribed","transcription_segmented","transcripts_created","composite_created","composite_slices_created"],"description":"The status-related event that applies to the entity.","title":"EventName"},"ingestion:EventEntity":{"type":"string","enum":["unspecified","request","image","video","audio","shot","visual_keyframe","audio_keyframe","audio_segment","metadata","csv_file","json_file","s3_prefix","composite"],"description":"The kind of entity that the status event applies to.\n\nDetermines what collection of IDs show up in the event, e.g.:\n    - request (fewest):\n        - request_id\n        - ingest_job_id\n        - dataset_id\n        - org_id\n    - audio_keyframe (most):\n        - coactive_image_id\n        - coactive_audio_segment_id\n        - coactive_shot_id\n        - coactive_video_id\n        - request_id\n        - ingest_job_id\n        - dataset_id\n        - org_id","title":"EventEntity"},"ingestion:LatestEvent":{"type":"object","properties":{"event_type":{"oneOf":[{"$ref":"#/components/schemas/ingestion:EventName"},{"type":"null"}]},"event_entity":{"oneOf":[{"$ref":"#/components/schemas/ingestion:EventEntity"},{"type":"null"}]},"timestamp_dt":{"type":["string","null"],"format":"date-time"}},"title":"LatestEvent"},"ingestion:Status":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ingestion:AssetStatusEnum"},"asset_id":{"type":"string","format":"uuid"},"dataset_id":{"type":"string","format":"uuid"},"error_code":{"oneOf":[{"$ref":"#/components/schemas/ingestion:ErrorCode"},{"type":"null"}]},"error_reason":{"type":["string","null"]},"source_path":{"type":["string","null"]},"latest_event":{"$ref":"#/components/schemas/ingestion:LatestEvent"},"asset_type":{"type":["string","null"]}},"required":["status","asset_id","dataset_id","latest_event"],"title":"Status"},"ingestion:PagedAssetsStatusResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ingestion:PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:Status"},"description":"The paginated data"}},"required":["meta","data"],"title":"PagedAssetsStatusResponse"},"ingestion:EmptyResponse":{"type":"object","properties":{"data":{"type":"array","items":{"description":"Any type"},"description":"Empty data list"}},"title":"EmptyResponse"},"ingestion:Status_get_dataset_assets_status_api_v1_ingestion_datasets__dataset_id__assets_status_post_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ingestion:PagedAssetsStatusResponse"},{"$ref":"#/components/schemas/ingestion:EmptyResponse"}],"title":"Status_get_dataset_assets_status_api_v1_ingestion_datasets__dataset_id__assets_status_post_Response_200"},"ingestion:DatasetAssetsStatusCountResponse":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"integer"},"description":"A dictionary of event filters and their counts"}},"required":["data"],"title":"DatasetAssetsStatusCountResponse"},"ingestion:StatusSummary":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ingestion:AssetStatusEnum"},"asset_id":{"type":"string","format":"uuid"},"dataset_id":{"type":"string","format":"uuid"},"asset_type":{"type":"string"},"source_path":{"type":["string","null"]},"ingestion_dt":{"type":["string","null"],"format":"date-time"}},"required":["status","asset_id","dataset_id","asset_type"],"title":"StatusSummary"},"ingestion:PagedAssetsStatusSummaryResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ingestion:PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:StatusSummary"},"description":"The paginated data"}},"required":["meta","data"],"title":"PagedAssetsStatusSummaryResponse"},"ingestion:Status_get_dataset_assets_status_summary_api_v1_ingestion_datasets__dataset_id__assets_status_summary_get_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ingestion:PagedAssetsStatusSummaryResponse"},{"$ref":"#/components/schemas/ingestion:EmptyResponse"}],"title":"Status_get_dataset_assets_status_summary_api_v1_ingestion_datasets__dataset_id__assets_status_summary_get_Response_200"},"ingestion:DatasetIngestionInfo":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ingestion:IngestJobStatusEnum"},"ingest_job_id":{"type":"string","description":"The ID of the ingestion job"},"ingestion_dt":{"type":["string","null"],"format":"date-time","description":"The date and time of the ingestion job"}},"required":["status","ingest_job_id","ingestion_dt"],"title":"DatasetIngestionInfo"},"ingestion:DatasetIngestionStatusResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ingestion:PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:DatasetIngestionInfo"},"description":"The paginated data"}},"required":["meta","data"],"title":"DatasetIngestionStatusResponse"},"ingestion:Status_get_dataset_status_api_v1_ingestion_datasets__dataset_id__status_get_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ingestion:DatasetIngestionStatusResponse"},{"$ref":"#/components/schemas/ingestion:EmptyResponse"}],"title":"Status_get_dataset_status_api_v1_ingestion_datasets__dataset_id__status_get_Response_200"},"ingestion:ImageAssetStatusResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ingestion:Status"}},"required":["data"],"title":"ImageAssetStatusResponse"},"ingestion:Status_get_image_asset_status_api_v1_ingestion_images__asset_id__status_get_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ingestion:ImageAssetStatusResponse"},{"$ref":"#/components/schemas/ingestion:EmptyResponse"}],"title":"Status_get_image_asset_status_api_v1_ingestion_images__asset_id__status_get_Response_200"},"ingestion:GetManyIngestJobsResponse":{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:GetOneIngestJobResponse"}}},"required":["jobs"],"title":"GetManyIngestJobsResponse"},"ingestion:PagedDataResponse_Status_":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ingestion:PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ingestion:Status"},"description":"The paginated data"}},"required":["meta","data"],"title":"PagedDataResponse_Status_"},"ingestion:JobStatus":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ingestion:IngestJobStatusEnum"},"assets":{"$ref":"#/components/schemas/ingestion:PagedDataResponse_Status_","description":"A list of assets that are part of the ingestion job"}},"required":["status"],"title":"JobStatus"},"ingestion:IngestJobStatusResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ingestion:JobStatus"}},"required":["data"],"title":"IngestJobStatusResponse"},"ingestion:Status_get_job_status_api_v1_ingestion_jobs__ingest_job_id__status_get_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ingestion:IngestJobStatusResponse"},{"$ref":"#/components/schemas/ingestion:EmptyResponse"}],"title":"Status_get_job_status_api_v1_ingestion_jobs__ingest_job_id__status_get_Response_200"},"ingestion:VideoAssetStatusResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ingestion:Status"}},"required":["data"],"title":"VideoAssetStatusResponse"},"ingestion:Status_get_video_asset_status_api_v1_ingestion_videos__asset_id__status_get_Response_200":{"oneOf":[{"$ref":"#/components/schemas/ingestion:VideoAssetStatusResponse"},{"$ref":"#/components/schemas/ingestion:EmptyResponse"}],"title":"Status_get_video_asset_status_api_v1_ingestion_videos__asset_id__status_get_Response_200"},"queries:QueryType":{"type":"string","enum":["NATURAL_LANGUAGE","SQL"],"description":"All possible query types","title":"QueryType"},"queries:QueryStatus":{"type":"string","enum":["Queued","Running","Stopping","Stopped","Complete","Error"],"description":"All possible query status values","title":"QueryStatus"},"queries:app__api__v1__schema__GetQueryResponse":{"type":"object","properties":{"query_id":{"type":"string","format":"uuid"},"query":{"type":"string"},"type":{"$ref":"#/components/schemas/queries:QueryType"},"status":{"$ref":"#/components/schemas/queries:QueryStatus"},"results":{"type":["string","null"]},"start_dt":{"type":["string","null"],"format":"date-time"},"end_dt":{"type":["string","null"],"format":"date-time"},"dataset_id":{"type":"string","format":"uuid"},"total_row_count":{"type":["integer","null"]},"parameters":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"created_dt":{"type":"string","format":"date-time"},"updated_dt":{"type":"string","format":"date-time"},"created_user_id":{"type":"string"},"updated_user_id":{"type":["string","null"]}},"required":["query_id","query","type","status","results","dataset_id","created_dt","updated_dt","created_user_id"],"title":"app__api__v1__schema__GetQueryResponse"},"queries:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"queries:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/queries:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"queries:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/queries:ValidationError"}}},"title":"HTTPValidationError"},"queries:app__api__v1__schema__CreateQueryRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"query":{"type":"string"},"type":{"$ref":"#/components/schemas/queries:QueryType"},"parameters":{"type":["object","null"],"additionalProperties":{"description":"Any type"}},"embedding_id":{"type":["string","null"],"format":"uuid"},"check_validity":{"type":"boolean","default":true},"dynamic_tags_version":{"type":"string","default":"v2"}},"required":["dataset_id","query"],"title":"app__api__v1__schema__CreateQueryRequest"},"queries:ExportType":{"type":"string","enum":["DELTA","CSV","UNITY"],"description":"All possible export types","title":"ExportType"},"queries:ExportQueryRequest":{"type":"object","properties":{"connection_name":{"type":["string","null"],"default":"coactive"},"export_type":{"$ref":"#/components/schemas/queries:ExportType"},"target_bucket":{"type":"string"},"target_prefix":{"type":"string"}},"required":["target_bucket","target_prefix"],"title":"ExportQueryRequest"},"queries:app__api__v1__schema__ExportQueryResponse":{"type":"object","properties":{"query_id":{"type":"string","format":"uuid"},"export_id":{"type":"string","format":"uuid"},"status":{"type":"string"},"message":{"type":"string"}},"required":["query_id","export_id","status","message"],"title":"app__api__v1__schema__ExportQueryResponse"},"queries:ApiV1QueriesQueryIdResultsGetParametersUrlFormat":{"type":"string","enum":["download","direct"],"default":"download","title":"ApiV1QueriesQueryIdResultsGetParametersUrlFormat"},"queries:GetQueryResultsResponse":{"type":"object","properties":{"query_id":{"type":"string","format":"uuid"},"download_url":{"type":"string"}},"required":["query_id","download_url"],"title":"GetQueryResultsResponse"},"queries:Table":{"type":"object","properties":{"name":{"type":"string"},"table_schema":{"type":["object","null"],"additionalProperties":{"description":"Any type"}}},"required":["name","table_schema"],"title":"Table"},"queries:Body_list_queries_api_v1_queries_get":{"type":"object","properties":{"query_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid"}},"user_ids":{"type":["array","null"],"items":{"type":"string"}},"exclude_user_ids":{"type":["array","null"],"items":{"type":"string"}}},"title":"Body_list_queries_api_v1_queries_get"},"queries:PagedPageDetailsResponse":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"limit":{"type":"integer","description":"Number of items returned in the list response"},"offset":{"type":"integer","description":"Starting index returned for the list response"}},"required":["current_page","limit","offset"],"description":"Pagination metadata","title":"PagedPageDetailsResponse"},"queries:PagedLinksDetailsResponse":{"type":"object","properties":{"current":{"type":"string","description":"The current page link"},"previous":{"type":["string","null"],"description":"The previous page, if applicable"},"next":{"type":["string","null"],"description":"The next page link, if applicable"}},"required":["current","previous","next"],"description":"Pagination metadata","title":"PagedLinksDetailsResponse"},"queries:PagedMetaResponse":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/queries:PagedPageDetailsResponse","description":"Details about the response page"},"links":{"$ref":"#/components/schemas/queries:PagedLinksDetailsResponse","description":"Links for easy page traversal"}},"required":["page","links"],"description":"Metadata about the paginated response","title":"PagedMetaResponse"},"queries:app__api__v1__schema__ListQueriesResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/queries:PagedMetaResponse","description":"Metadata for the set of data returned"},"data":{"type":"array","items":{"$ref":"#/components/schemas/queries:app__api__v1__schema__GetQueryResponse"},"description":"The paginated data"}},"required":["meta","data"],"title":"app__api__v1__schema__ListQueriesResponse"},"queries:ListTablesResponse":{"type":"object","properties":{"tables":{"type":"array","items":{"$ref":"#/components/schemas/queries:Table"}}},"required":["tables"],"title":"ListTablesResponse"},"search:BooleanEqualsClause":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["=="]},"value":{"type":"boolean"}},"required":["key","operator","value"],"title":"BooleanEqualsClause"},"search:EqualsClause":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["=="]},"value":{"type":"string"}},"required":["key","operator","value"],"title":"EqualsClause"},"search:NotEqualsClause":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["!="]},"value":{"type":"string"}},"required":["key","operator","value"],"title":"NotEqualsClause"},"search:DateTimeRangeInclusiveClause":{"type":"object","properties":{"key":{"type":"string"},"start_utc_epoch":{"type":["number","null"],"format":"double"},"end_utc_epoch":{"type":["number","null"],"format":"double"},"operator":{"type":"string","enum":["DateTimeRangeInclusive"]}},"required":["key","operator"],"title":"DateTimeRangeInclusiveClause"},"search:MetadataFiltersFiltersItems":{"oneOf":[{"$ref":"#/components/schemas/search:BooleanEqualsClause"},{"$ref":"#/components/schemas/search:EqualsClause"},{"$ref":"#/components/schemas/search:NotEqualsClause"},{"$ref":"#/components/schemas/search:DateTimeRangeInclusiveClause"}],"title":"MetadataFiltersFiltersItems"},"search:MetadataFilters":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/search:MetadataFiltersFiltersItems"}}},"required":["filters"],"title":"MetadataFilters"},"search:ScoreType":{"type":"string","enum":["probability","level"],"description":"Score type returned by the moderation service.\n- PROBABILITY: Scores in range 0-1 (uses BGE Reranker model)\n- LEVEL: Scores in range 0-5 (uses OpenAI model)","title":"ScoreType"},"search:AudioSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"text_query":{"type":"string","description":"The text query to search for"},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"}},"required":["dataset_id","text_query"],"description":"Audio search request","title":"AudioSearchRequest"},"search:Image":{"type":"object","properties":{"created_user_id":{"type":"string","description":"The user that created the resource"},"created_dt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updated_user_id":{"type":"string","description":"The user that last updated the resource"},"updated_dt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"coactive_image_id":{"type":"string","format":"uuid","description":"The coactive image id"},"path":{"type":["string","null"],"description":"The original path of the image"},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"The user provided metadata for the image"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the image"}},"required":["created_user_id","created_dt","updated_user_id","updated_dt","coactive_image_id"],"description":"An image asset response","title":"Image"},"search:Video":{"type":"object","properties":{"created_user_id":{"type":"string","description":"The user that created the resource"},"created_dt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updated_user_id":{"type":"string","description":"The user that last updated the resource"},"updated_dt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"path":{"type":["string","null"],"description":"The original path of the video"},"coactive_video_id":{"type":"string","format":"uuid","description":"The coactive video id"},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"The user provided metadata for the video"}},"required":["created_user_id","created_dt","updated_user_id","updated_dt","coactive_video_id"],"description":"A video asset response","title":"Video"},"search:AudioSegment":{"type":"object","properties":{"start_time_ms":{"type":"integer","description":"The start time in milliseconds of the beginning of the audio clip"},"end_time_ms":{"type":"integer","description":"The end time in milliseconds of the end of the audio clip"},"speech_to_text_transcription":{"type":"string","description":"The text transcription of the audio clip"}},"required":["start_time_ms","end_time_ms","speech_to_text_transcription"],"description":"Metadata about a video audio segment","title":"AudioSegment"},"search:app__api__routes__search__v1__schema__native_video_model_schema__Keyframe":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid","description":"The coactive image id"},"video":{"$ref":"#/components/schemas/search:Video","description":"The video that this keyframe belongs to"},"audio_segment":{"oneOf":[{"$ref":"#/components/schemas/search:AudioSegment"},{"type":"null"}],"description":"The audio segment associated with this keyframe"},"timestamp":{"type":["integer","null"],"description":"The timestamp in milliseconds of the keyframe in the video"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the image"}},"required":["coactive_image_id","video"],"description":"A keyframe asset response for native video model datasets (without shot metadata)","title":"app__api__routes__search__v1__schema__native_video_model_schema__Keyframe"},"search:AppApiRoutesSearchV1SchemaNativeVideoModelSchemaSearchResponseDataItems":{"oneOf":[{"$ref":"#/components/schemas/search:Image"},{"$ref":"#/components/schemas/search:app__api__routes__search__v1__schema__native_video_model_schema__Keyframe"}],"title":"AppApiRoutesSearchV1SchemaNativeVideoModelSchemaSearchResponseDataItems"},"search:app__api__routes__search__v1__schema__native_video_model_schema__SearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:AppApiRoutesSearchV1SchemaNativeVideoModelSchemaSearchResponseDataItems"},"description":"The paginated results for native video model datasets"}},"required":["data"],"description":"Native video model search response","title":"app__api__routes__search__v1__schema__native_video_model_schema__SearchResponse"},"search:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"search:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/search:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"search:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/search:ValidationError"}}},"title":"HTTPValidationError"},"search:AudioClass":{"type":"string","enum":["Speech","Male speech, man speaking","Female speech, woman speaking","Child speech, kid speaking","Conversation","Narration, monologue","Babbling","Speech synthesizer","Shout","Bellow","Whoop","Yell","Battle cry","Children shouting","Screaming","Whispering","Laughter","Baby laughter","Giggle","Snicker","Belly laugh","Chuckle, chortle","Crying, sobbing","Baby cry, infant cry","Whimper","Wail, moan","Sigh","Singing","Choir","Yodeling","Chant","Mantra","Male singing","Female singing","Child singing","Synthetic singing","Rapping","Humming","Groan","Grunt","Whistling","Breathing","Wheeze","Snoring","Gasp","Pant","Snort","Cough","Throat clearing","Sneeze","Sniff","Run","Shuffle","Walk, footsteps","Chewing, mastication","Biting","Gargling","Stomach rumble","Burping, eructation","Hiccup","Fart","Hands","Finger snapping","Clapping","Heart sounds, heartbeat","Heart murmur","Cheering","Applause","Chatter","Crowd","Hubbub, speech noise, speech babble","Children playing","Animal","Domestic animals, pets","Dog","Bark","Yip","Howl","Bow-wow","Growling","Whimper (dog)","Cat","Purr","Meow","Hiss","Caterwaul","Livestock, farm animals, working animals","Horse","Clip-clop","Neigh, whinny","Cattle, bovinae","Moo","Cowbell","Pig","Oink","Goat","Bleat","Sheep","Fowl","Chicken, rooster","Cluck","Crowing, cock-a-doodle-doo","Turkey","Gobble","Duck","Quack","Goose","Honk","Wild animals","Roaring cats (lions, tigers)","Roar","Bird","Bird vocalization, bird call, bird song","Chirp, tweet","Squawk","Pigeon, dove","Coo","Crow","Caw","Owl","Hoot","Bird flight, flapping wings","Canidae, dogs, wolves","Rodents, rats, mice","Mouse","Patter","Insect","Cricket","Mosquito","Fly, housefly","Buzz","Bee, wasp, etc.","Frog","Croak","Snake","Rattle","Whale vocalization","Music","Musical instrument","Plucked string instrument","Guitar","Electric guitar","Bass guitar","Acoustic guitar","Steel guitar, slide guitar","Tapping (guitar technique)","Strum","Banjo","Sitar","Mandolin","Zither","Ukulele","Keyboard (musical)","Piano","Electric piano","Organ","Electronic organ","Hammond organ","Synthesizer","Sampler","Harpsichord","Percussion","Drum kit","Drum machine","Drum","Snare drum","Rimshot","Drum roll","Bass drum","Timpani","Tabla","Cymbal","Hi-hat","Wood block","Tambourine","Rattle (instrument)","Maraca","Gong","Tubular bells","Mallet percussion","Marimba, xylophone","Glockenspiel","Vibraphone","Steelpan","Orchestra","Brass instrument","French horn","Trumpet","Trombone","Bowed string instrument","String section","Violin, fiddle","Pizzicato","Cello","Double bass","Wind instrument, woodwind instrument","Flute","Saxophone","Clarinet","Harp","Bell","Church bell","Jingle bell","Bicycle bell","Tuning fork","Chime","Wind chime","Change ringing (campanology)","Harmonica","Accordion","Bagpipes","Didgeridoo","Shofar","Theremin","Singing bowl","Scratching (performance technique)","Pop music","Hip hop music","Beatboxing","Rock music","Heavy metal","Punk rock","Grunge","Progressive rock","Rock and roll","Psychedelic rock","Rhythm and blues","Soul music","Reggae","Country","Swing music","Bluegrass","Funk","Folk music","Middle Eastern music","Jazz","Disco","Classical music","Opera","Electronic music","House music","Techno","Dubstep","Drum and bass","Electronica","Electronic dance music","Ambient music","Trance music","Music of Latin America","Salsa music","Flamenco","Blues","Music for children","New-age music","Vocal music","A capella","Music of Africa","Afrobeat","Christian music","Gospel music","Music of Asia","Carnatic music","Music of Bollywood","Ska","Traditional music","Independent music","Song","Background music","Theme music","Jingle (music)","Soundtrack music","Lullaby","Video game music","Christmas music","Dance music","Wedding music","Happy music","Funny music","Sad music","Tender music","Exciting music","Angry music","Scary music","Wind","Rustling leaves","Wind noise (microphone)","Thunderstorm","Thunder","Water","Rain","Raindrop","Rain on surface","Stream","Waterfall","Ocean","Waves, surf","Steam","Gurgling","Fire","Crackle","Vehicle","Boat, Water vehicle","Sailboat, sailing ship","Rowboat, canoe, kayak","Motorboat, speedboat","Ship","Motor vehicle (road)","Car","Vehicle horn, car horn, honking","Toot","Car alarm","Power windows, electric windows","Skidding","Tire squeal","Car passing by","Race car, auto racing","Truck","Air brake","Air horn, truck horn","Reversing beeps","Ice cream truck, ice cream van","Bus","Emergency vehicle","Police car (siren)","Ambulance (siren)","Fire engine, fire truck (siren)","Motorcycle","Traffic noise, roadway noise","Rail transport","Train","Train whistle","Train horn","Railroad car, train wagon","Train wheels squealing","Subway, metro, underground","Aircraft","Aircraft engine","Jet engine","Propeller, airscrew","Helicopter","Fixed-wing aircraft, airplane","Bicycle","Skateboard","Engine","Light engine (high frequency)","Dental drill, dentist's drill","Lawn mower","Chainsaw","Medium engine (mid frequency)","Heavy engine (low frequency)","Engine knocking","Engine starting","Idling","Accelerating, revving, vroom","Door","Doorbell","Ding-dong","Sliding door","Slam","Knock","Tap","Squeak","Cupboard open or close","Drawer open or close","Dishes, pots, and pans","Cutlery, silverware","Chopping (food)","Frying (food)","Microwave oven","Blender","Water tap, faucet","Sink (filling or washing)","Bathtub (filling or washing)","Hair dryer","Toilet flush","Toothbrush","Electric toothbrush","Vacuum cleaner","Zipper (clothing)","Keys jangling","Coin (dropping)","Scissors","Electric shaver, electric razor","Shuffling cards","Typing","Typewriter","Computer keyboard","Writing","Alarm","Telephone","Telephone bell ringing","Ringtone","Telephone dialing, DTMF","Dial tone","Busy signal","Alarm clock","Siren","Civil defense siren","Buzzer","Smoke detector, smoke alarm","Fire alarm","Foghorn","Whistle","Steam whistle","Mechanisms","Ratchet, pawl","Clock","Tick","Tick-tock","Gears","Pulleys","Sewing machine","Mechanical fan","Air conditioning","Cash register","Printer","Camera","Single-lens reflex camera","Tools","Hammer","Jackhammer","Sawing","Filing (rasp)","Sanding","Power tool","Drill","Explosion","Gunshot, gunfire","Machine gun","Fusillade","Artillery fire","Cap gun","Fireworks","Firecracker","Burst, pop","Eruption","Boom","Wood","Chop","Splinter","Crack","Glass","Chink, clink","Shatter","Liquid","Splash, splatter","Slosh","Squish","Drip","Pour","Trickle, dribble","Gush","Fill (with liquid)","Spray","Pump (liquid)","Stir","Boiling","Sonar","Arrow","Whoosh, swoosh, swish","Thump, thud","Thunk","Electronic tuner","Effects unit","Chorus effect","Basketball bounce","Bang","Slap, smack","Whack, thwack","Smash, crash","Breaking","Bouncing","Whip","Flap","Scratch","Scrape","Rub","Roll","Crushing","Crumpling, crinkling","Tearing","Beep, bleep","Ping","Ding","Clang","Squeal","Creak","Rustle","Whir","Clatter","Sizzle","Clicking","Clickety-clack","Rumble","Plop","Jingle, tinkle","Hum","Zing","Boing","Crunch","Silence","Sine wave","Harmonic","Chirp tone","Sound effect","Pulse","Inside, small room","Inside, large room or hall","Inside, public space","Outside, urban or manmade","Outside, rural or natural","Reverberation","Echo","Noise","Environmental noise","Static","Mains hum","Distortion","Sidetone","Cacophony","White noise","Pink noise","Throbbing","Vibration","Television","Radio","Field recording"],"description":"AudioSet audio class labels (527 classes)","title":"AudioClass"},"search:AudioSoundSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"audio_class":{"$ref":"#/components/schemas/search:AudioClass","description":"The audio class to search for"},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"}},"required":["dataset_id","audio_class"],"description":"Audio sound search request","title":"AudioSoundSearchRequest"},"search:AudioChunk":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid","description":"The coactive image id of the keyframe closest to the audio chunk"},"video":{"$ref":"#/components/schemas/search:Video","description":"The video that this audio chunk belongs to"},"start_time_ms":{"type":"integer","description":"The start time in milliseconds of the beginning of the audio chunk"},"end_time_ms":{"type":"integer","description":"The end time in milliseconds of the end of the audio chunk"},"score":{"type":"number","format":"double","description":"Confidence score of this audio chunk for the audio class"},"timestamp":{"type":["integer","null"],"description":"The timestamp in milliseconds of the keyframe in the video"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the video"}},"required":["coactive_image_id","video","start_time_ms","end_time_ms","score"],"description":"A single audio chunk result","title":"AudioChunk"},"search:AudioSoundSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:AudioChunk"},"description":"List of audio chunks"}},"required":["data"],"description":"Audio sound search response","title":"AudioSoundSearchResponse"},"search:CelebrityMatchesRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"upload_ids":{"type":"array","items":{"type":"string"},"description":"List of upload IDs to search for celebrity matches (15-100 items)"}},"required":["dataset_id","upload_ids"],"description":"Celebrity matches request - searches for celebrity matches using a list of upload IDs","title":"CelebrityMatchesRequest"},"search:NileKeyframe":{"type":"object","properties":{"keyframe_id":{"type":"string","format":"uuid"},"score":{"type":"number","format":"double"},"asset_type":{"type":"string"},"dataset_id":{"type":"string","format":"uuid"},"video_id":{"type":"string","format":"uuid"},"composite_slice_id":{"type":["string","null"],"format":"uuid"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["keyframe_id","score","asset_type","dataset_id","video_id"],"description":"Unit keyframe response from nile","title":"NileKeyframe"},"search:NileSearchKeyframeResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:NileKeyframe"}}},"required":["data"],"description":"A keyframe asset response from Nile for text to keyframe search","title":"NileSearchKeyframeResponse"},"search:HybridSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"text_query":{"type":"string","description":"The text query to search for"},"negative_text":{"type":["string","null"],"description":"Optional text describing what to exclude from search results. Steers the visual query embedding away from this direction."},"limit":{"type":"integer","minimum":1,"maximum":200,"default":100,"description":"Max number of items to return from hybrid search"},"datetime_filter":{"oneOf":[{"$ref":"#/components/schemas/search:DateTimeRangeInclusiveClause"},{"type":"null"}],"description":"Filter results to only include items with timestamps within this datetime range"},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."}},"required":["dataset_id","text_query"],"description":"Hybrid search request","title":"HybridSearchRequest"},"search:HybridSearchImage":{"type":"object","properties":{"created_user_id":{"type":"string","description":"The user that created the resource"},"created_dt":{"type":"string","format":"date-time","description":"The created datetime of the resource"},"updated_user_id":{"type":"string","description":"The user that last updated the resource"},"updated_dt":{"type":"string","format":"date-time","description":"The datetime the resource was last updated"},"coactive_image_id":{"type":"string","format":"uuid","description":"The coactive image id"},"path":{"type":["string","null"],"description":"The original path of the image"},"metadata":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"The user provided metadata for the image"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the image"},"relevance_score":{"type":"number","format":"double","description":"The relevance score of the image"}},"required":["created_user_id","created_dt","updated_user_id","updated_dt","coactive_image_id","relevance_score"],"description":"An image asset response","title":"HybridSearchImage"},"search:HybridSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:HybridSearchImage"},"description":"The results from hybrid search"}},"required":["data"],"description":"Base search response","title":"HybridSearchResponse"},"search:AssetType":{"type":"string","enum":["image","video"],"title":"AssetType"},"search:ImageSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"coactive_image_id":{"type":["string","null"],"format":"uuid","description":"The image to search for represented with a CID"},"public_url":{"type":["string","null"],"description":"The image to search for represented with a public http url"},"upload_id":{"type":["string","null"],"description":"The upload ID to search for"},"asset_type":{"oneOf":[{"$ref":"#/components/schemas/search:AssetType"},{"type":"null"}],"description":"The asset type to filter results by. If no asset type is selected the endpoint will search over images and videos"},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"}},"required":["dataset_id"],"description":"Image search request. Either CID or public_url must be provided.","title":"ImageSearchRequest"},"search:Shot":{"type":"object","properties":{"shot_id":{"type":"string","format":"uuid","description":"The unique shot id"},"start_time_ms":{"type":"integer","description":"The start time in milliseconds from the beginning of the video"},"end_time_ms":{"type":"integer","description":"The end time in milliseconds from the beginning of the video"}},"required":["shot_id","start_time_ms","end_time_ms"],"description":"Metadata about a video shot","title":"Shot"},"search:app__api__routes__search__v1__schema__schema__Keyframe":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid","description":"The coactive image id"},"video":{"$ref":"#/components/schemas/search:Video","description":"The video the keyframe belongs to"},"shot":{"$ref":"#/components/schemas/search:Shot","description":"The video shot metadata"},"audio_segment":{"oneOf":[{"$ref":"#/components/schemas/search:AudioSegment"},{"type":"null"}],"description":"Audio segment associated with the keyframe (if the asset_type is 'keyframe')"},"timestamp":{"type":["integer","null"],"description":"The timestamp of the keyframe in the video in milliseconds"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the image"},"keyframe_is_v1":{"type":"boolean","default":false,"description":"Whether the keyframe is from the v1 video data model"}},"required":["coactive_image_id","video","shot"],"description":"A keyframe asset response","title":"app__api__routes__search__v1__schema__schema__Keyframe"},"search:AppApiRoutesSearchV1SchemaSchemaSearchResponseDataItems":{"oneOf":[{"$ref":"#/components/schemas/search:Image"},{"$ref":"#/components/schemas/search:app__api__routes__search__v1__schema__schema__Keyframe"}],"title":"AppApiRoutesSearchV1SchemaSchemaSearchResponseDataItems"},"search:app__api__routes__search__v1__schema__schema__SearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:AppApiRoutesSearchV1SchemaSchemaSearchResponseDataItems"},"description":"The paginated results"}},"required":["data"],"description":"Base search response","title":"app__api__routes__search__v1__schema__schema__SearchResponse"},"search:ImageToKeyframeSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"coactive_image_id":{"type":["string","null"],"format":"uuid"},"public_url":{"type":["string","null"]},"upload_id":{"type":["string","null"]},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"}},"required":["dataset_id"],"description":"Image to keyframe search request","title":"ImageToKeyframeSearchRequest"},"search:VisualAssetType":{"type":"string","enum":["image","keyframe"],"title":"VisualAssetType"},"search:TextSearchByPersonRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"text_query":{"type":"string","description":"The text query to search for"},"negative_text":{"type":["string","null"],"description":"Optional text describing what to exclude from search results. Steers the query embedding away from this direction."},"person_ids":{"type":["array","null"],"items":{"type":"string","format":"uuid"},"description":"List of person IDs to filter results by. Currently only a single person_id is supported."},"person_names_or_aliases":{"type":["array","null"],"items":{"type":"string"},"description":"List of person names/aliases to filter results by. Currently only a single person name is supported."},"asset_type":{"$ref":"#/components/schemas/search:VisualAssetType","description":"Visual asset type to search over. For datasets using the native video data model, only 'keyframe' is supported."},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"}},"required":["dataset_id","text_query","asset_type"],"description":"Text search filtered by person request","title":"TextSearchByPersonRequest"},"search:CompositeType":{"type":"string","enum":["shot","scene","segment"],"description":"Type of composite for video keyframes","title":"CompositeType"},"search:ImageResult":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid","description":"The unique identifier of the image/keyframe"},"asset_type":{"$ref":"#/components/schemas/search:VisualAssetType","description":"The type of asset ('image' or 'keyframe')"},"dataset_id":{"type":"string","format":"uuid","description":"The dataset identifier this asset belongs to"},"video_id":{"type":["string","null"],"format":"uuid","description":"The video identifier (for video keyframes only)"},"composite_slice_id":{"type":["string","null"],"format":"uuid","description":"The composite slice identifier (for video keyframes only)"},"composite_type":{"oneOf":[{"$ref":"#/components/schemas/search:CompositeType"},{"type":"null"}],"description":"The type of composite (for video keyframes only)"},"composite_start_time_ms":{"type":["integer","null"],"description":"The start time of the composite slice in milliseconds (for video keyframes only)"},"composite_end_time_ms":{"type":["integer","null"],"description":"The end time of the composite slice in milliseconds (for video keyframes only)"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the asset (if applicable)"}},"required":["coactive_image_id","asset_type","dataset_id"],"description":"Unified search result for person-filtered text-to-image search","title":"ImageResult"},"search:TextSearchByPersonVideoResult":{"type":"object","properties":{"video_id":{"type":"string","format":"uuid","description":"The unique identifier of the video"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the video"}},"required":["video_id"],"description":"Video result with grouped keyframes for person-filtered text-to-image search","title":"TextSearchByPersonVideoResult"},"search:TextSearchByPersonResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:ImageResult"},"description":"The search results matching the person filter"},"videos":{"type":"array","items":{"$ref":"#/components/schemas/search:TextSearchByPersonVideoResult"},"description":"Search results aggregated by video, ordered by best matching keyframe score"}},"required":["data"],"description":"Response for person-filtered text-to-image search","title":"TextSearchByPersonResponse"},"search:TextSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"text_query":{"type":"string","description":"The text query to search for"},"negative_text":{"type":["string","null"],"description":"Optional text describing what to exclude from search results. Steers the query embedding away from this direction."},"asset_type":{"oneOf":[{"$ref":"#/components/schemas/search:AssetType"},{"type":"null"}],"description":"The asset type to filter results by. If no asset type is selected the endpoint will search over images and videos"},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"}},"required":["dataset_id","text_query"],"description":"Text search request","title":"TextSearchRequest"},"search:TranscriptMatchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"offset":{"type":"integer","minimum":0,"maximum":9223372036854776000,"default":0,"description":"Starting index to return"},"limit":{"type":"integer","minimum":1,"maximum":1000,"default":100,"description":"Max number of items to return"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search:MetadataFilters"},{"type":"null"}],"description":"List of metadata filters to apply to the search"},"moderation_score_type":{"$ref":"#/components/schemas/search:ScoreType","description":"Type of moderation scores to return when moderation is enabled.probability returns scores 0-1 using BGE Reranker model.level returns scores 0-5 using OpenAI model.This does not enable/disable moderation - use skip_moderation for that."},"text_query":{"type":"string","description":"The text query to search for"},"composite_type":{"type":["string","null"],"default":"shot","description":"The composite type to query on."}},"required":["dataset_id","text_query"],"description":"Transcript Match Request","title":"TranscriptMatchRequest"},"search:VideoTranscriptMatch":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid","description":"The coactive image id of the keyframe closest to the transcript match"},"video":{"$ref":"#/components/schemas/search:Video","description":"The video that this transcript match belongs to"},"audio_segment":{"$ref":"#/components/schemas/search:AudioSegment","description":"The audio segment associated with this transcript match"},"coverage_score":{"type":["number","null"],"format":"double","description":"Coverage score for this transcript match. i.e How much of composite transcript is covered by the query text"},"timestamp":{"type":["integer","null"],"description":"The timestamp in milliseconds of the keyframe in the video"},"moderation_score":{"type":["number","null"],"format":"double","description":"The moderation score of the video"}},"required":["coactive_image_id","video","audio_segment"],"description":"A single transcript match result with keyframe and slice information","title":"VideoTranscriptMatch"},"search:TranscriptTextMatchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/search:VideoTranscriptMatch"},"description":"List of individual transcript matches with their corresponding keyframes"}},"required":["data"],"description":"Native video model search response for exact transcript text match","title":"TranscriptTextMatchResponse"},"search-metadata-filter:MetadataFilterOperator":{"type":"string","enum":["=","!=","contains",">","<",">=","<="],"description":"Comparison operator applied between a metadata field value and the filter `value`.","title":"MetadataFilterOperator"},"search-metadata-filter:MetadataFilter":{"type":"object","properties":{"key":{"type":"string","description":"Name of the metadata field to filter on (must exist on the dataset's assets)."},"value":{"type":"string","description":"Value to compare the metadata field against. Always provided as a string; numerical operators (>, <, >=, <=) parse it as a number."},"op":{"$ref":"#/components/schemas/search-metadata-filter:MetadataFilterOperator","description":"Comparison operator. Defaults to `=` (equality)."}},"required":["key","value"],"description":"A single filter applied against an asset metadata field before scoring.","title":"MetadataFilter"},"search-metadata-filter:AudioClass":{"type":"string","enum":["Speech","Male speech, man speaking","Female speech, woman speaking","Child speech, kid speaking","Conversation","Narration, monologue","Babbling","Speech synthesizer","Shout","Bellow","Whoop","Yell","Battle cry","Children shouting","Screaming","Whispering","Laughter","Baby laughter","Giggle","Snicker","Belly laugh","Chuckle, chortle","Crying, sobbing","Baby cry, infant cry","Whimper","Wail, moan","Sigh","Singing","Choir","Yodeling","Chant","Mantra","Male singing","Female singing","Child singing","Synthetic singing","Rapping","Humming","Groan","Grunt","Whistling","Breathing","Wheeze","Snoring","Gasp","Pant","Snort","Cough","Throat clearing","Sneeze","Sniff","Run","Shuffle","Walk, footsteps","Chewing, mastication","Biting","Gargling","Stomach rumble","Burping, eructation","Hiccup","Fart","Hands","Finger snapping","Clapping","Heart sounds, heartbeat","Heart murmur","Cheering","Applause","Chatter","Crowd","Hubbub, speech noise, speech babble","Children playing","Animal","Domestic animals, pets","Dog","Bark","Yip","Howl","Bow-wow","Growling","Whimper (dog)","Cat","Purr","Meow","Hiss","Caterwaul","Livestock, farm animals, working animals","Horse","Clip-clop","Neigh, whinny","Cattle, bovinae","Moo","Cowbell","Pig","Oink","Goat","Bleat","Sheep","Fowl","Chicken, rooster","Cluck","Crowing, cock-a-doodle-doo","Turkey","Gobble","Duck","Quack","Goose","Honk","Wild animals","Roaring cats (lions, tigers)","Roar","Bird","Bird vocalization, bird call, bird song","Chirp, tweet","Squawk","Pigeon, dove","Coo","Crow","Caw","Owl","Hoot","Bird flight, flapping wings","Canidae, dogs, wolves","Rodents, rats, mice","Mouse","Patter","Insect","Cricket","Mosquito","Fly, housefly","Buzz","Bee, wasp, etc.","Frog","Croak","Snake","Rattle","Whale vocalization","Music","Musical instrument","Plucked string instrument","Guitar","Electric guitar","Bass guitar","Acoustic guitar","Steel guitar, slide guitar","Tapping (guitar technique)","Strum","Banjo","Sitar","Mandolin","Zither","Ukulele","Keyboard (musical)","Piano","Electric piano","Organ","Electronic organ","Hammond organ","Synthesizer","Sampler","Harpsichord","Percussion","Drum kit","Drum machine","Drum","Snare drum","Rimshot","Drum roll","Bass drum","Timpani","Tabla","Cymbal","Hi-hat","Wood block","Tambourine","Rattle (instrument)","Maraca","Gong","Tubular bells","Mallet percussion","Marimba, xylophone","Glockenspiel","Vibraphone","Steelpan","Orchestra","Brass instrument","French horn","Trumpet","Trombone","Bowed string instrument","String section","Violin, fiddle","Pizzicato","Cello","Double bass","Wind instrument, woodwind instrument","Flute","Saxophone","Clarinet","Harp","Bell","Church bell","Jingle bell","Bicycle bell","Tuning fork","Chime","Wind chime","Change ringing (campanology)","Harmonica","Accordion","Bagpipes","Didgeridoo","Shofar","Theremin","Singing bowl","Scratching (performance technique)","Pop music","Hip hop music","Beatboxing","Rock music","Heavy metal","Punk rock","Grunge","Progressive rock","Rock and roll","Psychedelic rock","Rhythm and blues","Soul music","Reggae","Country","Swing music","Bluegrass","Funk","Folk music","Middle Eastern music","Jazz","Disco","Classical music","Opera","Electronic music","House music","Techno","Dubstep","Drum and bass","Electronica","Electronic dance music","Ambient music","Trance music","Music of Latin America","Salsa music","Flamenco","Blues","Music for children","New-age music","Vocal music","A capella","Music of Africa","Afrobeat","Christian music","Gospel music","Music of Asia","Carnatic music","Music of Bollywood","Ska","Traditional music","Independent music","Song","Background music","Theme music","Jingle (music)","Soundtrack music","Lullaby","Video game music","Christmas music","Dance music","Wedding music","Happy music","Funny music","Sad music","Tender music","Exciting music","Angry music","Scary music","Wind","Rustling leaves","Wind noise (microphone)","Thunderstorm","Thunder","Water","Rain","Raindrop","Rain on surface","Stream","Waterfall","Ocean","Waves, surf","Steam","Gurgling","Fire","Crackle","Vehicle","Boat, Water vehicle","Sailboat, sailing ship","Rowboat, canoe, kayak","Motorboat, speedboat","Ship","Motor vehicle (road)","Car","Vehicle horn, car horn, honking","Toot","Car alarm","Power windows, electric windows","Skidding","Tire squeal","Car passing by","Race car, auto racing","Truck","Air brake","Air horn, truck horn","Reversing beeps","Ice cream truck, ice cream van","Bus","Emergency vehicle","Police car (siren)","Ambulance (siren)","Fire engine, fire truck (siren)","Motorcycle","Traffic noise, roadway noise","Rail transport","Train","Train whistle","Train horn","Railroad car, train wagon","Train wheels squealing","Subway, metro, underground","Aircraft","Aircraft engine","Jet engine","Propeller, airscrew","Helicopter","Fixed-wing aircraft, airplane","Bicycle","Skateboard","Engine","Light engine (high frequency)","Dental drill, dentist's drill","Lawn mower","Chainsaw","Medium engine (mid frequency)","Heavy engine (low frequency)","Engine knocking","Engine starting","Idling","Accelerating, revving, vroom","Door","Doorbell","Ding-dong","Sliding door","Slam","Knock","Tap","Squeak","Cupboard open or close","Drawer open or close","Dishes, pots, and pans","Cutlery, silverware","Chopping (food)","Frying (food)","Microwave oven","Blender","Water tap, faucet","Sink (filling or washing)","Bathtub (filling or washing)","Hair dryer","Toilet flush","Toothbrush","Electric toothbrush","Vacuum cleaner","Zipper (clothing)","Keys jangling","Coin (dropping)","Scissors","Electric shaver, electric razor","Shuffling cards","Typing","Typewriter","Computer keyboard","Writing","Alarm","Telephone","Telephone bell ringing","Ringtone","Telephone dialing, DTMF","Dial tone","Busy signal","Alarm clock","Siren","Civil defense siren","Buzzer","Smoke detector, smoke alarm","Fire alarm","Foghorn","Whistle","Steam whistle","Mechanisms","Ratchet, pawl","Clock","Tick","Tick-tock","Gears","Pulleys","Sewing machine","Mechanical fan","Air conditioning","Cash register","Printer","Camera","Single-lens reflex camera","Tools","Hammer","Jackhammer","Sawing","Filing (rasp)","Sanding","Power tool","Drill","Explosion","Gunshot, gunfire","Machine gun","Fusillade","Artillery fire","Cap gun","Fireworks","Firecracker","Burst, pop","Eruption","Boom","Wood","Chop","Splinter","Crack","Glass","Chink, clink","Shatter","Liquid","Splash, splatter","Slosh","Squish","Drip","Pour","Trickle, dribble","Gush","Fill (with liquid)","Spray","Pump (liquid)","Stir","Boiling","Sonar","Arrow","Whoosh, swoosh, swish","Thump, thud","Thunk","Electronic tuner","Effects unit","Chorus effect","Basketball bounce","Bang","Slap, smack","Whack, thwack","Smash, crash","Breaking","Bouncing","Whip","Flap","Scratch","Scrape","Rub","Roll","Crushing","Crumpling, crinkling","Tearing","Beep, bleep","Ping","Ding","Clang","Squeal","Creak","Rustle","Whir","Clatter","Sizzle","Clicking","Clickety-clack","Rumble","Plop","Jingle, tinkle","Hum","Zing","Boing","Crunch","Silence","Sine wave","Harmonic","Chirp tone","Sound effect","Pulse","Inside, small room","Inside, large room or hall","Inside, public space","Outside, urban or manmade","Outside, rural or natural","Reverberation","Echo","Noise","Environmental noise","Static","Mains hum","Distortion","Sidetone","Cacophony","White noise","Pink noise","Throbbing","Vibration","Television","Radio","Field recording"],"description":"AudioSet audio class labels (527 classes)","title":"AudioClass"},"search-metadata-filter:MetadataSoundSearchRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":40,"description":"Max number of results to return"},"offset":{"type":"integer","minimum":0,"default":0,"description":"Number of results to skip before returning"},"metadata_filters":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:MetadataFilter"},"description":"List of filter objects applied against asset metadata fields before scoring. All filters are combined with AND."},"skip_moderation":{"type":"boolean","default":false,"description":"When true, moderation scoring is skipped and moderation_score will be null on all results."},"dataset_id":{"type":"string","format":"uuid","description":"Dataset to search within"},"audio_class":{"$ref":"#/components/schemas/search-metadata-filter:AudioClass","description":"AudioSet sound class label to search for (e.g. AudioClass.DOG, AudioClass.MUSIC)"}},"required":["dataset_id","audio_class"],"description":"Body for audio sound-class metadata-filter search.","title":"MetadataSoundSearchRequest"},"search-metadata-filter:MetadataSearchTriggerResponse":{"type":"object","properties":{"run_id":{"type":"integer","description":"Databricks job run ID to use for status polling and result retrieval"}},"required":["run_id"],"description":"Returned immediately after triggering a Databricks job run.","title":"MetadataSearchTriggerResponse"},"search-metadata-filter:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"search-metadata-filter:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"search-metadata-filter:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:ValidationError"}}},"title":"HTTPValidationError"},"search-metadata-filter:VideoCompositeSlice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"composite_id":{"type":"string","format":"uuid"},"composite_type":{"type":"string"},"index":{"type":"integer"},"start_time_ms":{"type":"integer"},"end_time_ms":{"type":"integer"},"start_frame_num":{"type":"integer"},"end_frame_num":{"type":"integer"}},"required":["id","composite_id","composite_type","index","start_time_ms","end_time_ms","start_frame_num","end_frame_num"],"title":"VideoCompositeSlice"},"search-metadata-filter:VideoKeyframe":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"frame_time_ms":{"type":"integer"}},"required":["id","frame_time_ms"],"title":"VideoKeyframe"},"search-metadata-filter:VideoSearchResult":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"video_id":{"type":"string","format":"uuid"},"source_path":{"type":"string"},"video_score":{"type":"number","format":"double"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"}},"top_composite_slice":{"$ref":"#/components/schemas/search-metadata-filter:VideoCompositeSlice"},"top_keyframe":{"$ref":"#/components/schemas/search-metadata-filter:VideoKeyframe"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["dataset_id","video_id","source_path","video_score","metadata","top_composite_slice","top_keyframe"],"title":"VideoSearchResult"},"search-metadata-filter:VideoMetadataSearchResponse":{"type":"object","properties":{"status":{"type":"string"},"search_target":{"type":"string","enum":["video"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:VideoSearchResult"}}},"required":["status"],"title":"VideoMetadataSearchResponse"},"search-metadata-filter:ShotSearchResult":{"type":"object","properties":{"composite_slice_id":{"type":"string","format":"uuid"},"video_id":{"type":"string","format":"uuid"},"video_metadata":{"type":"object","additionalProperties":{"description":"Any type"}},"slice_start_time_ms":{"type":"integer"},"slice_end_time_ms":{"type":"integer"},"max_cosine_sim":{"type":"number","format":"double"},"keyframe_count":{"type":"integer"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["composite_slice_id","video_id","video_metadata","slice_start_time_ms","slice_end_time_ms","max_cosine_sim","keyframe_count"],"title":"ShotSearchResult"},"search-metadata-filter:ShotMetadataSearchResponse":{"type":"object","properties":{"status":{"type":"string"},"search_target":{"type":"string","enum":["shot"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:ShotSearchResult"}}},"required":["status"],"title":"ShotMetadataSearchResponse"},"search-metadata-filter:Video":{"type":"object","properties":{"coactive_video_id":{"type":"string","format":"uuid"},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"}}},"required":["coactive_video_id","path","metadata"],"title":"Video"},"search-metadata-filter:AudioSegment":{"type":"object","properties":{"start_time_ms":{"type":"integer"},"end_time_ms":{"type":"integer"},"speech_to_text_transcription":{"type":"string"}},"required":["start_time_ms","end_time_ms","speech_to_text_transcription"],"title":"AudioSegment"},"search-metadata-filter:TranscriptSearchResult":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"video":{"$ref":"#/components/schemas/search-metadata-filter:Video"},"audio_segment":{"$ref":"#/components/schemas/search-metadata-filter:AudioSegment"},"timestamp":{"type":"integer"},"score":{"type":["number","null"],"format":"double"},"coverage_score":{"type":["number","null"],"format":"double"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["coactive_image_id","video","audio_segment","timestamp"],"title":"TranscriptSearchResult"},"search-metadata-filter:TranscriptMetadataSearchResponse":{"type":"object","properties":{"status":{"type":"string"},"search_target":{"type":"string","enum":["transcript"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:TranscriptSearchResult"}}},"required":["status"],"title":"TranscriptMetadataSearchResponse"},"search-metadata-filter:ImageSearchResult":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"path":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"description":"Any type"}},"relevance_score":{"type":"number","format":"double"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["coactive_image_id","path","metadata","relevance_score"],"title":"ImageSearchResult"},"search-metadata-filter:ImageMetadataSearchResponse":{"type":"object","properties":{"status":{"type":"string"},"search_target":{"type":"string","enum":["image"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:ImageSearchResult"}}},"required":["status"],"title":"ImageMetadataSearchResponse"},"search-metadata-filter:KeyframeSearchResult":{"type":"object","properties":{"keyframe_id":{"type":"string","format":"uuid"},"video_id":{"type":"string","format":"uuid"},"video_metadata":{"type":"object","additionalProperties":{"description":"Any type"}},"frame_time_ms":{"type":"integer"},"composite_slice_id":{"type":"string","format":"uuid"},"slice_start_time_ms":{"type":"integer"},"slice_end_time_ms":{"type":"integer"},"cosine_sim":{"type":"number","format":"double"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["keyframe_id","video_id","video_metadata","frame_time_ms","composite_slice_id","slice_start_time_ms","slice_end_time_ms","cosine_sim"],"title":"KeyframeSearchResult"},"search-metadata-filter:KeyframeMetadataSearchResponse":{"type":"object","properties":{"status":{"type":"string"},"search_target":{"type":"string","enum":["keyframe"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:KeyframeSearchResult"}}},"required":["status"],"title":"KeyframeMetadataSearchResponse"},"search-metadata-filter:SoundSearchResult":{"type":"object","properties":{"coactive_image_id":{"type":"string","format":"uuid"},"video":{"$ref":"#/components/schemas/search-metadata-filter:Video"},"start_time_ms":{"type":"integer"},"end_time_ms":{"type":"integer"},"score":{"type":["number","null"],"format":"double"},"timestamp":{"type":"integer"},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["coactive_image_id","video","start_time_ms","end_time_ms","timestamp"],"title":"SoundSearchResult"},"search-metadata-filter:SoundMetadataSearchResponse":{"type":"object","properties":{"status":{"type":"string"},"search_target":{"type":"string","enum":["sound"]},"results":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:SoundSearchResult"}}},"required":["status"],"title":"SoundMetadataSearchResponse"},"search-metadata-filter:get_metadata_filter_search_result_Response_200":{"oneOf":[{"$ref":"#/components/schemas/search-metadata-filter:VideoMetadataSearchResponse"},{"$ref":"#/components/schemas/search-metadata-filter:ShotMetadataSearchResponse"},{"$ref":"#/components/schemas/search-metadata-filter:TranscriptMetadataSearchResponse"},{"$ref":"#/components/schemas/search-metadata-filter:ImageMetadataSearchResponse"},{"$ref":"#/components/schemas/search-metadata-filter:KeyframeMetadataSearchResponse"},{"$ref":"#/components/schemas/search-metadata-filter:SoundMetadataSearchResponse"}],"title":"get_metadata_filter_search_result_Response_200"},"search-metadata-filter:DatabricksLifeCycleState":{"type":"string","enum":["BLOCKED","PENDING","QUEUED","RUNNING","TERMINATING","TERMINATED","WAITING"],"description":"Databricks job run lifecycle states returned in status.state from the runs/get API.\n\nThese are the standard values as documented at:\nhttps://docs.databricks.com/api/workspace/jobs/getrun (see RunStatus > state)\n\nIf Databricks adds or changes values, _parse_lifecycle_state in job.py handles unknown\nvalues gracefully by falling back to PENDING and emitting a warning log.","title":"DatabricksLifeCycleState"},"search-metadata-filter:DatabricksTerminationType":{"type":"string","enum":["SUCCESS","INTERNAL_ERROR","CLIENT_ERROR","CLOUD_FAILURE"],"description":"Why a Databricks run terminated, returned in status.termination_details.type.\n\nThese are the standard values as documented at:\nhttps://docs.databricks.com/api/workspace/jobs/getrun (see TerminationDetails > type)\n\nIf Databricks adds or changes values, _parse_termination_type in job.py handles unknown\nvalues gracefully by returning None and emitting a warning log.","title":"DatabricksTerminationType"},"search-metadata-filter:MetadataSearchStatusResponse":{"type":"object","properties":{"run_id":{"type":"integer"},"state":{"$ref":"#/components/schemas/search-metadata-filter:DatabricksLifeCycleState","description":"Current lifecycle state of the run"},"termination_type":{"oneOf":[{"$ref":"#/components/schemas/search-metadata-filter:DatabricksTerminationType"},{"type":"null"}],"description":"Termination type, populated when run is complete"},"termination_message":{"type":["string","null"],"description":"Human-readable termination message from Databricks"}},"required":["run_id","state"],"description":"Current status of a Databricks job run.","title":"MetadataSearchStatusResponse"},"search-metadata-filter:MetadataSearchRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":40,"description":"Max number of results to return"},"offset":{"type":"integer","minimum":0,"default":0,"description":"Number of results to skip before returning"},"metadata_filters":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:MetadataFilter"},"description":"List of filter objects applied against asset metadata fields before scoring. All filters are combined with AND."},"skip_moderation":{"type":"boolean","default":false,"description":"When true, moderation scoring is skipped and moderation_score will be null on all results."},"dataset_id":{"type":"string","format":"uuid","description":"Dataset to search within"},"text_query":{"type":"string","minLength":2,"description":"Natural language query encoded into an embedding to score visual content via vector similarity."}},"required":["dataset_id","text_query"],"description":"Body for POST /search/metadata.","title":"MetadataSearchRequest"},"search-metadata-filter:TranscriptMatchMode":{"type":"string","enum":["semantic","exact"],"description":"Transcript search: vector/semantic vs lexical/exact (exact skips query embedding).","title":"TranscriptMatchMode"},"search-metadata-filter:MetadataTranscriptSearchRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":100,"default":40,"description":"Max number of results to return"},"offset":{"type":"integer","minimum":0,"default":0,"description":"Number of results to skip before returning"},"metadata_filters":{"type":"array","items":{"$ref":"#/components/schemas/search-metadata-filter:MetadataFilter"},"description":"List of filter objects applied against asset metadata fields before scoring. All filters are combined with AND."},"skip_moderation":{"type":"boolean","default":false,"description":"When true, moderation scoring is skipped and moderation_score will be null on all results."},"dataset_id":{"type":"string","format":"uuid","description":"Dataset to search within"},"text_query":{"type":"string","minLength":2,"description":"Query text matched against transcripts. In semantic mode it is encoded into an embedding and ranked via vector similarity; in exact mode it is matched lexically without embedding."},"match_mode":{"$ref":"#/components/schemas/search-metadata-filter:TranscriptMatchMode","description":"semantic: encode query with the dataset audio/transcript encoder; exact: pass text to the job without embedding for literal phrase matching."}},"required":["dataset_id","text_query"],"description":"Body for transcript metadata-filter search.","title":"MetadataTranscriptSearchRequest"},"search-video:VideoCompositeSliceDrillDown":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"index":{"type":["integer","null"]},"start_frame_num":{"type":["integer","null"]},"end_frame_num":{"type":["integer","null"]},"start_time_ms":{"type":["integer","null"]},"end_time_ms":{"type":["integer","null"]},"composite_id":{"type":["string","null"],"format":"uuid"},"composite_type":{"type":"string","default":"shot","description":"Type of composite"},"composite_slice_score":{"type":["number","null"],"format":"double"}},"required":["id"],"title":"VideoCompositeSliceDrillDown"},"search-video:VideoCompositeDrillDownResponse":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"text_query":{"type":"string"},"video_id":{"type":"string"},"composite_type":{"type":"string"},"source_path":{"type":"string"},"slices":{"type":"array","items":{"$ref":"#/components/schemas/search-video:VideoCompositeSliceDrillDown"}}},"required":["dataset_id","text_query","video_id","composite_type","source_path","slices"],"title":"VideoCompositeDrillDownResponse"},"search-video:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"search-video:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/search-video:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"search-video:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/search-video:ValidationError"}}},"title":"HTTPValidationError"},"search-video:BooleanEqualsClause":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["=="]},"value":{"type":"boolean"}},"required":["key","operator","value"],"title":"BooleanEqualsClause"},"search-video:EqualsClause":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["=="]},"value":{"type":"string"}},"required":["key","operator","value"],"title":"EqualsClause"},"search-video:NotEqualsClause":{"type":"object","properties":{"key":{"type":"string"},"operator":{"type":"string","enum":["!="]},"value":{"type":"string"}},"required":["key","operator","value"],"title":"NotEqualsClause"},"search-video:DateTimeRangeInclusiveClause":{"type":"object","properties":{"key":{"type":"string"},"start_utc_epoch":{"type":"number","format":"double"},"end_utc_epoch":{"type":"number","format":"double"},"operator":{"type":"string","enum":["DateTimeRangeInclusive"]}},"required":["key","start_utc_epoch","end_utc_epoch","operator"],"title":"DateTimeRangeInclusiveClause"},"search-video:MetadataFiltersFiltersItems":{"oneOf":[{"$ref":"#/components/schemas/search-video:BooleanEqualsClause"},{"$ref":"#/components/schemas/search-video:EqualsClause"},{"$ref":"#/components/schemas/search-video:NotEqualsClause"},{"$ref":"#/components/schemas/search-video:DateTimeRangeInclusiveClause"}],"title":"MetadataFiltersFiltersItems"},"search-video:MetadataFilters":{"type":"object","properties":{"filters":{"type":"array","items":{"$ref":"#/components/schemas/search-video:MetadataFiltersFiltersItems"}}},"required":["filters"],"description":"Metadata filters for video search.","title":"MetadataFilters"},"search-video:ModalityEnum":{"type":"string","enum":["video","shot","image","audio_speech_to_text","capped-shot-segment"],"title":"ModalityEnum"},"search-video:ScoreType":{"type":"string","enum":["probability","level"],"description":"Score type returned by the moderation service.\n- PROBABILITY: Scores in range 0-1 (uses BGE Reranker model)\n- LEVEL: Scores in range 0-5 (uses OpenAI model)","title":"ScoreType"},"search-video:VideoSearchRequest":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid","description":"The unique identifier for the dataset"},"text_query":{"type":"string","minLength":2,"description":"The natural language search string"},"metadata_filters":{"oneOf":[{"$ref":"#/components/schemas/search-video:MetadataFilters"},{"type":"null"}],"description":"JSON string containing a list of metadata filters"},"offset":{"type":"integer","default":0,"description":"Starting index to return (default 0)"},"limit":{"type":"integer","default":60,"description":"Max number of items to return(default 60, max 1000)"},"modality":{"oneOf":[{"$ref":"#/components/schemas/search-video:ModalityEnum"},{"type":"null"}],"description":"Modality of the video to search for ( video, shot, image ). Valid options: \"video\", \"shot\", \"image\", \"audio_speech_to_text\", \"capped-shot-segment\". Default is 'video'."},"skip_moderation":{"type":"boolean","default":false,"description":"Skip content moderation if enabled"},"moderation_score_type":{"$ref":"#/components/schemas/search-video:ScoreType","description":"Type of moderation scores to return when moderation is enabled"},"ignore_keyframes":{"type":"boolean","default":false,"description":"Whether to ignore keyframes"}},"required":["dataset_id","text_query"],"description":"Request schema for video search endpoint.","title":"VideoSearchRequest"},"search-video:VideoMetadata":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"description":"Any type"}}},"description":"Metadata associated with a video shot.","title":"VideoMetadata"},"search-video:VideoSearchResultMetadata":{"oneOf":[{"$ref":"#/components/schemas/search-video:VideoMetadata"},{"type":"object","additionalProperties":{"type":"string"}}],"title":"VideoSearchResultMetadata"},"search-video:VideoCompositeSlice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"index":{"type":["integer","null"]},"start_frame_num":{"type":["integer","null"]},"end_frame_num":{"type":["integer","null"]},"start_time_ms":{"type":["integer","null"]},"end_time_ms":{"type":["integer","null"]},"composite_id":{"type":["string","null"],"format":"uuid"},"composite_type":{"type":"string","default":"shot","description":"Type of composite"}},"required":["id"],"description":"Response schema for video composite details.","title":"VideoCompositeSlice"},"search-video:VideoKeyframe":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"frame_time_ms":{"type":["integer","null"]}},"required":["id"],"description":"Response schema for video keyframe details.","title":"VideoKeyframe"},"search-video:VideoSearchResult":{"type":"object","properties":{"dataset_id":{"type":"string","format":"uuid"},"text_query":{"type":"string"},"video_id":{"type":"string","format":"uuid"},"source_path":{"type":"string"},"video_score":{"type":["number","null"],"format":"double"},"metadata":{"oneOf":[{"$ref":"#/components/schemas/search-video:VideoSearchResultMetadata"},{"type":"null"}]},"top_composite_slice":{"oneOf":[{"$ref":"#/components/schemas/search-video:VideoCompositeSlice"},{"type":"null"}]},"top_keyframe":{"oneOf":[{"$ref":"#/components/schemas/search-video:VideoKeyframe"},{"type":"null"}]},"moderation_score":{"type":["number","null"],"format":"double"}},"required":["dataset_id","text_query","video_id","source_path"],"description":"Single result in the video search response.","title":"VideoSearchResult"},"search-video:VideoSearchResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/search-video:VideoSearchResult"},"description":"List of video search results"}},"required":["results"],"description":"Response schema for video search endpoint.","title":"VideoSearchResponse"},"Role":{"type":"object","properties":{"role_id":{"type":"string","description":"Name of the role (e.g., 'admin', 'editor', 'viewer')"},"resource":{"type":["string","null"],"description":"Optional resource type the role applies to (e.g., 'dataset')"},"resource_instance":{"type":["string","null"],"description":"Optional resource instance ID the role applies to"}},"required":["role_id"],"description":"Role model for user and client roles","title":"Role"},"CreateClientRequest":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the system-level credentials"},"roles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Role"},"description":"List of roles to assign to the system-level credentials. This is only available to organizations that are RBAC-enabled. Please contact support if you would like to enable RBAC for your organization."}},"required":["name"],"description":"Create system-level credentials request model","title":"CreateClientRequest"},"ClientResponse":{"type":"object","properties":{"client_id":{"type":"string","description":"OAuth client ID"},"client_secret":{"type":"string","description":"OAuth client secret (only returned on creation)"},"name":{"type":"string","description":"Display name for the OAuth client"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles assigned to the client"}},"required":["client_id","client_secret","name","roles"],"description":"System-level credentials","title":"ClientResponse"},"ValidationError1LocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationError1LocItems"},"ValidationError1":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError1LocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError1"},"HTTPValidationError1":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError1"}}},"title":"HTTPValidationError1"},"UpdateClientRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Display name for the system-level credentials"},"roles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Role"},"description":"List of roles to assign to the system-level credentials. This is only available to organizations that are RBAC-enabled. Please contact support if you would like to enable RBAC for your organization."},"roles_context":{"type":["string","null"],"description":"Context for the roles to update. This can either be 'system' for system-level roles or 'dataset:{dataset_id}' for dataset-level roles."}},"description":"Update system-level credentials request model","title":"UpdateClientRequest"},"CreateUserInvitationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the invited user"},"email":{"type":"string","description":"Email address to send the invitation to"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles to assign to the user"}},"required":["name","email"],"description":"Request model for creating a new user invitation.\n\nThis model is used to invite a new user to join an organization. The invitation\nwill be sent to the specified email address and will include the roles that will\nbe assigned to the user upon acceptance.","title":"CreateUserInvitationRequest"},"Inviter":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the inviter"}},"required":["name"],"description":"Model representing the user who sent the invitation.\n\nThis model contains the details of the user who sent the invitation, including\ntheir display name.","title":"Inviter"},"Invitee":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the invitee"},"name":{"type":"string","description":"Display name of the invitee"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles to assign to the invitee"}},"required":["email","name","roles"],"title":"Invitee"},"UserInvitation":{"type":"object","properties":{"invitation_id":{"type":"string","description":"Unique identifier for the invitation"},"inviter":{"$ref":"#/components/schemas/Inviter","description":"Details about the user who sent the invitation"},"invitee":{"$ref":"#/components/schemas/Invitee","description":"Details about the user being invited"},"invitation_url":{"type":"string","description":"URL for the user to accept the invitation"},"created_at":{"type":"string","description":"Timestamp when the invitation was created"},"expires_at":{"type":"string","description":"Timestamp when the invitation expires"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles that will be assigned upon acceptance"}},"required":["invitation_id","inviter","invitee","invitation_url","created_at","expires_at","roles"],"description":"Model representing a user invitation.\n\nThis model contains the details of an invitation sent to a user, including the\ninvitation ID, who sent it, who it was sent to, and the roles that will be\nassigned upon acceptance. The invitation URL is included for the user to accept\nthe invitation.","title":"UserInvitation"},"PagedPageDetails":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number (1-indexed)"},"last_page":{"type":["integer","null"],"description":"Last page number (if total is known)"},"limit":{"type":"integer","description":"Number of items per page"},"offset":{"type":"integer","description":"Offset of the first item in the current page"},"total":{"type":["integer","null"],"description":"Total number of items across all pages"}},"required":["current_page","limit","offset"],"description":"Pagination metadata","title":"PagedPageDetails"},"PagedLinks":{"type":"object","properties":{"prev":{"type":["string","null"],"description":"URL for the previous page"},"next":{"type":["string","null"],"description":"URL for the next page"},"first":{"type":["string","null"],"description":"URL for the first page"},"last":{"type":["string","null"],"description":"URL for the last page"}},"description":"Metadata for retrieving paginated data","title":"PagedLinks"},"SortDirection1":{"type":"string","enum":["asc","desc"],"description":"Possible sort orders","title":"SortDirection1"},"SortItem1":{"type":"object","properties":{"direction":{"$ref":"#/components/schemas/SortDirection1","description":"Sort direction (ascending or descending)"},"field":{"type":"string","description":"Field name to sort by"}},"required":["direction","field"],"description":"Metadata about the sort order of the response","title":"SortItem1"},"PagedMeta":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/PagedPageDetails","description":"Current page number (1-indexed)"},"links":{"$ref":"#/components/schemas/PagedLinks","description":"Links to the previous, next, first, and last pages"},"sort":{"type":"array","items":{"$ref":"#/components/schemas/SortItem1"},"description":"Sort order for the response"}},"required":["page","links","sort"],"description":"Metadata for paginated responses","title":"PagedMeta"},"UserInvitationListResponse":{"type":"object","properties":{"user_invitations":{"type":"array","items":{"$ref":"#/components/schemas/UserInvitation"},"description":"List of pending invitations"},"meta":{"$ref":"#/components/schemas/PagedMeta","description":"Pagination metadata for the response"}},"required":["user_invitations","meta"],"description":"Response model for listing user invitations.\n\nThis model contains a list of pending user invitations and metadata about the\npagination of the results. Each invitation includes details about who sent it,\nwho it was sent to, and the roles that will be assigned upon acceptance.","title":"UserInvitationListResponse"},"RoleDefinition":{"type":"object","properties":{"role_id":{"type":"string","description":"Unique identifier for the role"},"name":{"type":"string","description":"Display name of the role"},"description":{"type":["string","null"],"description":"Optional description of the role's purpose"},"resource":{"type":["string","null"],"description":"Optional resource type this role applies to"}},"required":["role_id","name"],"description":"Role definition model for available roles","title":"RoleDefinition"},"RolesListResponse":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/RoleDefinition"},"description":"List of roles"}},"required":["roles"],"description":"Response model for listing all available roles.","title":"RolesListResponse"},"PartialUserResponse":{"type":"object","properties":{"user_id":{"type":"string","description":"Unique identifier for the user"},"name":{"type":"string","description":"Display name of the user"},"email":{"type":["string","null"],"description":"Email address of the user"},"picture":{"type":["string","null"],"description":"URL to the user's profile picture"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the user was created"},"last_login":{"type":["string","null"],"format":"date-time","description":"Timestamp of the user's last login"},"roles":{"type":["array","null"],"items":{"$ref":"#/components/schemas/Role"},"description":"Optional list of roles assigned to the user"}},"required":["user_id","name","created_at"],"description":"Partial user response model with optional roles.\n\nThis model extends the base user response with optional roles. It is used\nwhen roles information may not be available or required in the response.","title":"PartialUserResponse"},"UsersListResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/PartialUserResponse"},"description":"List of users with partial information"},"meta":{"$ref":"#/components/schemas/PagedMeta","description":"Pagination metadata for the response"}},"required":["users","meta"],"description":"Response model for listing users with pagination.\n\nThis model contains a paginated list of users with partial information and\nmetadata about the pagination. It is used for endpoints that return multiple\nusers with their basic information.","title":"UsersListResponse"},"UpdateUserRolesRequest":{"type":"object","properties":{"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"New list of roles to assign to the user"},"roles_context":{"type":["string","null"],"description":"Context for the roles to update. This can either be 'system' for system-level roles or 'dataset:{dataset_id}' for dataset-level roles."}},"required":["roles"],"description":"Request model for updating user roles.\n\nThis model is used when modifying a user's role assignments. It allows for\nupdating the complete list of roles and optionally specifying the context\nwhere these roles apply. For example, if the \"system\" context is used, the roles\nprovided will only replace roles at the system level (ex. dataset\nroles would remain unchanged). If no context is provided, the role provided in the\nrequest will replace all roles for the user.","title":"UpdateUserRolesRequest"},"UserResponse":{"type":"object","properties":{"user_id":{"type":"string","description":"Unique identifier for the user"},"name":{"type":"string","description":"Display name of the user"},"email":{"type":["string","null"],"description":"Email address of the user"},"picture":{"type":["string","null"],"description":"URL to the user's profile picture"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the user was created"},"last_login":{"type":["string","null"],"format":"date-time","description":"Timestamp of the user's last login"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/Role"},"description":"List of roles assigned to the user"}},"required":["user_id","name","created_at","roles"],"description":"Complete user response model including roles.\n\nThis model extends the base user response to include the user's assigned roles.\nIt is used when the complete user information, including roles, is required.","title":"UserResponse"},"video-narative-metadata:MetadataType":{"type":"string","enum":["genre","mood","subject","format"],"description":"Supported metadata types.","title":"MetadataType"},"video-narative-metadata:CreateMetadataRequest":{"type":"object","properties":{"metadata_type":{"$ref":"#/components/schemas/video-narative-metadata:MetadataType"},"name":{"type":"string"},"description":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}},"required":["metadata_type","name","description","examples"],"description":"Create a new metadata value.","title":"CreateMetadataRequest"},"video-narative-metadata:MetadataItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"metadata_type":{"$ref":"#/components/schemas/video-narative-metadata:MetadataType"},"name":{"type":"string"},"description":{"type":"string"},"examples":{"type":"array","items":{"type":"string"}}},"required":["id","metadata_type","name","description","examples"],"description":"A metadata value.","title":"MetadataItem"},"video-narative-metadata:CreateMetadataResponse":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/video-narative-metadata:MetadataItem"}},"required":["item"],"description":"Response for created metadata.","title":"CreateMetadataResponse"},"video-narative-metadata:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"video-narative-metadata:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/video-narative-metadata:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"video-narative-metadata:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/video-narative-metadata:ValidationError"}}},"title":"HTTPValidationError"},"video-narative-metadata:DeleteMetadataResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["id","deleted"],"description":"Response for deleted metadata.","title":"DeleteMetadataResponse"},"video-narative-metadata:GenerateCompositeSliceSummaryRequest":{"type":"object","properties":{"composite_slice_context":{"type":["string","null"],"description":"Optional context about the composite slice"}},"description":"Request body for generating a composite slice summary.","title":"GenerateCompositeSliceSummaryRequest"},"video-narative-metadata:GenerateCompositeSliceSummaryResponse":{"type":"object","properties":{"summary":{"type":"string","description":"Generated composite slice summary"}},"required":["summary"],"description":"Response body for generating a composite slice summary.","title":"GenerateCompositeSliceSummaryResponse"},"video-narative-metadata:GenerateVideoDescriptionRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for generating a video description.","title":"GenerateVideoDescriptionRequest"},"video-narative-metadata:GenerateVideoDescriptionResponse":{"type":"object","properties":{"description":{"type":"string","description":"Generated video description"}},"required":["description"],"description":"Response body for generating a video description.","title":"GenerateVideoDescriptionResponse"},"video-narative-metadata:GenerateVideoSummaryRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for generating a video summary.","title":"GenerateVideoSummaryRequest"},"video-narative-metadata:GenerateVideoSummaryResponse":{"type":"object","properties":{"summary":{"type":"string","description":"Generated video summary"}},"required":["summary"],"description":"Response body for generating a video summary.","title":"GenerateVideoSummaryResponse"},"video-narative-metadata:GenerateVideoSynopsisRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for generating a video synopsis.","title":"GenerateVideoSynopsisRequest"},"video-narative-metadata:GenerateVideoSynopsisResponse":{"type":"object","properties":{"synopsis":{"type":"string","description":"Generated video synopsis"}},"required":["synopsis"],"description":"Response body for generating a video synopsis.","title":"GenerateVideoSynopsisResponse"},"video-narative-metadata:GetMetadataResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/video-narative-metadata:MetadataItem"}}},"required":["items"],"description":"Response for listing metadata values by type.","title":"GetMetadataResponse"},"video-narative-metadata:PredictCompositeSliceFormatRequest":{"type":"object","properties":{"composite_slice_context":{"type":["string","null"],"description":"Optional context about the composite slice"}},"description":"Request body for predicting composite slice formats.","title":"PredictCompositeSliceFormatRequest"},"video-narative-metadata:PredictCompositeSliceFormatResponse":{"type":"object","properties":{"formats":{"type":"array","items":{"type":"string"},"description":"Predicted composite slice formats"}},"required":["formats"],"description":"Response body for predicting composite slice formats.","title":"PredictCompositeSliceFormatResponse"},"video-narative-metadata:PredictCompositeSliceMoodRequest":{"type":"object","properties":{"composite_slice_context":{"type":["string","null"],"description":"Optional context about the composite slice"}},"description":"Request body for predicting composite slice moods.","title":"PredictCompositeSliceMoodRequest"},"video-narative-metadata:PredictCompositeSliceMoodResponse":{"type":"object","properties":{"moods":{"type":"array","items":{"type":"string"},"description":"Predicted composite slice moods"}},"required":["moods"],"description":"Response body for predicting composite slice moods.","title":"PredictCompositeSliceMoodResponse"},"video-narative-metadata:PredictCompositeSliceSubjectRequest":{"type":"object","properties":{"composite_slice_context":{"type":["string","null"],"description":"Optional context about the composite slice"}},"description":"Request body for predicting composite slice subjects.","title":"PredictCompositeSliceSubjectRequest"},"video-narative-metadata:PredictCompositeSliceSubjectResponse":{"type":"object","properties":{"subjects":{"type":"array","items":{"type":"string"},"description":"Predicted composite slice subjects"}},"required":["subjects"],"description":"Response body for predicting composite slice subjects.","title":"PredictCompositeSliceSubjectResponse"},"video-narative-metadata:PredictVideoFormatRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for predicting video formats.","title":"PredictVideoFormatRequest"},"video-narative-metadata:PredictVideoFormatResponse":{"type":"object","properties":{"formats":{"type":"array","items":{"type":"string"},"description":"Predicted video formats"}},"required":["formats"],"description":"Response body for predicting video formats.","title":"PredictVideoFormatResponse"},"video-narative-metadata:PredictVideoGenreRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for predicting video genres.","title":"PredictVideoGenreRequest"},"video-narative-metadata:PredictVideoGenreResponse":{"type":"object","properties":{"genres":{"type":"array","items":{"type":"string"},"description":"Predicted video genres"}},"required":["genres"],"description":"Response body for predicting video genres.","title":"PredictVideoGenreResponse"},"video-narative-metadata:PredictVideoMoodRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for predicting video moods.","title":"PredictVideoMoodRequest"},"video-narative-metadata:PredictVideoMoodResponse":{"type":"object","properties":{"moods":{"type":"array","items":{"type":"string"},"description":"Predicted video moods"}},"required":["moods"],"description":"Response body for predicting video moods.","title":"PredictVideoMoodResponse"},"video-narative-metadata:PredictVideoSubjectRequest":{"type":"object","properties":{"video_context":{"type":["string","null"],"description":"Optional context about the video"}},"description":"Request body for predicting video subjects.","title":"PredictVideoSubjectRequest"},"video-narative-metadata:PredictVideoSubjectResponse":{"type":"object","properties":{"subjects":{"type":"array","items":{"type":"string"},"description":"Predicted video subjects"}},"required":["subjects"],"description":"Response body for predicting video subjects.","title":"PredictVideoSubjectResponse"},"video-narative-metadata:UpdateMetadataRequest":{"type":"object","properties":{"name":{"type":["string","null"]},"description":{"type":["string","null"]},"examples":{"type":["array","null"],"items":{"type":"string"}}},"description":"Update fields of a metadata value.","title":"UpdateMetadataRequest"},"video-narative-metadata:UpdateMetadataResponse":{"type":"object","properties":{"item":{"$ref":"#/components/schemas/video-narative-metadata:MetadataItem"}},"required":["item"],"description":"Response for updated metadata.","title":"UpdateMetadataResponse"},"video-narative-metadata:CaptionVideoKeyframesResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"description":"Response body for video keyframes captioning.","title":"CaptionVideoKeyframesResponse"},"video-scores:ShotTextPrompt":{"type":"object","properties":{"modality":{"type":"string","description":"The modality of the prompt (e.g., \"Visual\" or \"Transcript\")."},"prompt":{"type":"string","description":"The text prompt used to score this shot."}},"required":["modality","prompt"],"description":"Text prompt with modality information for shot scoring.","title":"ShotTextPrompt"},"video-scores:ShotScore":{"type":"object","properties":{"shot_id":{"type":"string","format":"uuid","description":"Shot identifier."},"score":{"type":"number","format":"double","minimum":0,"maximum":1,"description":"Computed score for the shot."},"start_time":{"type":"number","format":"double","description":"Shot start time in seconds."},"end_time":{"type":"number","format":"double","description":"Shot end time in seconds."},"duration":{"type":"number","format":"double","minimum":0,"description":"Shot duration in seconds."},"textPrompts":{"type":"array","items":{"$ref":"#/components/schemas/video-scores:ShotTextPrompt"},"description":"Text prompts for this shot from the asset-check endpoint."}},"required":["shot_id","score","start_time","end_time","duration"],"description":"Shot-level score for a single shot in a video (only shots meeting min_conf are returned).","title":"ShotScore"},"video-scores:GetVideoShotScoresResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/video-scores:ShotScore"},"description":"Shot scores for the video."},"total_shot_count":{"type":["integer","null"],"description":"Total number of shots in the video (from Pinot composite keyframes); null if unavailable."}},"description":"Response for getting shot scores for a video.","title":"GetVideoShotScoresResponse"},"video-scores:ValidationErrorLocItems":{"oneOf":[{"type":"string"},{"type":"integer"}],"title":"ValidationErrorLocItems"},"video-scores:ValidationError":{"type":"object","properties":{"loc":{"type":"array","items":{"$ref":"#/components/schemas/video-scores:ValidationErrorLocItems"}},"msg":{"type":"string"},"type":{"type":"string"}},"required":["loc","msg","type"],"title":"ValidationError"},"video-scores:HTTPValidationError":{"type":"object","properties":{"detail":{"type":"array","items":{"$ref":"#/components/schemas/video-scores:ValidationError"}}},"title":"HTTPValidationError"},"video-scores:SortDirection":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort direction for results.","title":"SortDirection"},"video-scores:PageDetails":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"description":"Current page number (1-indexed)."},"per_page":{"type":"integer","minimum":1,"maximum":1000,"description":"Number of items per page."}},"required":["page","per_page"],"description":"Pagination metadata.","title":"PageDetails"},"video-scores:PageMetadata":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/video-scores:PageDetails","description":"Details about pagination."},"has_next_page":{"type":"boolean","description":"Whether another page exists."}},"required":["page","has_next_page"],"description":"Metadata about the paginated response.","title":"PageMetadata"},"video-scores:VideoModelInternalMetadata":{"type":"object","properties":{},"title":"VideoModelInternalMetadata"},"video-scores:VideoModel":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Coactive Video ID."},"dataset_id":{"type":"string","format":"uuid"},"created_user_id":{"type":"string"},"updated_user_id":{"type":"string"},"created_dt":{"type":"string","format":"date-time"},"updated_dt":{"type":"string","format":"date-time"},"status":{"type":"string"},"path":{"type":"string","description":"Path to the video file."},"video_key":{"type":"string"},"internal_metadata":{"$ref":"#/components/schemas/video-scores:VideoModelInternalMetadata"}},"required":["id","dataset_id","created_user_id","updated_user_id","created_dt","updated_dt","status","path"],"description":"Video details.","title":"VideoModel"},"video-scores:VideoMetadata":{"type":"object","properties":{"title":{"type":["string","null"],"description":"Video title."},"episode_name":{"type":["string","null"],"description":"Episode name."},"video_type":{"type":["string","null"],"description":"Video type."},"series_name":{"type":["string","null"],"description":"Series name."},"genre":{"type":["string","null"],"description":"Genre."},"rating":{"type":["string","null"],"description":"Rating."},"content_id":{"type":["string","null"],"description":"Content ID."}},"description":"Video metadata from the metadata service.","title":"VideoMetadata"},"video-scores:VideoScore":{"type":"object","properties":{"group_id":{"type":"string","format":"uuid","description":"Group ID."},"group_name":{"type":"string","description":"Group name."},"tag_id":{"type":"string","format":"uuid","description":"Tag ID."},"tag_name":{"type":"string","description":"Tag name."},"tag_version_id":{"type":"string","format":"uuid","description":"Version identifier for the tag."},"coactive_video_id":{"type":"string","format":"uuid","description":"Coactive Video ID."},"score":{"type":"number","format":"double","minimum":0,"description":"Computed score."},"criteria_met":{"type":"boolean","description":"Whether the criteria was met."},"accepted":{"type":"boolean","description":"Whether the result is accepted."},"computed_dt":{"type":"string","format":"date-time","description":"When the score was computed."},"video":{"oneOf":[{"$ref":"#/components/schemas/video-scores:VideoModel"},{"type":"null"}],"description":"Video details associated with the score."},"video_metadata":{"oneOf":[{"$ref":"#/components/schemas/video-scores:VideoMetadata"},{"type":"null"}],"description":"Video metadata from the metadata service."},"preview_s3_path":{"type":["string","null"],"description":"S3 path (s3://bucket/key) to the preview keyframe for this video and tag version when available."},"preview_asset_start_time_ms":{"type":["number","null"],"format":"double","description":"Start time of the preview asset in milliseconds when preview is available."},"preview_asset_end_time_ms":{"type":["number","null"],"format":"double","description":"End time of the preview asset in milliseconds when preview is available."}},"required":["group_id","group_name","tag_id","tag_name","tag_version_id","coactive_video_id","score","criteria_met","accepted","computed_dt"],"description":"Video score result.","title":"VideoScore"},"video-scores:SortField":{"type":"object","properties":{"field":{"type":"string","description":"Field name to sort by."},"direction":{"$ref":"#/components/schemas/video-scores:SortDirection","description":"Sort direction."}},"required":["field"],"description":"Sort field details.","title":"SortField"},"video-scores:GetVideoScoresResponse":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/video-scores:PageMetadata","description":"Metadata for pagination."},"data":{"type":"array","items":{"$ref":"#/components/schemas/video-scores:VideoScore"},"description":"The paginated data."},"sort":{"type":"array","items":{"$ref":"#/components/schemas/video-scores:SortField"},"description":"Sort details."}},"required":["meta"],"description":"Response for getting video scores.","title":"GetVideoScoresResponse"},"video-scores:GetVideoScoresResultCountPredicate":{"type":"object","properties":{"criteria_met":{"type":"boolean","description":"Whether the criteria was met."},"accepted":{"type":["boolean","null"],"description":"Whether the result is accepted."}},"required":["criteria_met"],"description":"Predicate used for counting video scores.","title":"GetVideoScoresResultCountPredicate"},"video-scores:GetVideoScoresResultCountResponse":{"type":"object","properties":{"group_id":{"type":"string","format":"uuid","description":"Group ID."},"tag_id":{"type":"string","format":"uuid","description":"Tag ID."},"aggregation_id":{"type":"string","format":"uuid","description":"Aggregation ID."},"count":{"type":"integer","description":"Total count of video scores matching the criteria."},"predicate":{"$ref":"#/components/schemas/video-scores:GetVideoScoresResultCountPredicate","description":"Predicate used for counting."}},"required":["group_id","tag_id","aggregation_id","count","predicate"],"description":"Response for getting video scores result count.","title":"GetVideoScoresResultCountResponse"},"video-scores:AggregationMethodology":{"type":"string","enum":["ANY_HIT","COVERAGE_THRESHOLD","LONGEST_RUN"],"description":"The methodology used for aggregating shot scores into video scores. LONGEST_RUN is only supported with the DUCKDB engine.","title":"AggregationMethodology"},"video-scores:AggregationEngine":{"type":"string","enum":["DUCKDB","PINOT"],"default":"DUCKDB","description":"Backend engine used to query shot scores. DUCKDB (default) supports all aggregation strategies; PINOT supports ANY_HIT and COVERAGE_THRESHOLD only.","title":"AggregationEngine"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}