Multimodal contextual-intelligence REST API for ingesting, indexing, searching, and analyzing images and video — datasets, ingestion, search, concepts, dynamic tags, queries, connections, celebrity detection, video narrative metadata, Context Studio ad segments, user management, and system credentials.
{"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","default":1}},{"name":"per_page","in":"query","description":"Number of items per page","required":false,"schema":{"type":"integer","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","default":0}},{"name":"limit","in":"query","description":"Max 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":"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","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","default":0}},{"name":"limit","in":"query","description":"Max number of items to return","required":false,"schema":{"type":"integer","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
# --- truncated at 32 KB (321 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coactive-ai/refs/heads/main/openapi/coactive-ai-openapi-original.json