CreativAI API Documentation

Welcome to the CreativAI API documentation. This comprehensive guide will help you integrate AI-powered video analysis and data management into your applications.

API Key Configuration

Enter your API key once here. It will be automatically used for all endpoint tests below.

RESTful API

Simple, intuitive REST endpoints with JSON request and response formats for easy integration.

Secure Authentication

API key-based authentication ensures your data and requests are always secure and protected.

Global Availability

Access our APIs from anywhere with low latency and high reliability across global regions.

Easy Integration

Detailed documentation make integration quick and straightforward.

Base URL

https://creativai-apis.com/testing

All API requests should be made to this base URL with the appropriate endpoint path.

Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

// Headers

"x-api-key": "your_api_key_here"

"Content-Type": "application/json"

Response Format

All responses are returned in JSON format with a consistent structure:

{

"success": true,

"data": { ... },

"error": null

}

User Management

GET/user/get_users_info

Get User Info

Retrieve information about the authenticated user including credits and usage.

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

Responses

200Successfully retrieved user information

{
  "user_id": "user_123",
  "email": "user@example.com",
  "credits": 1000,
  "organization_id": "org_123",
  "project_name": "my_project",
  "created_at": "2024-01-01T00:00:00Z"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/user/get_users_info" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

Collections

GET/collections

List Collections

Retrieve a list of all collections for the specified organization and project.

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

Responses

200Successfully retrieved collections

{
  "collection_id_1": {
    "collection_id": "col_123",
    "collection_name": "TV Shows",
    "total_videos": 150,
    "created_at": "2024-01-15T10:30:00Z",
    "indexed": true
  },
  "collection_id_2": {
    "collection_id": "col_456",
    "collection_name": "Shark Tank",
    "total_videos": 200,
    "created_at": "2024-01-20T14:20:00Z",
    "indexed": true
  }
}

401Unauthorized - Invalid API key

{
  "error": "Invalid API key provided"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/collections?organization_id=org_123&project_name=my_project" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

POST/collections

Create Collection

Create a new collection to organize and manage your videos.

Request Body

collection_namestringrequired

The name for the new collection

Example: "My New Collection"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_name *(string)

Responses

200Successfully created collection

{
  "collection_id": "col_789",
  "collection_name": "My New Collection",
  "organization_id": "org_123",
  "project_name": "my_project",
  "user_id": "user_456",
  "created_at": "2024-01-28T12:00:00Z"
}

400Bad Request - Missing required fields

{
  "error": "collection_name is required"
}

Example Request

curl -X POST "https://creativai-apis.com/testing/collections" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"collection_name": "My New Collection"}'

DELETE/collections/{collection_id}

Delete Collection

Delete a specific collection and all its associated data.

Path Parameters

collection_idstringrequired

The unique identifier of the collection to delete

Example: "col_123"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(path parameter - string)

Responses

200Successfully deleted collection

{
  "success": true,
  "message": "Collection deleted successfully"
}

404Collection not found

{
  "error": "Collection not found"
}

Example Request

curl -X DELETE "https://creativai-apis.com/testing/collections/col_123" \
  -H "x-api-key: your_api_key_here"

Videos

GET/collections/{collection_id}/videos

List Videos

Retrieve a list of all videos in a specific collection with their metadata.

Path Parameters

collection_idstringrequired

The unique identifier of the collection

Example: "col_123"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(path parameter - string)

Responses

200Successfully retrieved videos

{
  "collection_id": "col_123",
  "collection_name": "TV Shows",
  "total_videos": 150,
  "videos": [
    {
      "video_id": "vid_001",
      "filename": "episode_s01e01.mp4",
      "video_url": "https://example.s3.amazonaws.com/video.mp4",
      "status": "completed",
      "indexed": true,
      "duration_seconds": 1800,
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Example Request

curl -X GET "https://creativai-apis.com/testing/collections/col_123/videos" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

POST/collections/uploads/initiate

Upload Video

Initiate a multipart video upload. Returns presigned URLs for uploading video file parts to S3.

Request Body

collection_idstringrequired

The collection ID to upload the video to

Example: "satyams_42dcf9d5"

filesarrayrequired

Array of files to upload. Each file includes filename, file_size, and content_type

Example: "[{\"filename\": \"video.mp4\", \"file_size\": 4063532, \"content_type\": \"video/mp4\"}]"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

files *(array)

Responses

200Upload initiation successful with presigned URLs

{
  "success": true,
  "data": {
    "uploads": [
      {
        "filename": "a3f9f4d94e5641e0a53d15ebdf385fe2.mp4",
        "upload_id": "upload_12345",
        "video_id": "vid_abc123",
        "s3_key": "satyams_42dcf9d5/uploads/a3f9f4d94e5641e0a53d15ebdf385fe2.mp4",
        "part_size": 5242880,
        "presigned_urls": [
          "https://creativai-staging-video-storage.s3.amazonaws.com/upload?part=1&upload_id=xyz",
          "https://creativai-staging-video-storage.s3.amazonaws.com/upload?part=2&upload_id=xyz"
        ]
      }
    ]
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/collections/uploads/initiate" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "files": [
      {
        "filename": "a3f9f4d94e5641e0a53d15ebdf385fe2.mp4",
        "file_size": 4063532,
        "content_type": "video/mp4"
      }
    ]
  }'

GET/api/v2/indexing/video-status

Check Video Indexing Status

Check the indexing status of a video. Returns the current indexing progress and completion status.

Query Parameters

video_s3_uristringrequired

The S3 URI of the video file to check indexing status for

Example:

"s3://creativai-staging-video-storage/Zyfgnt2C3lPWv91vTi7dP8qrvxY2/0cd5ae29-6746-4bca-b0e5-f519f2db9a08/Default%20Project/satyams_42dcf9d5/a3f9f4d94e5641e0a53d15ebdf385fe2_96cce721.mp4"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

Responses

200Indexing status retrieved successfully

{
  "video_s3_uri": "s3://creativai-staging-video-storage/Zyfgnt2C3lPWv91vTi7dP8qrvxY2/0cd5ae29-6746-4bca-b0e5-f519f2db9a08/Default%20Project/satyams_42dcf9d5/a3f9f4d94e5641e0a53d15ebdf385fe2_96cce721.mp4",
  "status": "completed",
  "progress": 100,
  "indexed_segments": 45,
  "total_segments": 45,
  "indexing_started_at": "2026-01-28T10:35:00Z",
  "indexing_completed_at": "2026-01-28T10:37:00Z",
  "embedding_model": "default",
  "vector_dimension": 768
}

404Video not found or not yet indexed

{
  "error": "Video not found",
  "status": "not_found"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/api/v2/indexing/video-status?video_s3_uri=s3%3A%2F%2Fcreativai-staging-video-storage%2FZyfgnt2C3lPWv91vTi7dP8qrvxY2%2F0cd5ae29-6746-4bca-b0e5-f519f2db9a08%2FDefault%2520Project%2Fsatyams_42dcf9d5%2Fa3f9f4d94e5641e0a53d15ebdf385fe2_96cce721.mp4" \
  -H "x-api-key: your_api_key_here"

GET/api/v2/indexing/chunk-based/{job_id}/status

Check Indexing Job Status

Check the status of an indexing job. Returns progress, completion status, and processing results.

Path Parameters

job_idstringrequired

The unique identifier of the indexing job to check

Example: "b4051a14-5450-47e7-b926-acf234838b70"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

job_id *(path parameter - string)

Responses

200Job status retrieved successfully

{
  "job_id": "b4051a14-5450-47e7-b926-acf234838b70",
  "status": "completed",
  "progress": 100,
  "total_chunks": 48,
  "processed_chunks": 48,
  "failed_chunks": 0,
  "skipped_chunks": 0,
  "video_s3_uri": "s3://creativai-staging-video-storage/Zyfgnt2C3lPWv91vTi7dP8qrvxY2/0cd5ae29-6746-4bca-b0e5-f519f2db9a08/Default%20Project/satyams_42dcf9d5/a3f9f4d94e5641e0a53d15ebdf385fe2_96cce721.mp4",
  "processing_started_at": "2026-01-28T10:35:00Z",
  "processing_completed_at": "2026-01-28T10:37:00Z",
  "processing_duration_seconds": 120,
  "embedding_model": "default",
  "error_messages": []
}

404Job not found

{
  "error": "Job not found",
  "job_id": "b4051a14-5450-47e7-b926-acf234838b70"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/api/v2/indexing/chunk-based/b4051a14-5450-47e7-b926-acf234838b70/status" \
  -H "x-api-key: your_api_key_here"

DELETE/collections/{collection_id}/videos

Delete Videos

Delete one or more videos from a collection by their S3 URLs.

Path Parameters

collection_idstringrequired

The collection ID containing the videos

Example: "satyams_42dcf9d5"

Request Body

videos_urls_listarrayrequired

Array of S3 URLs of videos to delete

Example:

"[\"s3://creativai-staging-video-storage/Zyfgnt2C3lPWv91vTi7dP8qrvxY2/0cd5ae29-6746-4bca-b0e5-f519f2db9a08/Default Project/satyams_42dcf9d5/a3f9f4d94e5641e0a53d15ebdf385fe2_96cce721.mp4\"]"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(path parameter - string)

videos_urls_list *(array)

Responses

200Videos successfully deleted

{
  "success": true,
  "message": "Videos deleted successfully"
}

400Bad Request - Invalid S3 URLs

{
  "success": false,
  "error": "One or more video URLs not found"
}

Example Request

curl 'https://creativai-apis.com/testing/collections/satyams_42dcf9d5/videos' \
  -X 'DELETE' \
  -H 'accept: application/json' \
  -H 'content-type: application/json' \
  -H 'x-api-key: your_api_key_here' \
  -d '{"videos_urls_list":["s3://creativai-staging-video-storage/Zyfgnt2C3lPWv91vTi7dP8qrvxY2/0cd5ae29-6746-4bca-b0e5-f519f2db9a08/Default Project/satyams_42dcf9d5/a3f9f4d94e5641e0a53d15ebdf385fe2_96cce721.mp4"]}'

Indexing & Processing

POST/api/v2/indexing/chunks

Start Chunk-Based Indexing

Initiate chunk-based indexing for video segments in a collection.

Request Body

collection_idstringrequired

The collection ID to index

Example: "satyams_42dcf9d5"

chunk_sizenumber

Size of chunks in seconds

Example: 10

model_versionstring

AI model version to use

Example: "base"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

chunk_size(number)

model_version(string)

Responses

200Chunk-based indexing initiated successfully

{
  "success": true,
  "data": {
    "job_id": "job_index_001",
    "collection_id": "satyams_42dcf9d5",
    "status": "processing",
    "chunk_size": 10,
    "total_videos": 5,
    "estimated_chunks": 1800,
    "started_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

400Bad Request - Missing required parameters

{
  "success": false,
  "error": "collection_id is required"
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v2/indexing/chunks" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "chunk_size": 10,
    "model_version": "base"
  }'

GET/api/v2/indexing/collections/{collection_id}/status

Get Collection Preprocessing Status

Retrieve the preprocessing and indexing status of a collection.

Path Parameters

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(path parameter - string)

Responses

200Successfully retrieved preprocessing status

{
  "success": true,
  "data": {
    "collection_id": "satyams_42dcf9d5",
    "overall_status": "processing",
    "videos": {
      "total": 5,
      "indexed": 3,
      "processing": 2,
      "failed": 0
    },
    "chunks": {
      "total": 1800,
      "processed": 1200,
      "remaining": 600
    },
    "progress_percentage": 66.7,
    "last_updated": "2026-01-28T12:00:00Z",
    "estimated_completion": "2026-01-28T14:30:00Z"
  },
  "error": null
}

404Collection not found

{
  "success": false,
  "error": "Collection not found"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/api/v2/indexing/collections/satyams_42dcf9d5/status" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

Data Plates

POST/api/v3/data-plates/create

Create Data Plate

Create a new data plate from search results with AI-powered validation.

Request Body

collection_idstringrequired

The collection ID containing the videos

Example: "satyams_42dcf9d5"

user_querystringrequired

The search query used to find segments

Example: "what robot is doing?"

search_idstringrequired

The ID of the search to create the plate from

Example: "82ca9c80-d978-4632-9225-32295df40a76"

top_knumberrequired

Number of top results to include

Example: 1

levelsarrayrequired

Relevance levels to include: high, medium, low

Example: "[\"high\"]"

namestringrequired

Name for the data plate

Example: "What Robot Is Doing?"

metadataobject

Additional metadata for the data plate

Example: "{}"

model_versionstringrequired

AI model version to use for validation

Example: "base"

early_stopbooleanrequired

Enable early stopping for validation

Example: true

early_stop_limitnumberrequired

Number of segments before early stop triggers

Example: 4

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

user_query *(string)

search_id *(string)

top_k *(number)

levels *(array)

name *(string)

metadata(object)

model_version *(string)

early_stop *(boolean)

early_stop_limit *(number)

Responses

200Data plate creation job started

{
  "success": true,
  "data": {
    "job_id": "job_789",
    "status": "processing",
    "progress": 0,
    "created_at": "2024-01-28T12:00:00Z",
    "total_segments": 1,
    "segments_queued_for_validation": 1,
    "segments_skipped_initially": 0
  },
  "error": null
}

400Bad Request - Missing required fields

{
  "success": false,
  "error": "collection_id, search_id, and levels are required",
  "data": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/data-plates/create" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "user_query": "what robot is doing?",
    "search_id": "82ca9c80-d978-4632-9225-32295df40a76",
    "top_k": 1,
    "levels": ["high"],
    "name": "What Robot Is Doing?",
    "metadata": {},
    "model_version": "base",
    "early_stop": true,
    "early_stop_limit": 4
  }'

POST/api/v3/data-plates/list

List Data Plates

Retrieve a list of all data plates for a specific collection.

Request Body

collection_idstringrequired

The collection ID to list data plates from

Example: "col_123"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

Responses

200Successfully retrieved data plates

{
  "success": true,
  "data": [
    {
      "plate_id": "326fc12d-5846-4620-aca9-c49a8288ee0f",
      "collection_id": "satyams_42dcf9d5",
      "user_id": "Zyfgnt2C3lPWv91vTi7dP8qrvxY2",
      "created_by": "Zyfgnt2C3lPWv91vTi7dP8qrvxY2",
      "name": "What Robot Is Doing?",
      "search_id": "82ca9c80-d978-4632-9225-32295df40a76",
      "top_k": 1,
      "metadata": {
        "validation": {
          "query": "what robot is doing?",
          "decision_mode": "binary_yes_no",
          "model_version": "base",
          "early_stop_enabled": true,
          "early_stop_triggered": false,
          "evaluated_segments": 1,
          "removed_count": 0,
          "kept_count": 1,
          "skipped_count": 0,
          "timestamp": "2026-01-28T06:28:47.470055",
          "validation_job_id": "97b7a408-1894-4993-b4ac-144521223bf0"
        }
      },
      "segment_count": 1,
      "columns": [],
      "created_at": "2026-01-28T06:28:47.470000",
      "updated_at": "2026-01-28T06:28:47.578000"
    }
  ],
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/data-plates/list" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"collection_id": "col_123"}'

POST/api/v3/data-plates/get

Get Data Plate

Retrieve detailed information about a specific data plate including all segments.

Request Body

collection_idstringrequired

The collection ID

Example: "col_123"

plate_idstringrequired

The unique identifier of the data plate

Example: "plate_001"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

Responses

200Successfully retrieved data plate

{
  "success": true,
  "data": {
    "plate_id": "plate_001",
    "name": "Product Pitches Dataset",
    "segment_count": 45,
    "segments": [
      {
        "segment_id": "seg_001",
        "video_id": "vid_001",
        "metadata": {
          "start": 120.5,
          "end": 145.8,
          "subtitles": "This is our product...",
          "thumbnail_url": "https://example.com/thumb.jpg"
        },
        "extracted_info": {}
      }
    ],
    "metadata": {
      "validation": {
        "query": "product pitch scenes",
        "kept_count": 45,
        "removed_count": 5
      }
    }
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/data-plates/get" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "col_123",
    "plate_id": "plate_001"
  }'

POST/api/v3/data-plates/delete

Delete Data Plate

Delete a specific data plate permanently.

Request Body

collection_idstringrequired

The collection ID

Example: "col_123"

plate_idstringrequired

The unique identifier of the data plate to delete

Example: "plate_001"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

Responses

200Successfully deleted data plate

{
  "success": true,
  "data": {
    "message": "Data plate deleted successfully"
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/data-plates/delete" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "col_123",
    "plate_id": "plate_001"
  }'

POST/api/v3/data-plates/segments/add

Add Segments

Add new segments to an existing data plate.

Request Body

collection_idstringrequired

The collection ID

Example: "col_123"

plate_idstringrequired

The data plate ID

Example: "plate_001"

segmentsarrayrequired

Array of segment objects to add

Example: "[{\"video_id\": \"vid_001\", \"start\": 120, \"end\": 145}]"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

segments *(array)

Responses

200Successfully added segments

{
  "success": true,
  "data": {
    "added_count": 5,
    "message": "Segments added successfully"
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/data-plates/segments/add" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "col_123",
    "plate_id": "plate_001",
    "segments": [{"video_id": "vid_001", "start": 120, "end": 145}]
  }'

POST/api/v3/data-plates/segments/remove

Remove Segments

Remove specific segments from a data plate.

Request Body

collection_idstringrequired

The collection ID

Example: "col_123"

plate_idstringrequired

The data plate ID

Example: "plate_001"

segment_idsarrayrequired

Array of segment IDs to remove

Example: "[\"seg_001\", \"seg_002\"]"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

segment_ids *(array)

Responses

200Successfully removed segments

{
  "success": true,
  "data": {
    "removed_count": 2,
    "message": "Segments removed successfully"
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/data-plates/segments/remove" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "col_123",
    "plate_id": "plate_001",
    "segment_ids": ["seg_001", "seg_002"]
  }'

Search

POST/api/v3/search

Semantic Search

Perform AI-powered semantic search across video content within a specific collection using natural language queries.

Request Body

collection_idstringrequired

The collection ID to search within

Example: "col_123"

querystringrequired

Natural language search query

Example: "entrepreneurs pitching innovative tech products"

top_knumber

Number of results to return (default: 100)

Example: 50

model_versionstring

AI model version to use for search

Example: "base"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

query *(string)

top_k(number)

model_version(string)

Responses

200Successfully completed search

{
  "success": true,
  "data": {
    "search_id": "search_789",
    "results": [
      {
        "segment_id": "seg_001",
        "video_id": "vid_001",
        "score": 0.95,
        "relevance": "high",
        "metadata": {
          "start": 120.5,
          "end": 145.8,
          "subtitles": "This is our innovative product...",
          "thumbnail_url": "https://example.com/thumb.jpg"
        }
      }
    ],
    "total_results": 45
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/search" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "col_123",
    "query": "entrepreneurs pitching innovative tech products",
    "top_k": 50
  }'

POST/search_videos

Search Videos

Perform a video search with semantic understanding using vision or text-based queries.

Request Body

text_querystringrequired

Natural language search query

Example: "what going on?"

search_typestringrequired

Type of search to perform (e.g., vision, text)

Example: "vision"

collection_idstringrequired

The collection ID to search within

Example: "satyams_42dcf9d5"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

text_query *(string)

search_type *(string)

collection_id *(string)

Responses

200Successfully completed search

{
  "high": [
    {
      "video_id": 462717127808900350,
      "distance": 0.3842441439628601,
      "entity": {
        "start": 0,
        "subtitles": "Video content description",
        "clip_number": "00000",
        "video_url": "https://creativai-staging-video-storage.s3.amazonaws.com/.../video.mp4",
        "clip_url": "https://staging-users-chuncked-videos.s3.amazonaws.com/.../chunk_00000.mp4",
        "thumbnail_url": "https://staging-users-chuncked-videos.s3.amazonaws.com/.../thumb_00000.jpg",
        "end": 2.4000000953674316,
        "tags": [],
        "video_id": 462717127808900350
      },
      "ranking_score": 0.01639344262295082
    }
  ],
  "medium": [],
  "low": [],
  "search_id": "9514f2ab-74e3-4238-bedc-01c302686ce6"
}

400Bad Request - Missing or invalid parameters

{
  "error": "text_query, search_type, and collection_id are required"
}

Example Request

curl -X POST "https://creativai-apis.com/testing/search_videos" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "text_query": "what going on?",
    "search_type": "vision",
    "collection_id": "satyams_42dcf9d5"
  }'

Knowledge Extraction

POST/api/v3/knowledge-extraction/chat/query

Add Column (Chat Query)

Add a new column to a data plate using AI to extract information from video segments via natural language query.

Request Body

collection_idstringrequired

The collection ID containing the videos

Example: "satyams_42dcf9d5"

plate_idstringrequired

The data plate ID to add the column to

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

querystringrequired

Natural language query for information extraction

Example: "is it medical treatment?"

model_versionstring

AI model version to use for extraction

Example: "base"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

query *(string)

model_version(string)

Responses

200Column extraction initiated successfully

{
  "success": true,
  "data": {
    "job_id": "job_abc123",
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "query": "is it medical treatment?",
    "status": "processing",
    "created_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

400Bad Request - Missing required parameters

{
  "success": false,
  "error": "collection_id, plate_id, and query are required",
  "error_details": {
    "missing_fields": [
      "query"
    ]
  }
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/knowledge-extraction/chat/query" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "query": "is it medical treatment?",
    "model_version": "base"
  }'

POST/api/v2/chat/sessions/list

List Chat Sessions

Retrieve all chat sessions associated with a data plate.

Request Body

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

limitnumber

Maximum number of sessions to return

Example: 20

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

limit(number)

Responses

200Successfully retrieved chat sessions

{
  "success": true,
  "data": {
    "sessions": [
      {
        "session_id": "session_001",
        "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
        "collection_id": "satyams_42dcf9d5",
        "title": "Query Results",
        "message_count": 5,
        "last_message_at": "2026-01-28T12:30:00Z",
        "created_at": "2026-01-28T12:00:00Z"
      }
    ],
    "total_count": 1
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v2/chat/sessions/list" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "limit": 20
  }'

POST/api/v3/knowledge-extraction/charts/plate

Get Dashboard Charts

Retrieve AI-generated charts and visualizations for a data plate dashboard.

Request Body

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

collection_id *(string)

plate_id *(string)

Responses

200Successfully retrieved plate charts and insights

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "collection_id": "satyams_42dcf9d5",
    "charts": [
      {
        "chart_id": "chart_001",
        "type": "bar",
        "title": "Response Distribution",
        "description": "Distribution of responses across segments",
        "data": {
          "labels": [
            "Yes",
            "No",
            "Unknown"
          ],
          "values": [
            25,
            15,
            5
          ]
        }
      },
      {
        "chart_id": "chart_002",
        "type": "pie",
        "title": "Category Breakdown",
        "description": "Breakdown of segments by category",
        "data": {
          "labels": [
            "Medical",
            "Non-Medical",
            "Unclear"
          ],
          "values": [
            30,
            10,
            5
          ]
        }
      }
    ],
    "total_segments": 45,
    "generated_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

404Data plate not found

{
  "success": false,
  "error": "Data plate not found"
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v3/knowledge-extraction/charts/plate" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17"
  }'

Data Plate Operations

GET/api/v2/data-plates/{plate_id}

Get Data Plate

Retrieve detailed information about a specific data plate.

Path Parameters

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

Query Parameters

collection_idstringrequired

The collection ID containing the data plate

Example: "satyams_42dcf9d5"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

plate_id *(path parameter - string)

Responses

200Successfully retrieved data plate

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "collection_id": "satyams_42dcf9d5",
    "name": "Medical Analysis Plate",
    "description": "Analysis of medical procedures",
    "columns": [
      "segment_id",
      "timestamp",
      "medical_treatment",
      "severity"
    ],
    "row_count": 125,
    "created_at": "2026-01-20T10:00:00Z",
    "updated_at": "2026-01-28T12:00:00Z",
    "status": "active"
  },
  "error": null
}

404Data plate not found

{
  "success": false,
  "error": "Data plate not found"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/api/v2/data-plates/137be5ec-7f10-4c8d-8237-f13149f6cd17?collection_id=satyams_42dcf9d5" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

DELETE/api/v2/data-plates/{plate_id}

Delete Data Plate

Delete a data plate and all associated data.

Path Parameters

plate_idstringrequired

The data plate ID to delete

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

Query Parameters

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

plate_id *(path parameter - string)

Responses

200Data plate successfully deleted

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "status": "deleted",
    "deleted_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

404Data plate not found

{
  "success": false,
  "error": "Data plate not found"
}

Example Request

curl -X DELETE "https://creativai-apis.com/testing/api/v2/data-plates/137be5ec-7f10-4c8d-8237-f13149f6cd17?collection_id=satyams_42dcf9d5" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

POST/api/v2/data-plates/{plate_id}/videos

Get Videos Info

Retrieve information about videos associated with a data plate.

Path Parameters

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

Request Body

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

limitnumber

Maximum number of videos to return

Example: 50

offsetnumber

Number of results to skip for pagination

Example: 0

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

plate_id *(path parameter - string)

collection_id *(string)

limit(number)

offset(number)

Responses

200Successfully retrieved videos information

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "videos": [
      {
        "video_id": "vid_001",
        "filename": "procedure_analysis_001.mp4",
        "duration": 3600,
        "segment_count": 25,
        "upload_date": "2026-01-15T10:30:00Z",
        "status": "indexed"
      },
      {
        "video_id": "vid_002",
        "filename": "procedure_analysis_002.mp4",
        "duration": 2400,
        "segment_count": 18,
        "upload_date": "2026-01-18T14:00:00Z",
        "status": "indexed"
      }
    ],
    "total_count": 2
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v2/data-plates/137be5ec-7f10-4c8d-8237-f13149f6cd17/videos" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "limit": 50,
    "offset": 0
  }'

POST/api/v2/data-plates/{plate_id}/segments

Add Segments

Add new segments to a data plate.

Path Parameters

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

Request Body

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

segmentsarrayrequired

Array of segments to add (see example request for structure)

Example: "[{segment_id, video_id, start_time, end_time, label}]"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

plate_id *(path parameter - string)

collection_id *(string)

segments *(array)

Responses

200Segments successfully added

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "added_segments": 1,
    "total_segments": 126,
    "created_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

Example Request

curl -X POST "https://creativai-apis.com/testing/api/v2/data-plates/137be5ec-7f10-4c8d-8237-f13149f6cd17/segments" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "segments": [
      {
        "segment_id": "seg_001",
        "video_id": "vid_001",
        "start_time": 120,
        "end_time": 180,
        "label": "treatment_procedure"
      }
    ]
  }'

DELETE/api/v2/data-plates/{plate_id}/segments

Remove Segments

Remove segments from a data plate.

Path Parameters

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

Request Body

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

segment_idsarrayrequired

Array of segment IDs to remove

Example: "[\"seg_001\", \"seg_002\"]"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

plate_id *(path parameter - string)

collection_id *(string)

segment_ids *(array)

Responses

200Segments successfully removed

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "removed_segments": 2,
    "total_segments": 124,
    "deleted_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

Example Request

curl -X DELETE "https://creativai-apis.com/testing/api/v2/data-plates/137be5ec-7f10-4c8d-8237-f13149f6cd17/segments" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "satyams_42dcf9d5",
    "segment_ids": ["seg_001", "seg_002"]
  }'

DELETE/api/v2/data-plates/{plate_id}/columns/{column_name}

Delete Column

Delete a column from a data plate.

Path Parameters

plate_idstringrequired

The data plate ID

Example: "137be5ec-7f10-4c8d-8237-f13149f6cd17"

column_namestringrequired

The name of the column to delete

Example: "medical_treatment"

Query Parameters

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

plate_id *(path parameter - string)

column_name *(path parameter - string)

Responses

200Column successfully deleted

{
  "success": true,
  "data": {
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "deleted_column": "medical_treatment",
    "remaining_columns": [
      "segment_id",
      "timestamp",
      "severity"
    ],
    "deleted_at": "2026-01-28T12:00:00Z"
  },
  "error": null
}

404Column not found

{
  "success": false,
  "error": "Column not found"
}

Example Request

curl -X DELETE "https://creativai-apis.com/testing/api/v2/data-plates/137be5ec-7f10-4c8d-8237-f13149f6cd17/columns/medical_treatment?collection_id=satyams_42dcf9d5" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"

Chat Sessions

GET/api/v2/chat/sessions/{session_id}

Get Chat Session

Retrieve details of a specific chat session.

Path Parameters

session_idstringrequired

The chat session ID

Example: "session_001"

Query Parameters

collection_idstringrequired

The collection ID

Example: "satyams_42dcf9d5"

Try It Out

⚠️ Please enter your API key in the configuration section at the top of the page to test this endpoint.

session_id *(path parameter - string)

Responses

200Successfully retrieved chat session

{
  "success": true,
  "data": {
    "session_id": "session_001",
    "collection_id": "satyams_42dcf9d5",
    "plate_id": "137be5ec-7f10-4c8d-8237-f13149f6cd17",
    "title": "Medical Analysis Query",
    "messages": [
      {
        "message_id": "msg_001",
        "role": "user",
        "content": "What procedures are documented?",
        "timestamp": "2026-01-28T12:00:00Z"
      },
      {
        "message_id": "msg_002",
        "role": "assistant",
        "content": "The documentation includes 25 distinct medical procedures...",
        "timestamp": "2026-01-28T12:00:30Z"
      }
    ],
    "message_count": 8,
    "created_at": "2026-01-28T12:00:00Z",
    "updated_at": "2026-01-28T12:30:00Z"
  },
  "error": null
}

404Chat session not found

{
  "success": false,
  "error": "Chat session not found"
}

Example Request

curl -X GET "https://creativai-apis.com/testing/api/v2/chat/sessions/session_001?collection_id=satyams_42dcf9d5" \
  -H "x-api-key: your_api_key_here" \
  -H "Content-Type: application/json"