{
"openapi": "3.0.3",
"info": {
"title": "TIR API",
"description": "E2E TIR — the AI/ML platform: notebooks, foundation models, fine-tuning, inference endpoints, RAG, pipelines, and data.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.e2enetworks.com/myaccount/api/v1/gpu"
}
],
"tags": [
{
"name": "AI Labs"
},
{
"name": "Alerts Management"
},
{
"name": "Container Registry"
},
{
"name": "Data Syncer"
},
{
"name": "Dataset"
},
{
"name": "External Integration"
},
{
"name": "Fine Tune Models"
},
{
"name": "Gateway"
},
{
"name": "GenAI API"
},
{
"name": "IAM Users"
},
{
"name": "Instance/VM"
},
{
"name": "Model Endpoints"
},
{
"name": "Model Evaluation"
},
{
"name": "Model Repository"
},
{
"name": "PFS"
},
{
"name": "Pipeline"
},
{
"name": "Plans & Pricing"
},
{
"name": "Playground API"
},
{
"name": "Private Cluster"
},
{
"name": "RAG (Chat Assistant)"
},
{
"name": "RAG (Knowledge Base)"
},
{
"name": "Reserve IP"
},
{
"name": "Run"
},
{
"name": "SFS"
},
{
"name": "SKU"
},
{
"name": "Schedule Run"
},
{
"name": "Security"
},
{
"name": "Security Groups"
},
{
"name": "Training Cluster"
},
{
"name": "Vector Database"
}
],
"paths": {
"/gpu_service/image/": {
"get": {
"operationId": "get-gpu-service-image",
"summary": "Supported Images List",
"tags": [
"Instance/VM"
],
"description": "Returns all available notebook images and their versions. Use the `image_version_id` from the response when calling the SKU List API for notebooks.",
"parameters": [
{
"name": "category",
"in": "query",
"required": true,
"description": "category",
"schema": {
"type": "string",
"enum": [
"notebook"
]
}
},
{
"name": "is_advanced_search",
"in": "query",
"required": false,
"description": "Specifies if advanced filters should be applied.",
"schema": {
"type": "boolean"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "A list of available images with their details and versions",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 9
},
"name": {
"type": "string",
"example": "Transformers"
},
"slug_name": {
"type": "string",
"example": "nvidia-pytorch-transformers"
},
"versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_version_id": {
"type": "integer",
"example": 56
},
"version": {
"type": "string",
"example": "v4.45.2"
},
"cpu_image_url": {
"type": "string",
"nullable": true,
"example": "registry.e2enetworks.net/aimle2e/nvidia-pytorch-transformers:24.03-2.3.0-4.45.2"
},
"gpu_image_url": {
"type": "string",
"example": "registry.e2enetworks.net/aimle2e/nvidia-pytorch-transformers:24.03-2.3.0-4.45.2"
},
"description": {
"type": "string",
"example": "Transformers v4.45.2 with Python 3.10 and NVIDIA Cuda 12.4 pre-installed on Ubuntu 22.04"
}
}
}
},
"icon_url": {
"type": "string",
"example": "/notebook_images/hf-logo.png"
},
"description": {
"type": "string",
"example": "Transformers v4.31.0 with Python 3.10 and NVIDIA Cuda 12.1 pre-installed on Ubuntu 22.04"
}
}
}
}
}
}
}
}
}
}
}
},
"/notebooks/": {
"get": {
"operationId": "get-notebooks",
"summary": "Instance / VM List",
"tags": [
"Instance/VM"
],
"description": "Returns a paginated list of compute resources in the project.\n\nUse the `kind` query parameter to filter by compute type: pass `kind=vm` to return only Virtual Machines, or `kind=container` to return only container-based Instances. **You must also pass `is_advanced_search=true` for the `kind` filter to take effect** — without it, the filter is ignored and all resources are returned.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "kind",
"in": "query",
"required": false,
"description": "Filter results by compute type. Pass `kind=vm` to return only Virtual Machines, or `kind=container` to return only container-based Instances.\n\n**Important:** This filter only takes effect when `is_advanced_search=true` is also passed. Without it, the `kind` parameter is ignored and all resources are returned.",
"schema": {
"type": "string",
"enum": [
"vm",
"container"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "order_by",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"notebook"
]
}
},
{
"name": "is_advanced_search",
"in": "query",
"required": false,
"description": "Specifies if advanced filters should be applied.",
"schema": {
"type": "boolean"
}
},
{
"name": "instance_category",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"notebook"
]
}
},
{
"name": "name",
"in": "query",
"required": false,
"description": "Filter by name. **Requires `is_advanced_search=true`** to take effect.",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"required": false,
"description": "Filter by resource status. **Requires `is_advanced_search=true`** to take effect.",
"schema": {
"type": "string",
"enum": [
"ready",
"waiting",
"terminating",
"error",
"Pending",
"stopped"
]
}
},
{
"name": "custom",
"in": "query",
"required": false,
"description": "Filter by image type. **Requires `is_advanced_search=true`** to take effect.",
"schema": {
"type": "string",
"enum": [
"custom",
"pre-built"
]
}
},
{
"name": "sku series",
"in": "query",
"required": false,
"description": "Filter by SKU series. **Requires `is_advanced_search=true`** to take effect.",
"schema": {
"type": "string",
"enum": [
"CPU",
"GPU"
]
}
},
{
"name": "sku_type",
"in": "query",
"required": false,
"description": "Filter by SKU type. **Requires `is_advanced_search=true`** to take effect.",
"schema": {
"type": "string",
"enum": [
"hourly",
"committed"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with node details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4984
},
"name": {
"type": "string",
"example": "node-09161505088"
},
"project_id": {
"type": "integer",
"example": 124
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"image_details": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 14
},
"version_id": {
"type": "integer",
"example": 16
},
"name": {
"type": "string",
"example": "Ubuntu"
},
"icon_url": {
"type": "string",
"example": "/notebook_images/ubuntu.svg"
},
"image_description": {
"type": "string",
"example": "Ubuntu 22.04 base image with Python 3.10"
},
"version_description": {
"type": "string",
"example": "Ubuntu 22.04 base image with Python 3.10"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 4
},
"name": {
"type": "string",
"example": "C3.8GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 8
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 4
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 3.1
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
},
"status": {
"type": "string",
"example": "ready"
},
"last_activity": {
"type": "string",
"format": "date-time",
"example": "2024-09-16T09:35:18Z"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-09-16T09:35:18.580926Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T10:58:41.184577Z"
},
"lab_url": {
"type": "string",
"example": "https://notebooks.e2enetworks.com/notebook/p-124/n-7e940564-90f0-4e55-94f0-f67891aa0b68/lab"
},
"disk_size_in_gb": {
"type": "integer",
"example": 30
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"ssh_keys": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"disable_ssh_login_password": {
"type": "boolean",
"example": true
},
"public_ip": {
"type": "string",
"example": ""
},
"e2e_registry_image_url": {
"type": "string",
"nullable": true,
"example": null
},
"egress_gateway_ip": {
"type": "string",
"example": "116.204.174.167"
},
"add_ons": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"is_jupyterlab_enabled": {
"type": "boolean",
"example": true
},
"is_ssh_enabled": {
"type": "boolean",
"example": false
},
"custom_ports": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-notebooks",
"summary": "Create Instance / VM",
"tags": [
"Instance/VM"
],
"description": "Creates a new compute resource.\n\n**To create a Virtual Machine**, set `\"kind\": \"vm\"` in the request body along with `\"image_type\": \"pre-built\"` and a valid `sku_item_price_id` from the Plans List API.\n\nOmitting `kind` (or setting it to any other value) creates a container-based Instance.\n\nNote: `pfs_id`, `local_pv_id`, and `is_spot_instance` are not supported for VMs.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "node-111316563232"
},
"cluster_type": {
"type": "string",
"example": "tir-cluster"
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"is_jupyterlab_enabled": {
"type": "boolean",
"example": true
},
"notebook_type": {
"type": "string",
"example": "new"
},
"notebook_url": {
"type": "string",
"example": ""
},
"disk_size_in_gb": {
"type": "integer",
"example": 30
},
"dataset_id_list": {
"type": "array",
"items": {
"type": "integer"
},
"example": []
},
"enable_ssh": {
"type": "boolean",
"description": "Ignored by the backend. SSH access is determined solely by whether `public_key` is provided. Include this field for compatibility but it has no effect.",
"example": false
},
"add_ons": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"init_script_id_list": {
"type": "array",
"description": "List of initialization script IDs",
"items": {
"type": "integer"
},
"example": [
120
]
},
"sfs_path": {
"type": "string",
"example": "/mnt/sfs"
},
"image_version_id": {
"type": "integer",
"example": 59
},
"sku_id": {
"type": "integer",
"example": 4
},
"sku_item_price_id": {
"type": "integer",
"example": 4
},
"app_id": {
"type": "integer",
"example": 1
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"kind": {
"type": "string",
"description": "Set to `\"vm\"` to create a full OS Virtual Machine instead of a container-based Instance. Omit or leave empty for Instances.",
"enum": [
"vm"
],
"example": "vm"
},
"public_key": {
"type": "array",
"description": "SSH public key strings to authorize at creation time. **The key must already be saved in your TIR account** (via Security → SSH Keys) — the backend looks up keys by exact string match against your saved keys. Providing an unregistered key string is silently ignored and SSH will remain disabled. This is the only way to enable SSH; `enable_ssh` has no effect.",
"items": {
"type": "string"
},
"example": [
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIGEGHcYy..."
]
},
"security_group_id": {
"type": "integer",
"description": "ID of a Security Group to attach at creation time.",
"example": 11442
},
"is_pvc_encrypted": {
"type": "boolean",
"description": "Whether to encrypt the workspace disk. Defaults to false.",
"example": false
},
"pfs_path": {
"type": "string",
"description": "Mount path for Parallel File Storage (not supported for VMs).",
"example": "/mnt/pfs"
},
"pfs_read_only": {
"type": "boolean",
"description": "Whether to mount PFS in read-only mode (not supported for VMs).",
"example": false
}
}
}
}
}
},
"responses": {
"201": {
"description": "Node created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5633
},
"name": {
"type": "string",
"example": "node-11131656asd3232"
},
"project_id": {
"type": "integer",
"example": 124
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"image_details": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 9
},
"version_id": {
"type": "integer",
"example": 56
},
"name": {
"type": "string",
"example": "Transformers"
},
"icon_url": {
"type": "string",
"example": "/notebook_images/hf-logo.png"
},
"image_description": {
"type": "string",
"example": "Transformers v4.31.0 with Python 3.10 and NVIDIA Cuda 12.1 pre-installed on Ubuntu 22.04"
},
"version_description": {
"type": "string",
"example": "Transformers v4.45.2 with Python 3.10 and NVIDIA Cuda 12.4 pre-installed on Ubuntu 22.04"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 4
},
"name": {
"type": "string",
"example": "C3.8GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 8
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 4
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 3.1
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
},
"status": {
"type": "string",
"example": "waiting"
},
"last_activity": {
"type": "string",
"nullable": true,
"format": "date-time",
"example": null
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T11:30:13.267193Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T11:30:13.327815Z"
},
"lab_url": {
"type": "string",
"nullable": true,
"example": null
},
"disk_size_in_gb": {
"type": "integer",
"example": 30
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"ssh_keys": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"disable_ssh_login_password": {
"type": "boolean",
"example": true
},
"public_ip": {
"type": "string",
"example": ""
},
"e2e_registry_image_url": {
"type": "string",
"nullable": true,
"example": null
},
"egress_gateway_ip": {
"type": "string",
"example": "116.204.174.145"
},
"add_ons": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"is_jupyterlab_enabled": {
"type": "boolean",
"example": true
},
"is_ssh_enabled": {
"type": "boolean",
"example": false
},
"custom_ports": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/actions/": {
"put": {
"operationId": "put-notebooks-instance-id-actions",
"summary": "Start-Stop/Attach-Detach ReserveIp",
"tags": [
"Instance/VM"
],
"description": "Perform lifecycle actions on an Instance or Virtual Machine using the `action` query parameter.\n\n**For Virtual Machines**, use `action=start`, `action=stop`, or `action=restart`. Startup scripts run automatically on every boot.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"enum": [
"Start",
"Stop",
"Restart",
"attach_reserve_ip",
"detach_reserve_ip"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reserved_ip_id": {
"type": "integer",
"example": 49
}
},
"required": [
"reserved_ip_id"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Notebook started or stopped successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Notebook stopped/started successfully"
},
"data": {
"type": "object",
"properties": {},
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/save_image/": {
"post": {
"operationId": "post-notebooks-instance-id-save-image",
"summary": "Save Image",
"tags": [
"Instance/VM"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"registry_namespace_id": {
"type": "integer",
"description": "ID of the container registry namespace where the image will be stored",
"example": 123
},
"image_name": {
"type": "string",
"description": "Name of the image to be saved",
"example": "nginx"
},
"image_tag": {
"type": "string",
"description": "Tag assigned to the saved image",
"example": "v2"
}
}
},
"example": {
"registry_namespace_id": 123,
"image_name": "nginx",
"image_tag": "v2"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Image saved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 804
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4946
},
"name": {
"type": "string",
"example": "Tushar Tushar"
},
"email": {
"type": "string",
"example": "tushar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "tushar@e2enetworks.com"
}
}
},
"notebook_id": {
"type": "integer",
"example": 18783
},
"image_name": {
"type": "string",
"example": "nginx"
},
"image_tag": {
"type": "string",
"example": "v2"
},
"e2e_registry_id": {
"type": "integer",
"example": 646
},
"e2e_registry_name": {
"type": "string",
"example": "rajcr03"
},
"status": {
"type": "string",
"example": "Building"
},
"created_at": {
"type": "string",
"example": "2026-03-09T05:13:31.301049Z"
},
"size": {
"type": "integer",
"nullable": true,
"example": null
},
"app": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3
},
"name": {
"type": "string",
"example": "jupyter_labs"
},
"app_url": {
"type": "string",
"example": "/lab"
},
"icon_url": {
"type": "string",
"example": ""
},
"is_ssh_required": {
"type": "boolean",
"example": false
},
"display_name": {
"type": "string",
"example": "Jupyter Labs"
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/pvc/upgrade/": {
"put": {
"operationId": "put-notebooks-instance-id-pvc-upgrade",
"summary": "Increase Disk Size",
"tags": [
"Instance/VM"
],
"description": "Increases the workspace disk size. Disk size can only be increased, not reduced. Works for both Instances and Virtual Machines.\n\n**For Virtual Machines**: after resizing, the new storage is not automatically visible inside the VM. To apply the new size, either restart the VM or run these commands while it is running: ``` sudo partprobe && sudo growpart /dev/vda 1 && sudo resize2fs /dev/vda1 ```",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "The size value"
}
},
"example": {
"size": 76
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Disk size upgraded successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Disk Size upgraded successfully. It can take a few minutes for the changes to get reflected"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5632
},
"name": {
"type": "string",
"example": "node-111316563232"
},
"project_id": {
"type": "integer",
"example": 124
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"image_details": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 9
},
"version_id": {
"type": "integer",
"example": 56
},
"name": {
"type": "string",
"example": "Transformers"
},
"icon_url": {
"type": "string",
"example": "/notebook_images/hf-logo.png"
},
"image_description": {
"type": "string",
"example": "Transformers v4.31.0 with Python 3.10 and NVIDIA Cuda 12.1 pre-installed on Ubuntu 22.04"
},
"version_description": {
"type": "string",
"example": "Transformers v4.45.2 with Python 3.10 and NVIDIA Cuda 12.4 pre-installed on Ubuntu 22.04"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 4
},
"name": {
"type": "string",
"example": "C3.8GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 8
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 4
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 3.1
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
},
"status": {
"type": "string",
"example": "ready"
},
"last_activity": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T11:27:27Z"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T11:27:27.186708Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T11:42:32.188962Z"
},
"lab_url": {
"type": "string",
"example": "https://notebooks.e2enetworks.com/notebook/p-124/n-3cadd904-9532-4f91-a865-85e8b1509699/lab"
},
"disk_size_in_gb": {
"type": "integer",
"example": 31
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"ssh_keys": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"disable_ssh_login_password": {
"type": "boolean",
"example": true
},
"public_ip": {
"type": "string",
"example": ""
},
"e2e_registry_image_url": {
"type": "string",
"nullable": true,
"example": null
},
"egress_gateway_ip": {
"type": "string",
"example": "116.204.174.139"
},
"add_ons": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"is_jupyterlab_enabled": {
"type": "boolean",
"example": true
},
"is_ssh_enabled": {
"type": "boolean",
"example": false
},
"custom_ports": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/events/": {
"get": {
"operationId": "get-notebooks-instance-id-events",
"summary": "Events Log",
"tags": [
"Instance/VM"
],
"description": "Returns a chronological log of lifecycle events for an Instance or Virtual Machine. Use this to debug startup failures or track activity.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Lifecycle events log for an Instance or Virtual Machine",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event_type": {
"type": "string",
"example": "VM_STARTED"
},
"message": {
"type": "string",
"example": "VM started successfully"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2025-04-10T09:00:00Z"
},
"reason": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/security-groups/": {
"get": {
"operationId": "get-notebooks-instance-id-security-groups",
"summary": "List Security Groups",
"tags": [
"Instance/VM"
],
"description": "Returns all Security Groups attached to the Instance or Virtual Machine.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "List of Security Groups attached to the Instance or Virtual Machine",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 45
},
"name": {
"type": "string",
"example": "allow-ssh"
},
"description": {
"type": "string",
"example": "Allows inbound SSH on port 22"
}
}
}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-notebooks-instance-id-security-groups",
"summary": "Attach Security Group",
"tags": [
"Instance/VM"
],
"description": "Attaches one or more Security Groups to the Instance or Virtual Machine.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"security_groups_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
0,
0
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Security group added successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Security group addition successful"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/security-groups/{security_group_id}/": {
"delete": {
"operationId": "delete-notebooks-instance-id-security-groups-security-group-id",
"summary": "Detach Security Group",
"tags": [
"Instance/VM"
],
"description": "Removes a Security Group from the Instance or Virtual Machine.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "security_group_id",
"in": "path",
"required": true,
"description": "Security Group ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Security group removed successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Security group removal successful"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/ssh-keys/": {
"get": {
"operationId": "get-notebooks-instance-id-ssh-keys",
"summary": "List SSH Keys",
"tags": [
"Instance/VM"
],
"description": "Returns the SSH public keys currently authorized to access the Instance or Virtual Machine.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "List of authorized SSH keys",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"type": "string",
"example": "my-laptop-key"
},
"public_key": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB..."
}
}
}
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-notebooks-instance-id-ssh-keys",
"summary": "Add SSH key",
"tags": [
"Instance/VM"
],
"description": "Adds SSH public keys to an Instance or Virtual Machine. Key changes take effect within seconds — no restart required.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ssh_keys_to_add": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of SSH keys to be added"
}
},
"example": {
"ssh_keys_to_add": [
"ssh-rsa AAAAB3NzaC1yc2..........................Enjr.local"
]
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Operation successful, but no data returned",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {},
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-notebooks-instance-id-ssh-keys",
"summary": "Remove SSH Access",
"tags": [
"Instance/VM"
],
"description": "Removes all SSH keys from the Instance or Virtual Machine, disabling SSH access.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
}
},
"/notebooks/{Instance_id}/": {
"get": {
"operationId": "get-notebooks-instance-id",
"summary": "Get Instance / VM Details",
"tags": [
"Instance/VM"
],
"description": "Returns full details of an Instance or Virtual Machine, including SSH keys, security groups, startup scripts, and attached datasets. For Virtual Machines, also returns the public IP and any reserved IP details.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Full details of an Instance or Virtual Machine",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5633
},
"name": {
"type": "string",
"example": "my-gpu-vm"
},
"kind": {
"type": "string",
"example": "vm"
},
"status": {
"type": "string",
"enum": [
"waiting",
"running",
"stopped",
"error"
],
"example": "running"
},
"public_ip": {
"type": "string",
"nullable": true,
"example": "203.0.113.42"
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"image_details": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Ubuntu"
},
"icon_url": {
"type": "string",
"example": "/notebook_images/ubuntu.svg"
},
"image_description": {
"type": "string",
"example": "Ubuntu 22.04 base image with Python 3.10"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "GDC.1xH100-SXM5-80GB"
},
"cpu": {
"type": "integer",
"example": 26
},
"gpu": {
"type": "integer",
"example": 1
},
"memory": {
"type": "string",
"example": "240GB"
}
}
}
}
},
"disk_size_in_gb": {
"type": "integer",
"example": 100
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"ssh_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"type": "string",
"example": "my-laptop-key"
}
}
}
},
"security_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 45
},
"name": {
"type": "string",
"example": "allow-ssh"
}
}
}
},
"init_scripts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 8
},
"name": {
"type": "string",
"example": "01_install.sh"
}
}
}
},
"reserve_ip": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 99
},
"ip_address": {
"type": "string",
"example": "203.0.113.42"
}
}
}
},
"custom_ports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"protocol": {
"type": "string",
"example": "TCP"
},
"port": {
"type": "integer",
"example": 8888
}
}
}
},
"is_pvc_encrypted": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-04-10T08:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-04-10T09:00:00Z"
}
}
}
}
}
}
}
},
"404": {
"description": "Instance or VM not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 404
},
"message": {
"type": "string",
"example": "Not found"
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-notebooks-instance-id",
"summary": "Update Plan",
"tags": [
"Instance/VM"
],
"description": "Upgrade or downgrade the hardware plan (SKU) of an Instance or Virtual Machine. The resource must be stopped before changing its plan.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cluster_type": {
"type": "string",
"description": "The type of the cluster"
},
"sku_id": {
"type": "integer",
"description": "The SKU ID"
},
"sku_item_price_id": {
"type": "integer",
"description": "The SKU item price ID"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Notebook details retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5633
},
"name": {
"type": "string",
"example": "node-11131656asd3232"
},
"project_id": {
"type": "integer",
"example": 124
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"image_details": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 9
},
"version_id": {
"type": "integer",
"example": 56
},
"name": {
"type": "string",
"example": "Transformers"
},
"icon_url": {
"type": "string",
"example": "/notebook_images/hf-logo.png"
},
"image_description": {
"type": "string",
"example": "Transformers v4.31.0 with Python 3.10 and NVIDIA Cuda 12.1 pre-installed on Ubuntu 22.04"
},
"version_description": {
"type": "string",
"example": "Transformers v4.45.2 with Python 3.10 and NVIDIA Cuda 12.4 pre-installed on Ubuntu 22.04"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 4
},
"name": {
"type": "string",
"example": "C3.8GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 8
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 5
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 3.1
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
},
"status": {
"type": "string",
"example": "stopped"
},
"last_activity": {
"type": "string",
"nullable": true,
"example": null
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T11:30:13.267193Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-13T12:04:13.981427Z"
},
"lab_url": {
"type": "string",
"nullable": true,
"example": null
},
"disk_size_in_gb": {
"type": "integer",
"example": 30
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"ssh_keys": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"disable_ssh_login_password": {
"type": "boolean",
"example": true
},
"public_ip": {
"type": "string",
"example": ""
},
"e2e_registry_image_url": {
"type": "string",
"nullable": true,
"example": null
},
"egress_gateway_ip": {
"type": "string",
"example": "116.204.174.145"
},
"add_ons": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"is_jupyterlab_enabled": {
"type": "boolean",
"example": true
},
"is_ssh_enabled": {
"type": "boolean",
"example": false
},
"custom_ports": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-notebooks-instance-id",
"summary": "Delete Instance / VM",
"tags": [
"Instance/VM"
],
"description": "Permanently deletes the Instance or Virtual Machine and its workspace disk. **This action cannot be undone.** Back up any important data before deleting.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Notebook deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Notebook deleted successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/metrics/gauge/all/": {
"get": {
"operationId": "get-notebooks-instance-id-metrics-gauge-all",
"summary": "Monitoring",
"tags": [
"Instance/VM"
],
"description": "Returns current resource utilization metrics. Works for both Instances and Virtual Machines — returns CPU, memory, and GPU utilization.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Node metrics retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"pvc_metrics": {
"type": "object",
"properties": {
"pvc_capacity": {
"type": "string",
"example": "29412593664"
},
"used_pvc_storage": {
"type": "string",
"example": "57860096"
}
}
},
"memory_metrics": {
"type": "object",
"properties": {
"memory_capacity": {
"type": "string",
"example": "15998753178"
},
"used_memory_capacity": {
"type": "string",
"example": "117813248"
}
}
},
"ephemeral_storage_metrics": {
"type": "object",
"properties": {
"ephemeral_storage_capacity": {
"type": "string",
"example": "50000000000"
},
"used_ephemeral_storage": {
"type": "string",
"example": "868352"
}
}
},
"gpu_metrics": {
"type": "object",
"properties": {
"avg_gpu_utilization": {
"type": "string",
"nullable": true,
"example": ""
},
"avg_gpu_temperature": {
"type": "string",
"nullable": true,
"example": ""
},
"avg_gpu_power": {
"type": "string",
"nullable": true,
"example": ""
},
"used_gpu_memory": {
"type": "string",
"nullable": true,
"example": ""
},
"total_gpu_memory": {
"type": "string",
"nullable": true,
"example": ""
}
}
},
"cpu_metrics": {
"type": "object",
"properties": {
"avg_cpu_utilization": {
"type": "string",
"example": "0.14139347820001158"
},
"avg_memory_utilization": {
"type": "string",
"example": "0.5931316606002083"
},
"uptime": {
"type": "string",
"example": "136.91499996185303"
}
}
},
"gpu_performance_metrics": {
"type": "object",
"properties": {
"avg_memory_bandwidth": {
"type": "string",
"nullable": true,
"example": ""
},
"avg_tensor_throughput": {
"type": "string",
"nullable": true,
"example": ""
},
"pcie_throughput": {
"type": "string",
"nullable": true,
"example": ""
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/metrics/container_cpu_usage_seconds_total/": {
"get": {
"operationId": "get-notebooks-instance-id-metrics-container-cpu-usage-seconds-total",
"summary": "CPU Utilization",
"tags": [
"Instance/VM"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "interval",
"in": "query",
"required": true,
"description": "Interval for the data",
"schema": {
"type": "string",
"enum": [
"5m",
"1h",
"1d",
"7d",
"1mn"
]
},
"example": "5m for 5min ,1h for 1 hour, 1d for 1 day, 7d for 7 days, 1mn for 1 month"
}
],
"responses": {
"200": {
"description": "Time series metrics retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"11:58:48AM",
"11:59:03AM",
"11:59:18AM",
"11:59:33AM",
"11:59:48AM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"0.032537415427217456",
"0.03272080373466566",
"0.032955218299105596",
"0.033358756045318946",
"0.03358186154866349"
]
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/metrics/container_memory_usage_bytes/": {
"get": {
"operationId": "get-notebooks-instance-id-metrics-container-memory-usage-bytes",
"summary": "Memory Utilization",
"tags": [
"Instance/VM"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "interval",
"in": "query",
"required": true,
"description": "Interval for the data",
"schema": {
"type": "string",
"enum": [
"5m",
"1h",
"1d",
"7d",
"1mn"
]
},
"example": "5m for 5min ,1h for 1 hour, 1d for 1 day, 7d for 7 days, 1mn for 1 month"
}
],
"responses": {
"200": {
"description": "Node memory usage time-series metrics retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"11:58:35AM",
"11:58:50AM",
"11:59:05AM",
"11:59:20AM",
"11:59:35AM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"96182272",
"96309248",
"96313344",
"96313344",
"96313344"
]
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/notebooks/init-script/": {
"get": {
"operationId": "get-notebooks-init-script",
"summary": "Get Start Scripts",
"tags": [
"Instance/VM"
],
"description": "Returns all startup scripts in the project. These scripts run automatically on every Instance or Virtual Machine boot, in alphabetical order by name.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Start script listed successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 172
},
"name": {
"type": "string",
"example": "Instance-script-25111112519"
},
"init_script": {
"type": "string",
"example": "# !/bin/bash\nsudo apt update -y\n"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12477
},
"name": {
"type": "string",
"example": "Raj Singh"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-notebooks-init-script",
"summary": "Create Start Script",
"tags": [
"Instance/VM"
],
"description": "Creates a new startup script. Scripts run on every boot in alphabetical order. Use prefixes like `01_install.sh`, `02_setup.sh` for reliable ordering. Works for both Instances and Virtual Machines.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the start script"
},
"init_script": {
"type": "string",
"description": "The start script content"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Start script created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 177
},
"name": {
"type": "string",
"example": "test-script-1"
},
"init_script": {
"type": "string",
"example": "# !/bin/bash\nsudo apt update -y\n"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12477
},
"name": {
"type": "string",
"example": "Raj Singh"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/init-script/{Start_Script_Id}/": {
"put": {
"operationId": "put-notebooks-init-script-start-script-id",
"summary": "Update Start Script",
"tags": [
"Instance/VM"
],
"description": "Updates the name or content of a startup script. Works for both Instances and Virtual Machines.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Start_Script_Id",
"in": "path",
"required": true,
"description": "Start Script Id",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The updated name of the start script"
},
"init_script": {
"type": "string",
"description": "The updated start script content"
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "Successful response"
}
}
},
"delete": {
"operationId": "delete-notebooks-init-script-start-script-id",
"summary": "Delete Start Script",
"tags": [
"Instance/VM"
],
"description": "Permanently deletes a startup script. It will no longer run on boot. Works for both Instances and Virtual Machines.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Start_Script_Id",
"in": "path",
"required": true,
"description": "Start Script Id",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Start script deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Init Script deleted successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/init-script/": {
"put": {
"operationId": "put-notebooks-instance-id-init-script",
"summary": "Attach Startup Scripts to Instance / VM",
"tags": [
"Instance/VM"
],
"description": "Attaches one or more startup scripts to a specific Instance or Virtual Machine. Scripts run on every boot in alphabetical order by name.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the start script"
},
"init_script": {
"type": "string",
"description": "The start script content"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Start script updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 177
},
"name": {
"type": "string",
"example": "Instance-fds-25111112519"
},
"init_script": {
"type": "string",
"example": "# !/bin/bash\nsudo apt updafste -y\nfasdfasdf\n"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12477
},
"name": {
"type": "string",
"example": "Raj Singh"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/alerts/": {
"get": {
"operationId": "get-notebooks-instance-id-alerts",
"summary": "Notebook Alerts List",
"tags": [
"Instance/VM"
],
"description": "Retrieve all alerts attached to a specific notebook instance with pagination support.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response with notebook alerts list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 19
},
"notebook": {
"type": "integer",
"example": 19919
},
"notebook_name": {
"type": "string",
"example": "instance-name"
},
"alert": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 57
},
"name": {
"type": "string",
"example": "alert-name"
},
"location": {
"type": "string",
"example": "Delhi"
},
"resource_type": {
"type": "string",
"example": "Instance"
},
"metric_type": {
"type": "string",
"example": "Ephemeral Storage"
},
"metric_type_unit": {
"type": "string",
"example": "%"
},
"operator": {
"type": "string",
"example": "Less Than"
},
"threshold_value": {
"type": "number",
"format": "float",
"example": 23
},
"severity": {
"type": "string",
"example": "Warning"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:04:09Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:04:09Z"
}
}
},
"alert_name": {
"type": "string",
"example": "alert-name"
},
"grafana_rule_uid": {
"type": "string",
"example": "bfh2k92v7tb0ge"
},
"is_firing": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:42:31Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:42:31Z"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-notebooks-instance-id-alerts",
"summary": "Attach Alert",
"tags": [
"Instance/VM"
],
"description": "Attach an existing alert to a notebook instance.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"alert_id": {
"type": "integer",
"description": "Alert ID to be attached to the notebook",
"example": 57
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Alert attached successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 18
},
"notebook": {
"type": "integer",
"example": 19919
},
"notebook_name": {
"type": "string",
"example": "instance-26032514331"
},
"alert": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 57
},
"name": {
"type": "string",
"example": "alert-260325143350"
},
"location": {
"type": "string",
"example": "Delhi"
},
"resource_type": {
"type": "string",
"example": "Instance"
},
"metric_type": {
"type": "string",
"example": "Ephemeral Storage"
},
"metric_type_unit": {
"type": "string",
"example": "%"
},
"operator": {
"type": "string",
"example": "Less Than"
},
"threshold_value": {
"type": "number",
"format": "float",
"example": 23
},
"severity": {
"type": "string",
"example": "Warning"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:04:09Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:04:09Z"
}
}
},
"alert_name": {
"type": "string",
"example": "alert-260325143350"
},
"grafana_rule_uid": {
"type": "string",
"example": "efh2jjjodxq80c"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:34:34Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T09:34:34Z"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/notebooks/{Instance_id}/alerts/{alert_id}/": {
"delete": {
"operationId": "delete-notebooks-instance-id-alerts-alert-id",
"summary": "Detach Alert",
"tags": [
"Instance/VM"
],
"description": "Detach an alert from a notebook instance.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Instance_id",
"in": "path",
"required": true,
"description": "Instance ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "alert_id",
"in": "path",
"required": true,
"description": "Alert ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Notebook alert detached successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Notebook alert detached successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/datasets/": {
"get": {
"operationId": "get-datasets",
"summary": "List Datasets",
"tags": [
"Dataset"
],
"description": "Retrieve a list of all datasets in the project with filtering and pagination options",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "is_advanced_search",
"in": "query",
"required": false,
"description": "Specifies if advanced filters should be applied.",
"schema": {
"type": "boolean"
}
},
{
"name": "storage_type",
"in": "query",
"required": false,
"description": "Storage Type",
"schema": {
"type": "string",
"enum": [
"managed,e2e_s3",
"pvc"
]
}
},
{
"name": "encrypted",
"in": "query",
"required": false,
"description": "Encryption",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Success response with dataset information.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the dataset.",
"example": 1306
},
"name": {
"type": "string",
"description": "Name of the dataset.",
"example": "tir-dataset-111415255656"
},
"project_id": {
"type": "integer",
"description": "ID of the project associated with the dataset.",
"example": 124
},
"description": {
"type": "string",
"description": "Description of the dataset, which is null in this case.",
"nullable": true
},
"storage_type": {
"type": "string",
"description": "Type of storage used for the dataset.",
"example": "managed"
},
"pvc": {
"type": "string",
"description": "Persistent volume claim (PVC) details, which is null in this case.",
"nullable": true
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the bucket.",
"example": 2519
},
"bucket_name": {
"type": "string",
"description": "Name of the storage bucket.",
"example": "d-gpu-eec9c7b5-be21-4303-ad86-78fa3b2ba284"
},
"bucket_url": {
"type": "string",
"description": "URL of the bucket.",
"example": "s3://d-gpu-eec9c7b5-be21-4303-ad86-78fa3b2ba284/"
},
"endpoint": {
"type": "string",
"description": "Endpoint URL of the object store.",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"description": "Whether the bucket is managed.",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"description": "EOS bucket permission ID.",
"example": 10205
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the access key.",
"example": 2536
},
"access_key": {
"type": "string",
"description": "The access key.",
"example": "CKEAFAC2WW1R3CRM4YR2"
},
"secret_key": {
"type": "string",
"description": "The secret key for accessing the bucket.",
"example": "X8PB1JFEYIFP1LZIRKPKYBDSCD57R15A9CMGD6UP"
},
"tag": {
"type": "string",
"description": "A tag associated with the access key.",
"example": "akgpu6bdbe89619c949d382acf141fb76c204"
},
"is_managed": {
"type": "boolean",
"description": "Whether the access key is managed.",
"example": true
}
}
},
"encryption_type": {
"type": "string",
"description": "Type of encryption used, which is null in this case.",
"nullable": true
},
"encryption_enable": {
"type": "boolean",
"description": "Whether encryption is enabled for the dataset.",
"example": false
},
"status": {
"type": "string",
"description": "Status of the dataset.",
"example": "OK"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User ID of the creator.",
"example": 3573
},
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Nipun"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator.",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the dataset was created.",
"example": "2024-11-14T09:56:02.477591Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the dataset was last updated.",
"example": "2024-11-14T09:56:02.477647Z"
}
}
}
},
"errors": {
"type": "object",
"description": "Any errors encountered during the operation.",
"example": {}
},
"message": {
"type": "string",
"description": "Message indicating the result of the operation.",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"description": "Total number of pages of dataset information available.",
"example": 1
},
"total_count": {
"type": "integer",
"description": "Total number of datasets returned.",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-datasets",
"summary": "Create Dataset",
"tags": [
"Dataset"
],
"description": "Create a new dataset with one of three storage types:\n- **managed**: System creates and manages a new EOS bucket\n- **existing_bucket**: Connect to an existing EOS bucket with provided credentials\n- **pvc**: Create a dataset with disk storage \n\nOptionally supports encryption (SSE-KMS or SSE-C) for managed and existing_bucket types.\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the dataset"
},
"storage_type": {
"type": "string",
"enum": [
"managed",
"pvc",
"existing_bucket"
],
"description": "Type of storage for the dataset"
},
"pvc": {
"type": "object",
"description": "PVC configuration, required if storage_type is pvc",
"properties": {
"disk_size": {
"type": "integer",
"description": "Disk size for the PVC in GB"
},
"pvc_type": {
"type": "string",
"description": "Type of the PVC"
}
},
"required": [
"disk_size",
"pvc_type"
]
},
"bucket": {
"type": "object",
"description": "Bucket configuration, required if storage_type is existing_bucket",
"properties": {
"bucket_name": {
"type": "string",
"description": "Name of the existing bucket"
},
"endpoint": {
"type": "string",
"description": "Endpoint URL of the object store"
}
},
"required": [
"bucket_name",
"endpoint"
]
},
"access_key": {
"type": "object",
"description": "Access key configuration, required if storage_type is existing_bucket",
"properties": {
"access_key": {
"type": "string",
"description": "Access key for the bucket"
},
"secret_key": {
"type": "string",
"description": "Secret key for the bucket"
}
},
"required": [
"access_key",
"secret_key"
]
},
"encryption_enable": {
"type": "boolean",
"description": "Whether to enable encryption",
"default": false
},
"encryption_type": {
"type": "string",
"enum": [
"sse-kms",
"sse-c"
],
"description": "Type of encryption to use (required if encryption_enable is true):\n- sse-kms: Server-side encryption with KMS (E2E managed)\n- sse-c: Server-side encryption with customer-provided keys (user managed)\n"
},
"description": {
"type": "string",
"description": "Optional description of the dataset"
}
},
"required": [
"name",
"storage_type"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Success response indicating that the dataset was created.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the dataset.",
"example": 1310
},
"name": {
"type": "string",
"description": "Name of the dataset.",
"example": "eos-bucket"
},
"project_id": {
"type": "integer",
"description": "ID of the project associated with the dataset.",
"example": 124
},
"description": {
"type": "string",
"description": "Description of the dataset, which is null in this case.",
"nullable": true
},
"storage_type": {
"type": "string",
"description": "Type of storage used for the dataset.",
"example": "managed"
},
"pvc": {
"type": "string",
"description": "Persistent volume claim (PVC) details, which is null in this case.",
"nullable": true
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the bucket.",
"example": 2525
},
"bucket_name": {
"type": "string",
"description": "Name of the storage bucket.",
"example": "d-gpu-b4273173-e5ab-4a85-ad89-dc8d6e698a93"
},
"bucket_url": {
"type": "string",
"description": "URL of the bucket.",
"example": "s3://d-gpu-b4273173-e5ab-4a85-ad89-dc8d6e698a93/"
},
"endpoint": {
"type": "string",
"description": "Endpoint URL of the object store.",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"description": "Whether the bucket is managed.",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"description": "EOS bucket permission ID.",
"example": 10214
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier for the access key.",
"example": 2542
},
"access_key": {
"type": "string",
"description": "The access key.",
"example": "FWXL9EZZWS4BBSX9512V"
},
"secret_key": {
"type": "string",
"description": "The secret key for accessing the bucket.",
"example": "ZB3PM8XBNQGG4PFVDEI5915IO1TZHCFGEIO2LID9"
},
"tag": {
"type": "string",
"description": "A tag associated with the access key.",
"example": "akgpu50a522c13dcd4708a5dbf6ae3da98bfa"
},
"is_managed": {
"type": "boolean",
"description": "Whether the access key is managed.",
"example": true
}
}
},
"encryption_type": {
"type": "string",
"description": "Type of encryption used, which is null in this case.",
"nullable": true
},
"encryption_enable": {
"type": "boolean",
"description": "Whether encryption is enabled for the dataset.",
"example": false
},
"status": {
"type": "string",
"description": "Status of the dataset.",
"example": "Pending"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User ID of the creator.",
"example": 3573
},
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Nipun"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator.",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the dataset was created.",
"example": "2024-11-14T12:57:36.293942Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when the dataset was last updated.",
"example": "2024-11-14T12:57:36.293994Z"
}
}
},
"errors": {
"type": "object",
"description": "Any errors encountered during the operation.",
"example": {}
},
"message": {
"type": "string",
"description": "Message indicating the result of the operation.",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/datasets/{Dataset_Id}/objects/": {
"get": {
"operationId": "get-datasets-dataset-id-objects",
"summary": "Get EOS Data Objects",
"tags": [
"Dataset"
],
"parameters": [
{
"name": "Dataset_Id",
"in": "path",
"required": true,
"description": "dataset id",
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with no data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "array",
"description": "An empty array indicating no results.",
"items": {
"type": "object"
},
"example": []
},
"errors": {
"type": "object",
"description": "Any errors encountered during the operation.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message of the operation.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/datasets/{Dataset_Id}/lifecycle-rule/": {
"get": {
"operationId": "get-datasets-dataset-id-lifecycle-rule",
"summary": "Get Lifecycle Rules",
"tags": [
"Dataset"
],
"description": "Retrieve lifecycle rules configured for the dataset's EOS bucket.\nOnly applicable for datasets with storage_type 'managed' or 'existing_bucket'.\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Dataset_Id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success response with lifecycle rule list.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1711
},
"deleted": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T10:43:25.612412Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T10:43:25.612430Z"
},
"rule_id": {
"type": "string",
"example": "b0c6b464474f45eebcd626058ac637e7"
},
"enabled": {
"type": "boolean",
"example": true
},
"prefix": {
"type": "string",
"example": ""
},
"expiry_date_or_days": {
"type": "string",
"example": "1"
},
"noncurrent_version_expiration_date_or_days": {
"type": "string",
"example": ""
},
"transition": {
"type": "string",
"example": ""
},
"storage_class": {
"type": "string",
"example": ""
},
"tags": {
"type": "string",
"example": ""
},
"location": {
"type": "string",
"example": "Delhi"
},
"bucket": {
"type": "integer",
"example": 16731
},
"user": {
"type": "integer",
"example": 32970
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-datasets-dataset-id-lifecycle-rule",
"summary": "Create Lifecycle Rule",
"tags": [
"Dataset"
],
"description": "Create a lifecycle rule for automatic object expiration in the dataset's EOS bucket.\nRules can be applied to all objects or to objects with a specific prefix.\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Dataset_Id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apply_to": {
"type": "string",
"enum": [
"all_objects",
"objects_with_prefix"
],
"description": "Scope of the lifecycle rule:\n- all_objects: Apply rule to all objects in the bucket\n- objects_with_prefix: Apply rule only to objects with the specified prefix\n"
},
"expiration_days": {
"type": "string",
"description": "Number of days after which objects will be deleted"
},
"prefix": {
"type": "string",
"description": "Object prefix/folder path (required when apply_to is objects_with_prefix)"
}
},
"required": [
"apply_to",
"expiration_days"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success response with lifecycle rules information.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code.",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the lifecycle rule.",
"example": 1711
},
"deleted": {
"type": "boolean",
"description": "Indicates whether the rule is deleted.",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Rule creation timestamp.",
"example": "2026-02-05T10:43:25.612412Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Rule last updated timestamp.",
"example": "2026-02-05T10:43:25.612430Z"
},
"rule_id": {
"type": "string",
"description": "Unique lifecycle rule identifier.",
"example": "b0c6b464474f45eebcd626058ac637e7"
},
"enabled": {
"type": "boolean",
"description": "Whether the lifecycle rule is enabled.",
"example": true
},
"prefix": {
"type": "string",
"description": "Object prefix the rule applies to.",
"example": ""
},
"expiry_date_or_days": {
"type": "string",
"description": "Expiry date or number of days.",
"example": "1"
},
"noncurrent_version_expiration_date_or_days": {
"type": "string",
"description": "Expiry for non-current object versions.",
"example": ""
},
"transition": {
"type": "string",
"description": "Transition rule definition.",
"example": ""
},
"storage_class": {
"type": "string",
"description": "Storage class for transition.",
"example": ""
},
"tags": {
"type": "string",
"description": "Tags associated with the rule.",
"example": ""
},
"location": {
"type": "string",
"description": "Bucket location.",
"example": "Delhi"
},
"bucket": {
"type": "integer",
"description": "Associated bucket ID.",
"example": 16731
},
"user": {
"type": "integer",
"description": "User ID who created the rule.",
"example": 32970
}
}
}
},
"errors": {
"type": "object",
"description": "Errors encountered during the operation.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/datasets/{Dataset_Id}/lifecycle-rule/{rule_id}/": {
"delete": {
"operationId": "delete-datasets-dataset-id-lifecycle-rule-rule-id",
"summary": "Delete Lifecycle Rule",
"tags": [
"Dataset"
],
"description": "Delete a lifecycle rule from the dataset's EOS bucket.\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Dataset_Id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "rule_id",
"in": "path",
"required": true,
"description": "ID of the lifecycle rule to delete",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success response for lifecycle rule deletion.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Lifecycle rule deleted successfully"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/datasets/{Dataset_Id}/": {
"put": {
"operationId": "put-datasets-dataset-id",
"summary": "Increase Disk size",
"tags": [
"Dataset"
],
"parameters": [
{
"name": "Dataset_Id",
"in": "path",
"required": true,
"description": "dataset id",
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the dataset"
},
"type": {
"type": "string",
"enum": [
"pvc"
],
"description": "Type of the dataset"
},
"pvc": {
"type": "object",
"description": "PVC configuration, required if type is pvc",
"properties": {
"disk_size": {
"type": "integer",
"description": "Disk size for the PVC"
},
"pvc_type": {
"type": "string",
"description": "Type of the PVC"
}
},
"required": [
"disk_size",
"pvc_type"
]
}
},
"required": [
"name",
"type"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success response with updated PVC-based dataset details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the dataset.",
"example": 1311
},
"name": {
"type": "string",
"description": "Name of the dataset.",
"example": "tir-dataset-111418381010"
},
"project_id": {
"type": "integer",
"description": "ID of the project associated with the dataset.",
"example": 124
},
"description": {
"type": "string",
"description": "Description of the dataset.",
"nullable": true
},
"storage_type": {
"type": "string",
"description": "Type of storage used for the dataset.",
"example": "pvc"
},
"pvc": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the PVC.",
"example": 262
},
"disk_size": {
"type": "integer",
"description": "Updated disk size of the PVC in GB.",
"example": 45
},
"pvc_type": {
"type": "string",
"description": "Type of PVC.",
"example": "custom_pvc"
},
"status": {
"type": "string",
"description": "Current status of the PVC.",
"example": "ready"
},
"status_log": {
"type": "string",
"description": "Log detailing the PVC status.",
"example": "{'message': 'Bound', 'phase': 'ready', 'state': ''}"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of PVC creation.",
"example": "2024-11-14T13:08:17.551211Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of last PVC update.",
"example": "2024-11-14T13:12:25.137057Z"
}
}
},
"bucket": {
"type": "object",
"nullable": true,
"description": "Details of the bucket if applicable."
},
"access_key": {
"type": "object",
"nullable": true,
"description": "Access key details if applicable."
},
"encryption_type": {
"type": "string",
"description": "Type of encryption used.",
"nullable": true
},
"encryption_enable": {
"type": "boolean",
"description": "Indicates if encryption is enabled.",
"example": false
},
"status": {
"type": "string",
"description": "Status of the dataset.",
"example": "OK"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "User ID of the creator.",
"example": 3573
},
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Nipun"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator.",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of dataset creation.",
"example": "2024-11-14T13:08:17.555911Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of last update.",
"example": "2024-11-14T13:12:25.131864Z"
}
}
},
"errors": {
"type": "object",
"description": "Any errors encountered during the operation.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message of the operation.",
"example": "Disk Size upgraded successfully. It can take a few minutes for the changes to get reflected"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-datasets-dataset-id",
"summary": "Delete Dataset",
"tags": [
"Dataset"
],
"parameters": [
{
"name": "Dataset_Id",
"in": "path",
"required": true,
"description": "dataset id",
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Dataset deletion confirmation.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "object",
"description": "Placeholder object as no data is returned.",
"example": {}
},
"errors": {
"type": "object",
"description": "Contains any errors that occurred.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message confirming the deletion.",
"example": "Dataset deleted successfully"
}
}
}
}
}
}
}
}
},
"/distributed_jobs/sfs/": {
"get": {
"operationId": "get-distributed-jobs-sfs",
"summary": "List SFS",
"tags": [
"SFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 589
},
"name": {
"type": "string",
"example": "temp"
},
"created_by": {
"type": "integer",
"example": 7129
},
"sfs_ip": {
"type": "string",
"example": "172.16.232.1"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-08-19T11:11:37.504175Z"
},
"disk_size": {
"type": "string",
"example": "250 GB"
},
"size_in_gb": {
"type": "string",
"example": "250 GB"
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-distributed-jobs-sfs",
"summary": "Create SFS",
"tags": [
"SFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "tir-file-system-2818"
},
"disk_size": {
"type": "integer",
"example": 500
}
},
"required": [
"name",
"disk_size"
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 587
},
"name": {
"type": "string",
"example": "tir-file-syste-250819155818"
},
"created_by": {
"type": "integer",
"example": 7129
},
"sfs_ip": {
"type": "string",
"example": "172.16.232.1"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-08-19T10:33:02.600024Z"
},
"disk_size": {
"type": "string",
"example": "250 GB"
},
"size_in_gb": {
"type": "string",
"example": "250 GB"
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "SFS created successfully"
}
}
}
}
}
}
}
}
},
"/notebooks/{Notebook_Id}/mounted-sfs/": {
"put": {
"operationId": "put-notebooks-notebook-id-mounted-sfs",
"summary": "Mount / Unmount SFS to Instance",
"tags": [
"SFS"
],
"description": "Kindly choose request example **mount** for mounting update and **unmount** for unmounting.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Notebook_Id",
"in": "path",
"required": true,
"description": "Notebook ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "mount"
},
"sfs_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
200
]
},
"sfs_path": {
"type": "string",
"example": "/new"
}
},
"required": [
"action",
"sfs_ids",
"sfs_path"
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/distributed_jobs/sfs/{SFS_Id}/notebooks/": {
"get": {
"operationId": "get-distributed-jobs-sfs-sfs-id-notebooks",
"summary": "List of Attached Resources",
"tags": [
"SFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "SFS_Id",
"in": "path",
"required": true,
"description": "SFS ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7407
},
"name": {
"type": "string",
"example": "node-022118463030"
},
"project_id": {
"type": "integer",
"example": 4526
},
"image_type": {
"type": "string",
"example": "pre-built"
},
"image_details": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 9
},
"version_id": {
"type": "integer",
"example": 56
},
"name": {
"type": "string",
"example": "Transformers"
},
"version": {
"type": "string",
"example": "v4.45.2"
},
"icon_url": {
"type": "string",
"example": "/notebook_images/hf-logo.png"
},
"image_description": {
"type": "string",
"example": "Transformers v4.31.0 with Python 3.10 and NVIDIA Cuda 12.1 pre-installed on Ubuntu 22.04"
},
"version_description": {
"type": "string",
"example": "Transformers v4.45.2 with Python 3.10 and NVIDIA Cuda 12.4 pre-installed on Ubuntu 22.04"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 4
},
"name": {
"type": "string",
"example": "C3.8GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 8
},
"ephemeral_storage": {
"type": "integer",
"example": 50
},
"gpu_memory": {
"type": "integer",
"example": 0
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 4
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"example": 3.1
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
},
"status": {
"type": "string",
"example": "ready"
},
"last_activity": {
"type": "string",
"format": "date-time",
"example": "2025-02-21T13:16:44Z"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4875
},
"name": {
"type": "string",
"example": "Tester"
},
"email": {
"type": "string",
"example": "test.test@e2enetworks.com"
},
"username": {
"type": "string",
"example": "test.test@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-21T13:16:44.020823Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-21T13:16:45.565414Z"
},
"lab_url": {
"type": "string",
"example": "https://notebooks.e2enetworks.com/notebook/p-4526/n-f069bcc9-c9dc-4784-8a97-9d4f45d4e0/lab"
},
"disk_size_in_gb": {
"type": "integer",
"example": 30
},
"instance_type": {
"type": "string",
"example": "paid_usage"
},
"ssh_keys": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"disable_ssh_login_password": {
"type": "boolean",
"example": true
},
"public_ip": {
"type": "string",
"example": ""
},
"e2e_registry_image_url": {
"type": "string",
"nullable": true,
"example": null
},
"egress_gateway_ip": {
"type": "string",
"example": ""
},
"add_ons": {
"type": "object",
"additionalProperties": {}
},
"is_jupyterlab_enabled": {
"type": "boolean",
"example": true
},
"is_ssh_enabled": {
"type": "boolean",
"example": false
},
"custom_ports": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
},
"init_scripts": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"is_spot_instance": {
"type": "boolean",
"example": false
},
"custom_image_version": {
"type": "string",
"example": ""
},
"is_mounted": {
"type": "boolean",
"example": false
},
"sfs_path": {
"type": "string",
"nullable": true,
"example": null
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
}
},
"/distributed_jobs/sfs/{SFS_Id}/": {
"delete": {
"operationId": "delete-distributed-jobs-sfs-sfs-id",
"summary": "Delete SFS",
"tags": [
"SFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "SFS_Id",
"in": "path",
"required": true,
"description": "SFS ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "SFS deleted successfully"
}
}
}
}
}
}
}
}
},
"/pfs/": {
"get": {
"operationId": "get-pfs",
"summary": "List PFS",
"tags": [
"PFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of PFS resources",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 504
},
"name": {
"type": "string",
"example": "tir-pfs-260206142723"
},
"disk_size": {
"type": "integer",
"example": 1000
},
"created_by": {
"type": "integer",
"example": 1234
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-06T08:58:48.117806Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-06T08:57:33.388926Z"
},
"status": {
"type": "string",
"example": "OK"
},
"disk_size_in_gb": {
"type": "string",
"example": "1000 GB"
},
"disk_size_in_tb": {
"type": "string",
"example": "1.0TB"
},
"set_up_progress": {
"type": "integer",
"example": 100
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-pfs",
"summary": "Create PFS",
"tags": [
"PFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "tir-pfs-260206142723"
},
"disk_size": {
"type": "integer",
"example": 1000
}
},
"required": [
"name",
"disk_size"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "PFS created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 504
},
"name": {
"type": "string",
"example": "tir-pfs-260206142723"
},
"disk_size": {
"type": "integer",
"example": 1000
},
"created_by": {
"type": "integer",
"example": 1234
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-06T08:57:33.447326Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-06T08:57:33.388926Z"
},
"status": {
"type": "string",
"example": "Pending"
},
"disk_size_in_gb": {
"type": "string",
"example": "1000 GB"
},
"disk_size_in_tb": {
"type": "string",
"example": "1.0TB"
},
"set_up_progress": {
"type": "integer",
"example": 25
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/notebooks/{Notebook_Id}/mounted-pfs/": {
"put": {
"operationId": "put-notebooks-notebook-id-mounted-pfs",
"summary": "Mount / Unmount PFS to Instance",
"tags": [
"PFS"
],
"description": "Kindly choose request example **mount** for mounting update and **unmount** for unmounting.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Notebook_Id",
"in": "path",
"required": true,
"description": "Notebook ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "mount or unmount"
},
"pfs_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
504
]
},
"pfs_path": {
"type": "string",
"example": "/pfs"
}
},
"required": [
"action",
"pfs_ids",
"pfs_path"
]
}
}
}
},
"responses": {
"default": {
"description": "Response"
}
}
}
},
"/pfs/{PFS_Id}/notebooks/": {
"get": {
"operationId": "get-pfs-pfs-id-notebooks",
"summary": "Get Attached Instances to PFS",
"tags": [
"PFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "PFS_Id",
"in": "path",
"required": true,
"description": "PFS ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"default": {
"description": "Response"
}
}
}
},
"/pfs/{PFS_Id}/": {
"put": {
"operationId": "put-pfs-pfs-id",
"summary": "Increase PFS Size",
"tags": [
"PFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "PFS_Id",
"in": "path",
"required": true,
"description": "PFS ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer",
"example": 1000
}
},
"required": [
"disk_size"
]
}
}
}
},
"responses": {
"default": {
"description": "Successful response"
}
}
},
"delete": {
"operationId": "delete-pfs-pfs-id",
"summary": "Delete PFS",
"tags": [
"PFS"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "PFS_Id",
"in": "path",
"required": true,
"description": "PFS ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"default": {
"description": "Response"
}
}
}
},
"/container_registry/": {
"get": {
"operationId": "get-container-registry",
"summary": "List Container Registry",
"tags": [
"Container Registry"
],
"description": "**Note:** Container Registry is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved namespace details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 131
},
"namespace": {
"type": "string",
"example": "testing1234"
},
"registry_endpoint": {
"type": "string",
"example": "registry.e2enetworks.net"
},
"namespace_size": {
"type": "integer",
"example": 0
},
"username": {
"type": "string",
"example": "e2etesting1234+hey"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-container-registry",
"summary": "Create Container Registry",
"tags": [
"Container Registry"
],
"description": "**Note:** Container Registry is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the user"
},
"username": {
"type": "string",
"description": "The username of the user"
}
},
"example": {
"name": "testing12345",
"username": "username_"
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "Successful response"
}
}
}
},
"/container_registry/{Container_reg_id}/namespace-repository/": {
"get": {
"operationId": "get-container-registry-container-reg-id-namespace-repository",
"summary": "List Images",
"tags": [
"Container Registry"
],
"description": "**Note:** Container Registry is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Container_reg_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved images in the container registry",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"artifact_count": {
"type": "integer",
"example": 1
},
"creation_time": {
"type": "string",
"format": "date-time",
"example": "2026-03-04T02:40:12.186Z"
},
"id": {
"type": "integer",
"example": 7749
},
"name": {
"type": "string",
"example": "mycr03/tir_automation-v2"
},
"project_id": {
"type": "integer",
"example": 2246
},
"pull_count": {
"type": "integer",
"example": 3
},
"update_time": {
"type": "string",
"format": "date-time",
"example": "2026-03-04T02:40:27.623Z"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_count": {
"type": "integer",
"example": 3
}
}
}
}
}
}
}
}
},
"/container_registry/{Container_reg_id}/": {
"delete": {
"operationId": "delete-container-registry-container-reg-id",
"summary": "Delete Container Registry",
"tags": [
"Container Registry"
],
"description": "**Note:** Container Registry is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Container_reg_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Container registry deletion started",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Container Registry Deletion Started"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/vector_db/": {
"get": {
"operationId": "get-vector-db",
"summary": "VectorDB List",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Vector database instances retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 327
},
"name": {
"type": "string",
"example": "tir-qdrant-0709120fd5ghh1616"
},
"disk_size": {
"type": "integer",
"example": 30
},
"status": {
"type": "string",
"example": "Running"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:42:58.096699Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:43:44.062600Z"
},
"vectordb_type": {
"type": "string",
"example": "Qdrant"
},
"dashboard_url": {
"type": "string",
"example": "https://327v04a82908-vectordatabase.e2enetworks.net:6333/dashboard"
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-vector-db",
"summary": "Create Qdrant",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the VectorDB instance"
},
"sku_item_price_id": {
"type": "integer",
"description": "The SKU item price ID"
},
"replicas": {
"type": "integer",
"description": "The number of replicas"
},
"vectordb_type": {
"type": "string",
"description": "The type of vector database (e.g., Qdrant)"
},
"disk_size": {
"type": "integer",
"description": "The disk size in GB"
},
"collections": {
"type": "object",
"properties": {
"collection_name": {
"type": "string",
"description": "The name of the collection"
},
"vectors": {
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "The size of the vectors"
},
"distance": {
"type": "string",
"description": "The distance metric (e.g., Cosine)"
}
}
},
"replication_factor": {
"type": "integer",
"description": "The replication factor for the collection"
},
"shard_number": {
"type": "integer",
"description": "The number of shards"
},
"sharding_method": {
"type": "string",
"description": "The method of sharding (e.g., auto)"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Vector database instance created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 327
},
"name": {
"type": "string",
"example": "tir-qdrant-0709120fd5ghh1616"
},
"disk_size": {
"type": "integer",
"example": 30
},
"replicas": {
"type": "integer",
"example": 3
},
"status": {
"type": "string",
"example": "Creating"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:42:58.096699Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:42:58.096769Z"
},
"vectordb_type": {
"type": "string",
"example": "Qdrant"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 133
},
"name": {
"type": "string",
"example": "VDB.16GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 16
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 635
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 9
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Hourly Compute Instance"
}
}
}
}
},
"endpoint_url": {
"type": "string",
"example": "327v04a82908-vectordatabase.e2enetworks.net"
},
"ip_enabled": {
"type": "boolean",
"example": false
},
"api_key": {
"type": "string",
"example": "9BtmiMORVjztx9Jqpoooy7PnNlkjM#04"
},
"read_only_api_key": {
"type": "string",
"example": "z7zXhiNBhEcPR5jUJLd@"
},
"dashboard_url": {
"type": "string",
"example": "https://327v04a82908-vectordatabase.e2enetworks.net:6333/dashboard"
},
"number_of_vectors": {
"type": "string",
"example": ""
},
"number_of_collections": {
"type": "string",
"example": ""
},
"total_peers": {
"type": "string",
"example": ""
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/vector_db/{VectorDB_id}": {
"get": {
"operationId": "get-vector-db-vectordb-id",
"summary": "VectorDB Details",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Vector database instance details retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 327
},
"name": {
"type": "string",
"example": "tir-qdrant-0709120fd5ghh1616"
},
"disk_size": {
"type": "integer",
"example": 30
},
"replicas": {
"type": "integer",
"example": 3
},
"status": {
"type": "string",
"example": "Running"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:42:58.096699Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:49:24.650496Z"
},
"vectordb_type": {
"type": "string",
"example": "Qdrant"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 133
},
"name": {
"type": "string",
"example": "VDB.16GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 16
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 635
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 9
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Hourly Compute Instance"
}
}
}
}
},
"endpoint_url": {
"type": "string",
"example": "327v04a82908-vectordatabase.e2enetworks.net"
},
"ip_enabled": {
"type": "boolean",
"example": false
},
"api_key": {
"type": "string",
"example": "9BtmiMORVjztx9Jqpoooy7PnNlkjM#04"
},
"read_only_api_key": {
"type": "string",
"example": "z7zXhiNBhEcPR5jUJLd@"
},
"dashboard_url": {
"type": "string",
"example": "https://327v04a82908-vectordatabase.e2enetworks.net:6333/dashboard"
},
"number_of_vectors": {
"type": "string",
"example": "0"
},
"number_of_collections": {
"type": "string",
"example": "1"
},
"total_peers": {
"type": "string",
"example": "3"
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/vector_db/{VectorDB_id}/pvcs/": {
"put": {
"operationId": "put-vector-db-vectordb-id-pvcs",
"summary": "Resize disk",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer",
"description": "The disk size in GB"
}
},
"example": {
"disk_size": 31
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Disk size upgraded successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Disk Size upgraded successfully. It can take a few minutes for the changes to get reflected"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 327
},
"name": {
"type": "string",
"example": "tir-qdrant-0709120fd5ghh1616"
},
"disk_size": {
"type": "integer",
"example": 32
},
"replicas": {
"type": "integer",
"example": 3
},
"status": {
"type": "string",
"example": "Running"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:42:58.096699Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:55:48.673470Z"
},
"vectordb_type": {
"type": "string",
"example": "Qdrant"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 133
},
"name": {
"type": "string",
"example": "VDB.16GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 16
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 635
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 9
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Hourly Compute Instance"
}
}
}
}
},
"endpoint_url": {
"type": "string",
"example": "327v04a82908-vectordatabase.e2enetworks.net"
},
"ip_enabled": {
"type": "boolean",
"example": false
},
"api_key": {
"type": "string",
"example": "9BtmiMORVjztx9Jqpoooy7PnNlkjM#04"
},
"read_only_api_key": {
"type": "string",
"example": "z7zXhiNBhEcPR5jUJLd@"
},
"dashboard_url": {
"type": "string",
"example": "https://327v04a82908-vectordatabase.e2enetworks.net:6333/dashboard"
},
"number_of_vectors": {
"type": "string",
"example": "0"
},
"number_of_collections": {
"type": "string",
"example": "1"
},
"total_peers": {
"type": "string",
"example": "3"
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/vector_db/{VectorDB_id}/": {
"put": {
"operationId": "put-vector-db-vectordb-id",
"summary": "Update Cluster",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"replicas": {
"type": "integer",
"description": "The number of replicas"
}
},
"example": {
"replicas": 4
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully updated the vector database instance",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 327
},
"name": {
"type": "string",
"example": "tir-qdrant-0709120fd5ghh1616"
},
"disk_size": {
"type": "integer",
"example": 32
},
"replicas": {
"type": "integer",
"example": 4
},
"status": {
"type": "string",
"example": "Running"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T05:42:58.096699Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T06:02:01.487643Z"
},
"vectordb_type": {
"type": "string",
"example": "Qdrant"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 133
},
"name": {
"type": "string",
"example": "VDB.16GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 4
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 16
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 635
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 9
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Hourly Compute Instance"
}
}
}
}
},
"endpoint_url": {
"type": "string",
"example": "327v04a82908-vectordatabase.e2enetworks.net"
},
"ip_enabled": {
"type": "boolean",
"example": false
},
"api_key": {
"type": "string",
"example": "9BtmiMORVjztx9Jqpoooy7PnNlkjM#04"
},
"read_only_api_key": {
"type": "string",
"example": "z7zXhiNBhEcPR5jUJLd@"
},
"dashboard_url": {
"type": "string",
"example": "https://327v04a82908-vectordatabase.e2enetworks.net:6333/dashboard"
},
"number_of_vectors": {
"type": "string",
"example": "0"
},
"number_of_collections": {
"type": "string",
"example": "1"
},
"total_peers": {
"type": "string",
"example": "3"
},
"custom_sku": {
"type": "string",
"nullable": true,
"example": null
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-vector-db-vectordb-id",
"summary": "Delete vector Database",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Vector database has been successfully deleted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "VectorDB deleted successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/vector_db/{VectorDB_id}/snapshot/": {
"get": {
"operationId": "get-vector-db-vectordb-id-snapshot",
"summary": "Snapshot List",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved snapshot information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 69
},
"vector_db_id": {
"type": "integer",
"example": 327
},
"status": {
"type": "string",
"example": "Creating"
},
"snapshot_time": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T06:05:38.802401Z"
},
"restoring_status": {
"type": "boolean",
"example": false
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-vector-db-vectordb-id-snapshot",
"summary": "Take Snapshot",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "Snapshot creation scheduled successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Snapshot Creation Scheduled."
},
"data": {
"type": "object",
"properties": {
"snapshot_id": {
"type": "integer",
"example": 69
},
"snapshot_time": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T06:05:38.802401"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/vector_db/{VectorDB_id}/snapshot/{Snapshot_id}/restore/": {
"put": {
"operationId": "put-vector-db-vectordb-id-snapshot-snapshot-id-restore",
"summary": "Restore snapshot",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "Snapshot_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Snapshot restoration has been successfully scheduled",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Snapshot Restoration Scheduled."
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/vector_db/{VectorDB_id}/snapshot/{Snapshot_id}/": {
"delete": {
"operationId": "delete-vector-db-vectordb-id-snapshot-snapshot-id",
"summary": "Delete snapshot",
"tags": [
"Vector Database"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "VectorDB_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "Snapshot_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Snapshot has been successfully deleted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Snapshot Deleted Successfully"
},
"data": {
"type": "object",
"properties": {
"snapshot_id": {
"type": "integer",
"example": 69
},
"snapshot": {
"type": "string",
"example": "2024-11-14T06:05:38.802401Z"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/serving/model/model_types/": {
"get": {
"operationId": "get-serving-model-model-types",
"summary": "Get Model type",
"tags": [
"Model Repository"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "A list of integrations retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "pytorch"
},
"created_by": {
"type": "integer",
"example": 53
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-01T09:38:54.769855Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2023-06-01T09:38:54.769924Z"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/serving/model/": {
"get": {
"operationId": "get-serving-model",
"summary": "Model Repository List",
"tags": [
"Model Repository"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved model access key and storage details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1243
},
"name": {
"type": "string",
"example": "adahfihhhhhh"
},
"project_id": {
"type": "integer",
"example": 124
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"model_type": {
"type": "string",
"example": "pytorch"
},
"storage_type": {
"type": "string",
"example": "managed"
},
"status": {
"type": "string",
"example": "OK"
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2535
},
"access_key": {
"type": "string",
"example": "6AAYVBO46X8N1V3VGY81"
},
"secret_key": {
"type": "string",
"example": "M5GDFOSIH5H5SWUK8FC2ELD8Y07H47OGQQM13IYT"
},
"tag": {
"type": "string",
"example": "akgpued8b358bcb6a4d9d94255d3092f4b8b4"
},
"is_managed": {
"type": "boolean",
"example": true
}
}
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2518
},
"bucket_name": {
"type": "string",
"example": "adahfihhhhhh-a64d9e"
},
"bucket_url": {
"type": "string",
"example": "s3://adahfihhhhhh-a64d9e/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 10204
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T09:42:01.554549Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T09:42:01.554608Z"
},
"finetuning_id": {
"type": "string",
"nullable": true,
"example": null
},
"score": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-serving-model",
"summary": "Create Model Repository",
"tags": [
"Model Repository"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the bucket"
},
"storage_type": {
"type": "string",
"enum": [
"managed"
],
"description": "The storage type for the bucket"
},
"bucket_name": {
"type": "string",
"description": "The bucket name (empty for managed)"
},
"model_type": {
"type": "string",
"enum": [
"pytorch"
],
"description": "The model type"
},
"access_key": {
"type": "string",
"description": "Access key for authentication"
},
"secret_key": {
"type": "string",
"description": "Secret key for authentication"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the bucket"
},
"storage_type": {
"type": "string",
"enum": [
"e2e_s3"
],
"description": "The storage type for the bucket"
},
"bucket_name": {
"type": "string",
"description": "The existing bucket name"
},
"model_type": {
"type": "string",
"enum": [
"pytorch"
],
"description": "The model type"
},
"access_key": {
"type": "string",
"description": "Access key for authentication"
},
"secret_key": {
"type": "string",
"description": "Secret key for authentication"
}
}
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the bucket"
},
"storage_type": {
"type": "string",
"enum": [
"external"
],
"description": "The storage type for the external bucket"
},
"bucket_name": {
"type": "string",
"description": "The external bucket name"
},
"model_type": {
"type": "string",
"enum": [
"pytorch"
],
"description": "The model type"
},
"access_key": {
"type": "string",
"description": "Access key for authentication to the external bucket"
},
"secret_key": {
"type": "string",
"description": "Secret key for authentication to the external bucket"
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Model created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1243
},
"name": {
"type": "string",
"example": "adahfihhhhhh"
},
"project_id": {
"type": "integer",
"example": 124
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"model_type": {
"type": "string",
"example": "pytorch"
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2518
},
"bucket_name": {
"type": "string",
"example": "adahfihhhhhh-a64d9e"
},
"bucket_url": {
"type": "string",
"example": "s3://adahfihhhhhh-a64d9e/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 10204
}
}
},
"status": {
"type": "string",
"example": "OK"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T09:42:01.554549Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T09:42:01.554608Z"
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2535
},
"access_key": {
"type": "string",
"example": "6AAYVBO46X8N1V3VGY81"
},
"secret_key": {
"type": "string",
"example": "M5GDFOSIH5H5SWUK8FC2ELD8Y07H47OGQQM13IYT"
},
"tag": {
"type": "string",
"example": "akgpued8b358bcb6a4d9d94255d3092f4b8b4"
},
"is_managed": {
"type": "boolean",
"example": true
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/serving/model/{Model_repo_id}/": {
"delete": {
"operationId": "delete-serving-model-model-repo-id",
"summary": "Delete Model Repository",
"tags": [
"Model Repository"
],
"parameters": [
{
"name": "Model_repo_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Model successfully deleted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Model deleted successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/serving/inference/framework-details/": {
"get": {
"operationId": "get-framework-details",
"summary": "Framework Details",
"tags": [
"Model Endpoints"
],
"description": "Returns all available inference frameworks and their versions. Use the version `id` from the response as `framework_version_id` when calling the SKU List API.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved framework details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Framework identifier",
"example": "vllm"
},
"display_name": {
"type": "string",
"description": "Display name of the framework",
"example": "vLLM"
},
"description": {
"type": "string",
"description": "Brief description of the framework",
"example": "vLLM is a fast and easy-to-use library for LLM inference and serving."
},
"image_name": {
"type": "string",
"description": "Container image name",
"example": "registry.e2enetworks.net/aimle2e/vllm"
},
"additional_info": {
"type": "object",
"description": "Additional framework-specific information"
},
"is_managed_args": {
"type": "boolean",
"description": "Whether the framework uses managed arguments",
"example": true
},
"versions": {
"type": "array",
"description": "Available versions for this framework",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Version ID. Use this as `framework_version_id` in the SKU List API.",
"example": 64
},
"version": {
"type": "string",
"description": "Version string",
"example": "v0.17.1"
},
"supported_models": {
"type": "array",
"description": "List of models supported by this version",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Model identifier (Hugging Face ID or \"custom\")",
"example": "meta-llama/Llama-2-7b-hf"
},
"label": {
"type": "string",
"description": "Display label for the model",
"example": "Llama-2-7B"
}
}
}
}
}
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/": {
"post": {
"operationId": "post-serving-inference",
"summary": "Create Endpoints",
"tags": [
"Model Endpoints"
],
"description": "Create a new model inference endpoint. The following models and frameworks are supported — select the corresponding example from the request body:\n\n| # | Model / Framework | `framework` value | Model source |\n|---|---|---|---|\n| 1 | vLLM | `vllm` | HuggingFace model ID |\n| 2 | SGLang | `sglang` | HuggingFace model ID |\n| 3 | Nvidia Dynamo | `dynamo` | HuggingFace model ID |\n| 4 | PyTorch / TorchServe | `pytorch` | Fine-tuned TIR model (`model_id`) |\n| 5 | Triton Inference Server | `triton` | Fine-tuned TIR model (`model_id`) |\n| 6 | Custom Container | `custom` | Any Docker image |\n| 7 | LLaMA 2 Chat 7B | `llma` | HuggingFace model ID |\n| 8 | CodeLlama 7B Instruct | `codellama` | HuggingFace model ID |\n| 9 | Mistral 7B Instruct | `mistral-7b-instruct` | HuggingFace model ID |\n| 10 | Mixtral 8x7B Instruct | `mixtral-8x7b-instruct` | HuggingFace model ID |\n| 11 | Gemma 2B IT | `gemma-2b-it` | HuggingFace model ID |\n| 12 | LLaMA 3 8B Instruct | `llama-3-8b-instruct` | HuggingFace model ID |\n| 13 | Phi-3 Mini 128K Instruct | `Phi-3-mini-128k-instruct` | HuggingFace model ID |\n| 14 | LLaMA 3.1 8B Instruct | `llama-3_1-8b-instruct` | HuggingFace model ID |\n| 18 | BGE Large EN v1.5 | `bge-large-en-v1_5` | Built-in (via `args`) |\n| 19 | BGE Reranker Large | `bge-reranker-large` | Built-in (via `args`) |\n| 20 | Stable Diffusion XL | `stable_diffusion_xl` | E2E registry |\n| 21 | YOLOv8 | `yolov8` | E2E registry |\n| 22 | Stable Video Diffusion | `stable-video-diffusion-img2vid-xt` | E2E registry |\n| 23 | NVIDIA NV-Embed v1 | `nvidia-nv-embed-v1` | E2E registry |\n| 24 | TensorRT-LLM | `tensorrt` | Fine-tuned TIR model (`model_id`) |\n| 25 | Nemotron 3 8B Chat | `nemotron-3-8b-chat-4k-rlhf` | E2E registry |\n| 26 | Nemotron 3 Nano 30B A3B | `nemotron-3-nano-30b-a3b` | HuggingFace model ID |\n| 27 | Nemotron Nano 12B v2 VL | `nemotron-nano-12b-v2-vl` | HuggingFace model ID |\n| 28 | Nemotron Speech Streaming EN 0.6B | `nemotron-speech-streaming-en-0.6b` | E2E registry |\n\n\n### To launch on TIR Cluster\n Replace `\"cluster_type\"`, `\"sku_id\"`, and `\"sku_item_price_id\"` with the values for your location:\n\n| Location | `sku_id` | `sku_item_price_id` |\n|----------|----------|---------------------|\n| Delhi | 162 | 755 |\n| Chennai | 40 | 1628 |\n\n```js\n\n\"cluster_type\": \"tir-cluster\",\n\"sku_id\": 162,\n\"sku_item_price_id\": 755\n```\n\n\n### To launch on Private Cluster\n Replace \"cluster_type\",\"sku_id\" and \"sku_item_price_id\" with the following data.\n\n```js\n\n\"cluster_type\": \"private-cluster\",\n\"custom_sku\": {\n \"cpu\": 1,\n \"gpu\": 0,\n \"memory\": 1\n},\n\"private_cloud_id\": < Private Cluster Id>\n```",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the deployment"
},
"custom_endpoint_details": {
"type": "object",
"properties": {
"service_port": {
"type": "boolean"
},
"metric_port": {
"type": "boolean"
},
"container": {
"type": "object",
"properties": {
"container_name": {
"type": "string"
},
"container_type": {
"type": "string"
},
"private_image_details": {
"type": "object"
},
"advance_config": {
"type": "object",
"properties": {
"image_pull_policy": {
"type": "string"
},
"is_readiness_probe_enabled": {
"type": "boolean"
},
"is_liveness_probe_enabled": {
"type": "boolean"
},
"readiness_probe": {
"type": "object",
"properties": {
"protocol": {
"type": "string"
},
"initial_delay_seconds": {
"type": "integer"
},
"success_threshold": {
"type": "integer"
},
"failure_threshold": {
"type": "integer"
},
"port": {
"type": "integer"
},
"period_seconds": {
"type": "integer"
},
"timeout_seconds": {
"type": "integer"
},
"path": {
"type": "string"
},
"grpc_service": {
"type": "string"
},
"commands": {
"type": "string"
}
}
},
"liveness_probe": {
"type": "object",
"properties": {
"protocol": {
"type": "string"
},
"initial_delay_seconds": {
"type": "integer"
},
"success_threshold": {
"type": "integer"
},
"failure_threshold": {
"type": "integer"
},
"port": {
"type": "integer"
},
"period_seconds": {
"type": "integer"
},
"timeout_seconds": {
"type": "integer"
},
"path": {
"type": "string"
},
"grpc_service": {
"type": "string"
},
"commands": {
"type": "string"
}
}
}
}
}
}
},
"resource_details": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer"
},
"mount_path": {
"type": "string"
},
"env_variables": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"public_ip": {
"type": "string",
"enum": [
"yes",
"no"
]
}
}
},
"model_id": {
"type": "string",
"nullable": true
},
"replica": {
"type": "integer"
},
"committed_replicas": {
"type": "integer"
},
"path": {
"type": "string"
},
"framework": {
"type": "string"
},
"is_auto_scale_enabled": {
"type": "boolean"
},
"auto_scale_policy": {
"type": "object",
"properties": {
"min_replicas": {
"type": "integer"
},
"max_replicas": {
"type": "integer"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metric": {
"type": "string"
},
"condition_type": {
"type": "string"
},
"value": {
"type": "integer"
},
"watch_period": {
"type": "integer"
},
"granularity": {
"type": "integer"
},
"window": {
"type": "integer"
}
}
}
},
"stability_period": {
"type": "integer"
}
}
},
"detailed_info": {
"type": "object",
"properties": {
"commands": {
"type": "string"
},
"args": {
"type": "string"
},
"hugging_face_id": {
"type": "string"
},
"tokenizer": {
"type": "string"
},
"server_version": {
"type": "string"
},
"world_size": {
"type": "integer"
},
"error_log": {
"type": "boolean"
},
"info_log": {
"type": "boolean"
},
"warning_log": {
"type": "boolean"
},
"log_verbose_level": {
"type": "integer"
},
"model_serve_type": {
"type": "string"
}
}
},
"model_load_integration_id": {
"type": "integer"
},
"dataset_id": {
"type": "string",
"nullable": true
},
"dataset_path": {
"type": "string"
},
"cluster_type": {
"type": "string"
},
"sku_id": {
"type": "integer"
},
"sku_item_price_id": {
"type": "integer"
}
},
"required": [
"name",
"custom_endpoint_details",
"replica",
"framework",
"is_auto_scale_enabled",
"auto_scale_policy",
"detailed_info",
"model_load_integration_id",
"sku_id",
"sku_item_price_id"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Model deployment created successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP response status code.",
"example": 201
},
"data": {
"type": "object",
"description": "Deployment creation response data.",
"properties": {
"id": {
"type": "integer",
"description": "Unique deployment ID.",
"example": 3036
},
"model": {
"type": "string",
"description": "Model details (null if not available).",
"example": null
},
"model_type": {
"type": "string",
"description": "Type of model (null if not available).",
"example": null
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"description": "SKU identifier.",
"example": 162
},
"name": {
"type": "string",
"description": "SKU name.",
"example": "GDC.1xH200-30.375GB_SXM"
},
"series": {
"type": "string",
"description": "SKU series.",
"example": "GPU"
},
"cpu": {
"type": "integer",
"description": "Number of CPUs.",
"example": 30
},
"gpu": {
"type": "integer",
"description": "Number of GPUs.",
"example": 1
},
"memory": {
"type": "integer",
"description": "Memory in GB.",
"example": 375
},
"is_free": {
"type": "boolean",
"description": "Whether the SKU is free.",
"example": false
},
"is_active": {
"type": "boolean",
"description": "Whether the SKU is active.",
"example": true
},
"gpu_switch_type": {
"type": "string",
"description": "GPU switch type (if applicable).",
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"description": "Local storage in GB.",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"description": "SKU price ID.",
"example": 755
},
"sku_type": {
"type": "string",
"description": "SKU pricing type.",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"description": "Committed days for pricing.",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"description": "Unit price in the given currency.",
"example": 470.4
},
"currency": {
"type": "string",
"description": "Currency of the price.",
"example": "INR"
},
"is_active": {
"type": "boolean",
"description": "Whether the pricing plan is active.",
"example": true
},
"description": {
"type": "string",
"description": "Description of the pricing plan.",
"example": "Hourly Compute Instance: inference_service"
}
}
}
}
},
"sku_item_price_id": {
"type": "integer",
"description": "SKU price ID.",
"example": 755
},
"name": {
"type": "string",
"description": "Name of the deployment.",
"example": "tir-endpoint-1115165asd83333"
},
"storage_url": {
"type": "string",
"description": "URL for storage.",
"example": null
},
"status": {
"type": "string",
"description": "Deployment status.",
"example": "waiting"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Creator's user ID.",
"example": 3573
},
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Nipun"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator.",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the deployment was created.",
"example": "2024-11-15T11:32:35.527296Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the deployment was last updated.",
"example": "2024-11-15T11:32:35.527371Z"
},
"detailed_info": {
"type": "object",
"properties": {
"commands": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of commands related to the deployment.",
"example": []
},
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of arguments.",
"example": []
},
"hugging_face_id": {
"type": "string",
"description": "Hugging Face model ID (nullable).",
"example": ""
},
"tokenizer": {
"type": "string",
"description": "Tokenizer (nullable).",
"example": ""
},
"server_version": {
"type": "string",
"description": "Server version.",
"example": ""
},
"world_size": {
"type": "integer",
"description": "World size for distributed systems.",
"example": 1
},
"error_log": {
"type": "boolean",
"description": "Whether error logs are enabled.",
"example": true
},
"info_log": {
"type": "boolean",
"description": "Whether info logs are enabled.",
"example": true
},
"warning_log": {
"type": "boolean",
"description": "Whether warning logs are enabled.",
"example": true
},
"log_verbose_level": {
"type": "integer",
"description": "Verbosity level for logs.",
"example": 1
},
"model_serve_type": {
"type": "string",
"description": "Model serve type (nullable).",
"example": ""
}
}
},
"framework": {
"type": "string",
"description": "Framework used for the model.",
"example": "stable_diffusion_xl"
},
"custom_endpoint_details": {
"type": "object",
"properties": {
"public_ip": {
"type": "string",
"description": "Whether the deployment has a public IP.",
"example": "no"
},
"container": {
"type": "object",
"properties": {
"container_name": {
"type": "string",
"description": "Name of the container.",
"example": "registry.e2enetworks.net/aimle2e/stable-diffusion-xl-base-1.0:hf"
},
"container_type": {
"type": "string",
"description": "Type of container (public or private).",
"example": "public"
},
"advance_config": {
"type": "object",
"properties": {
"image_pull_policy": {
"type": "string",
"description": "Policy for pulling container images.",
"example": "Always"
},
"is_readiness_probe_enabled": {
"type": "boolean",
"description": "Whether readiness probe is enabled.",
"example": false
},
"is_liveness_probe_enabled": {
"type": "boolean",
"description": "Whether liveness probe is enabled.",
"example": false
},
"readiness_probe": {
"type": "object",
"properties": {
"initial_delay_seconds": {
"type": "integer",
"description": "Initial delay before readiness probe starts.",
"example": 10
},
"period_seconds": {
"type": "integer",
"description": "Period between readiness probe checks.",
"example": 10
},
"timeout_seconds": {
"type": "integer",
"description": "Timeout for readiness probe.",
"example": 10
},
"success_threshold": {
"type": "integer",
"description": "Number of successful attempts before marking as healthy.",
"example": 1
},
"failure_threshold": {
"type": "integer",
"description": "Number of failed attempts before marking as unhealthy.",
"example": 3
},
"protocol": {
"type": "string",
"description": "Protocol for readiness probe.",
"example": "http"
},
"port": {
"type": "string",
"description": "Port for readiness probe.",
"example": "8080"
},
"path": {
"type": "string",
"description": "Path for readiness check.",
"example": "/v2/health/ready"
}
}
},
"liveness_probe": {
"type": "object",
"description": "Liveness probe configuration."
}
}
}
}
},
"resource_details": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer",
"description": "Disk size for the deployment.",
"example": 100
},
"mount_path": {
"type": "string",
"description": "Mount path for resources.",
"example": ""
},
"env_variables": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of environment variables for the deployment.",
"example": []
}
}
}
}
},
"replica": {
"type": "integer",
"description": "Number of replicas for the deployment.",
"example": 1
},
"auto_scale_policy": {
"type": "object",
"properties": {
"min_replicas": {
"type": "integer",
"description": "Minimum replicas for auto-scaling.",
"example": 1
},
"max_replicas": {
"type": "integer",
"description": "Maximum replicas for auto-scaling.",
"example": 1
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metric": {
"type": "string",
"description": "Metric to monitor for auto-scaling.",
"example": ""
},
"condition_type": {
"type": "string",
"description": "Type of condition for scaling (e.g., limit).",
"example": "limit"
},
"value": {
"type": "integer",
"description": "Value for the condition.",
"example": 100
},
"watch_period": {
"type": "integer",
"description": "Period to monitor the metric.",
"example": 60
},
"granularity": {
"type": "integer",
"description": "Granularity of the metric.",
"example": 1
},
"window": {
"type": "integer",
"description": "Window size for scaling.",
"example": 1
},
"custom_metric_name": {
"type": "string",
"description": "Custom metric name (nullable).",
"example": ""
}
}
}
},
"stability_period": {
"type": "string",
"description": "Stability period before scaling.",
"example": "300"
}
}
},
"is_auto_scale_enabled": {
"type": "boolean",
"description": "Whether auto-scaling is enabled.",
"example": false
},
"desired_replica": {
"type": "integer",
"description": "Desired number of replicas.",
"example": 1
},
"model_load_integration_id": {
"type": "integer",
"description": "Integration ID for model load.",
"example": 428
},
"dataset": {
"type": "string",
"description": "Dataset associated with the deployment (nullable).",
"example": null
},
"dataset_storage_url": {
"type": "string",
"description": "URL for dataset storage (nullable).",
"example": null
},
"committed_replicas": {
"type": "integer",
"description": "Number of committed replicas.",
"example": 0
},
"private_cloud_id": {
"type": "string",
"description": "Private cloud ID (nullable).",
"example": null
},
"custom_sku": {
"type": "string",
"description": "Custom SKU details (nullable).",
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "string",
"description": "Success or error message.",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/serving/inference": {
"get": {
"operationId": "list-model-endpoints",
"summary": "Model Endpoints List",
"tags": [
"Model Endpoints"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved list of deployments.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP response status code",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique deployment ID",
"example": 3036
},
"model": {
"type": "string",
"nullable": true,
"description": "Model details (nullable)",
"example": null
},
"dataset": {
"type": "string",
"nullable": true,
"description": "Dataset associated with the deployment (nullable)",
"example": null
},
"model_type": {
"type": "string",
"nullable": true,
"description": "Type of model (nullable)",
"example": null
},
"sku": {
"type": "integer",
"description": "SKU ID",
"example": 162
},
"name": {
"type": "string",
"description": "Name of the deployment",
"example": "tir-endpoint-1115165asd83333"
},
"storage_url": {
"type": "string",
"nullable": true,
"description": "URL for storage (nullable)",
"example": null
},
"dataset_storage_url": {
"type": "string",
"nullable": true,
"description": "URL for dataset storage (nullable)",
"example": null
},
"status": {
"type": "string",
"description": "Deployment status",
"example": "ready"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Creator's user ID",
"example": 3573
},
"name": {
"type": "string",
"description": "Name of the creator",
"example": "Nipun"
},
"email": {
"type": "string",
"description": "Email of the creator",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the deployment was created",
"example": "2024-11-15T11:32:35.527296Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the deployment was last updated",
"example": "2024-11-15T11:40:05.222359Z"
},
"detailed_info": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of arguments",
"example": []
},
"commands": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of commands",
"example": []
},
"info_log": {
"type": "boolean",
"description": "Whether info logs are enabled",
"example": true
},
"error_log": {
"type": "boolean",
"description": "Whether error logs are enabled",
"example": true
},
"tokenizer": {
"type": "string",
"nullable": true,
"description": "Tokenizer details (nullable)",
"example": ""
},
"world_size": {
"type": "integer",
"description": "World size for distributed systems",
"example": 1
},
"warning_log": {
"type": "boolean",
"description": "Whether warning logs are enabled",
"example": true
},
"server_version": {
"type": "string",
"nullable": true,
"description": "Server version (nullable)",
"example": ""
},
"hugging_face_id": {
"type": "string",
"nullable": true,
"description": "Hugging Face model ID (nullable)",
"example": ""
},
"model_serve_type": {
"type": "string",
"nullable": true,
"description": "Model serve type (nullable)",
"example": ""
},
"log_verbose_level": {
"type": "integer",
"description": "Verbosity level for logs",
"example": 1
}
}
},
"replica": {
"type": "integer",
"description": "Number of replicas for the deployment",
"example": 1
},
"framework": {
"type": "string",
"description": "Framework used for the model",
"example": "stable_diffusion_xl"
},
"custom_endpoint_details": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"container_name": {
"type": "string",
"description": "Name of the container",
"example": "registry.e2enetworks.net/aimle2e/stable-diffusion-xl-base-1.0:hf"
},
"container_type": {
"type": "string",
"description": "Type of container (public or private)",
"example": "public"
},
"advance_config": {
"type": "object",
"properties": {
"liveness_probe": {
"type": "object",
"description": "Liveness probe configuration"
},
"readiness_probe": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path for readiness check",
"example": "/v2/health/ready"
},
"port": {
"type": "string",
"description": "Port for readiness probe",
"example": "8080"
},
"protocol": {
"type": "string",
"description": "Protocol for readiness probe",
"example": "http"
},
"period_seconds": {
"type": "integer",
"description": "Period between readiness probe checks",
"example": 10
},
"timeout_seconds": {
"type": "integer",
"description": "Timeout for readiness probe",
"example": 10
},
"failure_threshold": {
"type": "integer",
"description": "Number of failed attempts before marking as unhealthy",
"example": 3
},
"success_threshold": {
"type": "integer",
"description": "Number of successful attempts before marking as healthy",
"example": 1
},
"initial_delay_seconds": {
"type": "integer",
"description": "Initial delay before readiness probe starts",
"example": 10
}
}
},
"image_pull_policy": {
"type": "string",
"description": "Policy for pulling container images",
"example": "Always"
},
"is_liveness_probe_enabled": {
"type": "boolean",
"description": "Whether liveness probe is enabled",
"example": false
},
"is_readiness_probe_enabled": {
"type": "boolean",
"description": "Whether readiness probe is enabled",
"example": false
}
}
},
"private_image_details": {
"type": "object",
"description": "Details for private image (if applicable)"
}
}
},
"public_ip": {
"type": "string",
"description": "Whether the deployment has a public IP",
"example": "no"
},
"resource_details": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer",
"description": "Disk size for the deployment",
"example": 100
},
"mount_path": {
"type": "string",
"description": "Mount path for resources",
"example": ""
},
"env_variables": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of environment variables for the deployment",
"example": []
}
}
}
}
},
"message": {
"type": "string",
"description": "Success or error message",
"example": ""
},
"auto_scale_policy": {
"type": "object",
"properties": {
"min_replicas": {
"type": "integer",
"description": "Minimum replicas for auto-scaling",
"example": 1
},
"max_replicas": {
"type": "integer",
"description": "Maximum replicas for auto-scaling",
"example": 1
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Value for scaling condition",
"example": 100
},
"metric": {
"type": "string",
"description": "Metric for scaling condition",
"example": ""
},
"window": {
"type": "integer",
"description": "Window size for scaling",
"example": 1
},
"granularity": {
"type": "integer",
"description": "Granularity of the metric",
"example": 1
},
"watch_period": {
"type": "integer",
"description": "Watch period for scaling",
"example": 60
},
"condition_type": {
"type": "string",
"description": "Type of condition for scaling",
"example": "limit"
},
"custom_metric_name": {
"type": "string",
"nullable": true,
"description": "Custom metric name (nullable)",
"example": ""
}
}
}
},
"stability_period": {
"type": "string",
"description": "Stability period before scaling",
"example": "300"
}
}
},
"is_auto_scale_enabled": {
"type": "boolean",
"description": "Whether auto-scaling is enabled",
"example": false
},
"desired_replica": {
"type": "integer",
"description": "Desired number of replicas",
"example": 1
},
"model_load_integration_id": {
"type": "integer",
"description": "Integration ID for model load",
"example": 428
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"description": "SKU identifier",
"example": 162
},
"name": {
"type": "string",
"description": "SKU name",
"example": "GDC.1xH200-30.375GB_SXM"
},
"series": {
"type": "string",
"description": "SKU series",
"example": "GPU"
},
"cpu": {
"type": "integer",
"description": "Number of CPUs",
"example": 30
},
"gpu": {
"type": "integer",
"description": "Number of GPUs",
"example": 1
},
"memory": {
"type": "integer",
"description": "Memory in GB",
"example": 375
},
"is_free": {
"type": "boolean",
"description": "Whether the SKU is free",
"example": false
},
"is_active": {
"type": "boolean",
"description": "Whether the SKU is active",
"example": true
},
"gpu_switch_type": {
"type": "string",
"description": "GPU switch type (nullable)",
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"description": "Local storage in GB",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"description": "SKU item price ID",
"example": 755
},
"sku_type": {
"type": "string",
"description": "SKU type (e.g., hourly)",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"description": "Committed days for the plan",
"example": 0
},
"unit_price": {
"type": "number",
"description": "Unit price for the SKU",
"example": 470.4
},
"currency": {
"type": "string",
"description": "Currency for pricing",
"example": "INR"
},
"is_active": {
"type": "boolean",
"description": "Whether the plan is active",
"example": true
},
"description": {
"type": "string",
"description": "Description of the SKU plan",
"example": "Hourly Compute Instance: inference_service"
}
}
}
}
},
"committed_info": {
"type": "object",
"nullable": true,
"description": "Committed information (nullable)",
"example": null
},
"committed_replicas": {
"type": "integer",
"description": "Committed replicas",
"example": 0
},
"private_cloud_id": {
"type": "string",
"nullable": true,
"description": "Private cloud ID (nullable)",
"example": null
},
"custom_sku": {
"type": "string",
"nullable": true,
"description": "Custom SKU details (nullable)",
"example": null
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "string",
"description": "Success or error message",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/": {
"get": {
"operationId": "get-serving-inference-inference-id",
"summary": "Model Endpoint Details",
"tags": [
"Model Endpoints"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
},
"put": {
"operationId": "put-serving-inference-inference-id",
"summary": "Update/Actions (Start/Stop/Restart/Autoscale/Async)",
"tags": [
"Model Endpoints"
],
"description": "Use PUT to update model endpoint configuration or perform actions.\n\n| `action` value | Purpose |\n|--------------------------------|----------------------------------------------|\n| `patch` | Update endpoint configuration |\n| `restart` | Restart the running endpoint |\n| `stop` | Stop the endpoint |\n| `start` | Start a stopped endpoint |\n| `update_auto_scale` | Create or update the autoscaling policy |\n| `update_async_configuration` | Enable or disable async invocation |\n\n### Autoscaling metrics\n\nThe `metric` field in each rule supports:\n- **`concurrency`** — scales based on the number of concurrent in-flight requests.\n- **`requestRate`** — scales based on incoming requests per second.\n- **`custom`** — scales based on a framework-specific metric; requires `custom_metric_name`.\n\n### Async Invocation\n\nUse `action: \"update_async_configuration\"` to enable or disable async invocation.\n\n| `async_enabled` | Effect |\n|---|---|\n| `true` | Enables async invocation with the specified worker count and dataset destination |\n| `false` | Disables async invocation |\n\nWhen enabling, provide:\n- `async_concurrent_workers` — number of parallel async workers\n- `async_dataset_id` — ID of the dataset to store async results\n- `async_destination_type` — destination type (e.g. `\"dataset\"`)\n- `async_target_routes` — list of route mappings (`route_name` → `route_value`)\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the model configuration."
},
"path": {
"type": "string",
"description": "The path for the model configuration. Can be empty."
},
"custom_endpoint_details": {
"type": "object",
"properties": {
"service_port": {
"type": "boolean",
"description": "Whether a service port is enabled."
},
"metric_port": {
"type": "boolean",
"description": "Whether a metric port is enabled."
},
"container": {
"type": "object",
"properties": {
"advance_config": {
"type": "object",
"properties": {
"liveness_probe": {
"type": "object",
"properties": {
"commands": {
"type": "string",
"description": "Liveness probe commands."
}
}
},
"readiness_probe": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The readiness probe path."
},
"port": {
"type": "string",
"description": "The port for readiness probe."
},
"protocol": {
"type": "string",
"description": "The protocol for readiness probe."
},
"period_seconds": {
"type": "integer",
"description": "Period in seconds to check readiness."
},
"timeout_seconds": {
"type": "integer",
"description": "Timeout for readiness probe."
},
"failure_threshold": {
"type": "integer",
"description": "Failure threshold for readiness probe."
},
"success_threshold": {
"type": "integer",
"description": "Success threshold for readiness probe."
},
"initial_delay_seconds": {
"type": "integer",
"description": "Initial delay before readiness probe starts."
},
"commands": {
"type": "string",
"description": "Readiness probe commands."
}
}
},
"image_pull_policy": {
"type": "string",
"description": "The image pull policy."
},
"is_liveness_probe_enabled": {
"type": "boolean",
"description": "Whether the liveness probe is enabled."
},
"is_readiness_probe_enabled": {
"type": "boolean",
"description": "Whether the readiness probe is enabled."
}
}
},
"container_name": {
"type": "string",
"description": "The container image name."
},
"container_type": {
"type": "string",
"description": "The type of the container (e.g., public or private)."
},
"private_image_details": {
"type": "object",
"description": "Details about the private container image, if applicable."
}
}
},
"public_ip": {
"type": "string",
"description": "Whether a public IP is used (yes/no)."
},
"resource_details": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer",
"description": "Disk size in GB."
},
"mount_path": {
"type": "string",
"description": "Path to mount for resources."
},
"env_variables": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of environment variables for the container."
}
}
}
}
},
"model_id": {
"type": "string",
"description": "The model ID (null if not specified)."
},
"committed_replicas": {
"type": "integer",
"description": "Number of committed replicas."
},
"replica": {
"type": "integer",
"description": "Number of replicas to run."
},
"framework": {
"type": "string",
"description": "The framework used (e.g., vllm)."
},
"is_auto_scale_enabled": {
"type": "boolean",
"description": "Whether auto-scaling is enabled."
},
"auto_scale_policy": {
"type": "object",
"properties": {
"min_replicas": {
"type": "integer",
"description": "Minimum number of replicas for auto-scaling."
},
"max_replicas": {
"type": "integer",
"description": "Maximum number of replicas for auto-scaling."
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "Metric value for auto-scaling rule."
},
"metric": {
"type": "string",
"description": "Metric to track for auto-scaling."
},
"window": {
"type": "integer",
"description": "The window for metric evaluation."
},
"granularity": {
"type": "integer",
"description": "Granularity for evaluation."
},
"watch_period": {
"type": "integer",
"description": "Watch period for metric evaluation."
},
"condition_type": {
"type": "string",
"description": "The condition type for scaling."
},
"custom_metric_name": {
"type": "string",
"description": "The custom metric name if applicable."
}
}
}
},
"stability_period": {
"type": "string",
"description": "Stability period (in seconds) — minimum time the system waits after a scale event before evaluating again."
},
"initial_cooldown_period": {
"type": "string",
"description": "Cooldown period (in seconds) applied after the very first scale-up before further scaling decisions are evaluated."
},
"is_hold_queue": {
"type": "boolean",
"description": "When `true`, incoming requests are held in a queue while all replicas are busy. When `false`, excess requests are rejected immediately."
}
}
},
"detailed_info": {
"type": "object",
"properties": {
"args": {
"type": "string",
"description": "Arguments passed to the model."
},
"commands": {
"type": "string",
"description": "Commands executed for the model."
},
"info_log": {
"type": "boolean",
"description": "Whether info logging is enabled."
},
"error_log": {
"type": "boolean",
"description": "Whether error logging is enabled."
},
"tokenizer": {
"type": "string",
"description": "Tokenizer to use for model processing."
},
"world_size": {
"type": "integer",
"description": "The world size for distributed processing."
},
"engine_args": {
"type": "object",
"description": "Additional arguments for the model engine."
},
"warning_log": {
"type": "boolean",
"description": "Whether warning logging is enabled."
},
"server_version": {
"type": "string",
"description": "The server version for deployment."
},
"hugging_face_id": {
"type": "string",
"description": "The hugging face ID for the model."
},
"model_serve_type": {
"type": "string",
"description": "Type of model serving method."
},
"log_verbose_level": {
"type": "integer",
"description": "Log verbosity level."
}
}
},
"model_load_integration_id": {
"type": "integer",
"description": "Integration ID for model load."
},
"dataset_id": {
"type": "string",
"description": "Dataset ID associated with the model."
},
"dataset_path": {
"type": "string",
"description": "Path to the dataset if available."
},
"cluster_type": {
"type": "string",
"description": "The type of cluster for deployment."
},
"storage_type": {
"type": "string",
"description": "The storage type used (e.g., disk)."
},
"sfs_path": {
"type": "string",
"description": "Path for the shared file system."
},
"disk_path": {
"type": "string",
"description": "Path to the disk storage."
},
"sku_id": {
"type": "integer",
"description": "SKU ID for the model."
},
"sku_item_price_id": {
"type": "integer",
"description": "Price ID for the model."
},
"action": {
"type": "string",
"description": "The action to be performed (e.g., patch, restart, stop, start, update_auto_scale, update_async_configuration)."
},
"async_enabled": {
"type": "boolean",
"description": "Set true to enable async invocation, false to disable. Used with action: update_async_configuration."
},
"async_concurrent_workers": {
"type": "integer",
"description": "Number of parallel async workers. Required when enabling async invocation."
},
"async_dataset_id": {
"type": "integer",
"nullable": true,
"description": "ID of the dataset to store async results. Required when enabling async invocation."
},
"async_destination_type": {
"type": "string",
"nullable": true,
"description": "Destination type for async results (e.g. `\"dataset\"`)."
},
"async_target_routes": {
"type": "array",
"description": "List of route mappings for async inference.",
"items": {
"type": "object",
"properties": {
"route_name": {
"type": "string",
"description": "Internal queue name (e.g. `\"QUEUE_1\"`)."
},
"route_value": {
"type": "string",
"description": "Endpoint route to call (e.g. `\"predict\"`)."
}
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Action performed successfully on the model endpoint.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code.",
"example": 200
},
"data": {
"type": "string",
"description": "Message describing the result of the action performed.",
"example": "Model Endpoint restarted successfully"
},
"errors": {
"type": "object",
"additionalProperties": false
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-serving-inference-inference-id",
"summary": "Delete Model Endpoints",
"tags": [
"Model Endpoints"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Model endpoint details retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3035
},
"model": {
"type": "object",
"nullable": true
},
"dataset": {
"type": "object",
"nullable": true
},
"model_type": {
"type": "object",
"nullable": true
},
"sku": {
"type": "integer",
"example": 162
},
"name": {
"type": "string",
"example": "tir-endpoint-111516583333"
},
"storage_url": {
"type": "string",
"nullable": true
},
"dataset_storage_url": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"example": "Done"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-15T11:28:58.532961Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-15T11:51:05.587489Z"
},
"detailed_info": {
"type": "object",
"properties": {
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"info_log": {
"type": "boolean",
"example": true
},
"error_log": {
"type": "boolean",
"example": true
},
"tokenizer": {
"type": "string",
"example": ""
},
"world_size": {
"type": "integer",
"example": 1
},
"warning_log": {
"type": "boolean",
"example": true
},
"server_version": {
"type": "string",
"example": ""
},
"hugging_face_id": {
"type": "string",
"example": ""
},
"model_serve_type": {
"type": "string",
"example": ""
},
"log_verbose_level": {
"type": "integer",
"example": 1
}
}
},
"replica": {
"type": "integer",
"example": 1
},
"framework": {
"type": "string",
"example": "stable_diffusion_xl"
},
"custom_endpoint_details": {
"type": "object",
"properties": {
"container": {
"type": "object",
"properties": {
"advance_config": {
"type": "object",
"properties": {
"liveness_probe": {
"type": "object",
"additionalProperties": true
},
"readiness_probe": {
"type": "object",
"properties": {
"path": {
"type": "string",
"example": "/v2/health/ready"
},
"port": {
"type": "string",
"example": "8080"
},
"protocol": {
"type": "string",
"example": "http"
},
"period_seconds": {
"type": "integer",
"example": 10
},
"timeout_seconds": {
"type": "integer",
"example": 10
},
"failure_threshold": {
"type": "integer",
"example": 3
},
"success_threshold": {
"type": "integer",
"example": 1
},
"initial_delay_seconds": {
"type": "integer",
"example": 10
}
}
}
}
},
"image_pull_policy": {
"type": "string",
"example": "Always"
},
"is_liveness_probe_enabled": {
"type": "boolean",
"example": false
},
"is_readiness_probe_enabled": {
"type": "boolean",
"example": false
},
"container_name": {
"type": "string",
"example": "registry.e2enetworks.net/aimle2e/stable-diffusion-xl-base-1.0:hf"
},
"container_type": {
"type": "string",
"example": "public"
},
"private_image_details": {
"type": "object",
"additionalProperties": false
}
}
},
"public_ip": {
"type": "string",
"example": "no"
},
"resource_details": {
"type": "object",
"properties": {
"disk_size": {
"type": "integer",
"example": 100
},
"mount_path": {
"type": "string",
"example": ""
},
"env_variables": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"message": {
"type": "string",
"example": ""
},
"auto_scale_policy": {
"type": "object",
"properties": {
"min_replicas": {
"type": "integer",
"example": 1
},
"max_replicas": {
"type": "integer",
"example": 1
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"example": 100
},
"metric": {
"type": "string",
"example": ""
},
"window": {
"type": "integer",
"example": 1
},
"granularity": {
"type": "integer",
"example": 1
},
"watch_period": {
"type": "integer",
"example": 60
},
"condition_type": {
"type": "string",
"example": "limit"
},
"custom_metric_name": {
"type": "string",
"example": ""
}
}
}
},
"stability_period": {
"type": "string",
"example": "300"
}
}
},
"is_auto_scale_enabled": {
"type": "boolean",
"example": false
},
"desired_replica": {
"type": "integer",
"example": 1
},
"model_load_integration_id": {
"type": "integer",
"example": 428
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 162
},
"name": {
"type": "string",
"example": "GDC.1xH200-30.375GB_SXM"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 30
},
"gpu": {
"type": "integer",
"example": 1
},
"memory": {
"type": "integer",
"example": 375
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 755
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 470.4
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Hourly Compute Instance: inference_service"
}
}
}
}
},
"committed_info": {
"type": "object",
"nullable": true
},
"committed_replicas": {
"type": "integer",
"example": 0
},
"private_cloud_id": {
"type": "object",
"nullable": true
},
"custom_sku": {
"type": "object",
"nullable": true
}
}
},
"errors": {
"type": "object",
"additionalProperties": false
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/async_config/": {
"get": {
"operationId": "get-async-invocation-config",
"summary": "Get Async Invocation Config",
"tags": [
"Model Endpoints"
],
"description": "Returns the current async invocation configuration for the model endpoint.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Current async invocation configuration for the endpoint.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"async_concurrent_workers": {
"type": "integer",
"description": "Number of parallel async workers configured.",
"example": 0
},
"async_enabled": {
"type": "boolean",
"description": "Whether async invocation is currently enabled.",
"example": false
},
"async_dataset": {
"type": "object",
"nullable": true,
"description": "Dataset object used for async results (null if not set).",
"example": null
},
"async_dataset_id": {
"type": "integer",
"nullable": true,
"description": "ID of the dataset used for async results.",
"example": null
},
"async_target_routes": {
"type": "array",
"description": "List of route mappings for async inference.",
"items": {
"type": "object",
"properties": {
"route_name": {
"type": "string",
"description": "Internal queue name.",
"example": "QUEUE_1"
},
"route_value": {
"type": "string",
"description": "Endpoint route to call.",
"example": "predict"
}
}
}
},
"async_destination_type": {
"type": "string",
"nullable": true,
"description": "Destination type for async results (e.g. `\"dataset\"`).",
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/alerts/": {
"get": {
"operationId": "list-inference-alerts",
"summary": "List Alerts",
"tags": [
"Model Endpoints"
],
"description": "Returns all alerts attached to a model endpoint, with pagination support.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "Page number for pagination.",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page.",
"schema": {
"type": "integer",
"default": 5
}
}
],
"responses": {
"200": {
"description": "Paginated list of alerts attached to the model endpoint.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Attachment record ID."
},
"inference": {
"type": "integer",
"description": "Model endpoint ID."
},
"inference_name": {
"type": "string",
"description": "Model endpoint name."
},
"alert": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"metric_type": {
"type": "string"
},
"metric_type_unit": {
"type": "string"
},
"operator": {
"type": "string"
},
"threshold_value": {
"type": "number"
},
"severity": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"alert_name": {
"type": "string"
},
"grafana_rule_uid": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"is_firing": {
"type": "boolean",
"description": "Whether the alert is currently firing."
}
}
}
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"description": "Total number of pages."
},
"total_count": {
"type": "integer",
"description": "Total number of attached alerts."
}
}
}
}
}
}
}
},
"post": {
"operationId": "attach-inference-alert",
"summary": "Attach Alert",
"tags": [
"Model Endpoints"
],
"description": "Attach an existing alert to a model endpoint.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"alert_id": {
"type": "string",
"description": "The ID of the alert to attach to the model endpoint."
}
},
"required": [
"alert_id"
]
},
"example": {
"alert_id": "44"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Alert attached to the model endpoint successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Attachment record ID. Use this to detach the alert."
},
"inference": {
"type": "integer"
},
"inference_name": {
"type": "string"
},
"alert": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"location": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"metric_type": {
"type": "string"
},
"metric_type_unit": {
"type": "string"
},
"operator": {
"type": "string"
},
"threshold_value": {
"type": "number"
},
"severity": {
"type": "string"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"alert_name": {
"type": "string"
},
"grafana_rule_uid": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/alerts/{alert_attachment_id}/": {
"delete": {
"operationId": "detach-inference-alert",
"summary": "Detach Alert",
"tags": [
"Model Endpoints"
],
"description": "Detach an alert from a model endpoint using the attachment record ID returned by the Attach Alert API.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "alert_attachment_id",
"in": "path",
"required": true,
"description": "The attachment record ID returned when the alert was attached (the `id` field in the Attach Alert response).",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Alert detached from the model endpoint successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object"
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Inference alert detached successfully"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/security-groups/": {
"get": {
"operationId": "get-inference-security-groups",
"summary": "Get Attached Security Groups",
"tags": [
"Model Endpoints"
],
"description": "Returns all security groups currently attached to the model endpoint.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "List of security groups attached to the model endpoint.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of attached security group objects. Empty if none attached."
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "attach-inference-security-group",
"summary": "Attach Security Group",
"tags": [
"Model Endpoints"
],
"description": "Attach one or more security groups to the model endpoint.\n\n> **Note:** To get a list of available security groups, use the **Security Groups** section of the API (`GET /projects/{Project_Id}/security_groups/`).\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"security_groups_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of security group IDs to attach to the model endpoint."
}
},
"required": [
"security_groups_ids"
]
},
"example": {
"security_groups_ids": [
7245
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Security group attach or detach operation result.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string"
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/security-groups/{sg_id}/": {
"delete": {
"operationId": "detach-inference-security-group",
"summary": "Detach Security Group",
"tags": [
"Model Endpoints"
],
"description": "Detach a security group from the model endpoint.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "sg_id",
"in": "path",
"required": true,
"description": "ID of the security group to detach.",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
}
},
"/serving/inference/{inference_id}/vpc_ips/{vpc_ip_id}/": {
"post": {
"operationId": "attach-inference-vpc-ip",
"summary": "Attach VPC IP",
"tags": [
"Model Endpoints"
],
"description": "Attach a reserved VPC IP to the model endpoint.\n\n> **Note:** A reserved VPC IP must exist in your TIR account before attaching. Reserve IPs under **Network → Reserve IP** in the TIR.\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vpc_ip_id",
"in": "path",
"required": true,
"description": "ID of the reserved VPC IP to attach.",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "VPC IP attach scheduled successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string"
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "detach-inference-vpc-ip",
"summary": "Detach VPC IP",
"tags": [
"Model Endpoints"
],
"description": "Detach a VPC IP from the model endpoint.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "vpc_ip_id",
"in": "path",
"required": true,
"description": "ID of the VPC IP to detach.",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "VPC IP detach scheduled successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string"
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/project/p-{Project_Id}/endpoint/is-{Endpoint_Id}/v1/chat/completions": {
"post": {
"operationId": "post-project-p-project-id-endpoint-is-endpoint-id-v1-chat-completions",
"summary": "Chat Completions",
"tags": [
"Playground API"
],
"description": "Generate chat completions using a deployed model endpoint. Supports any model deployed via TIR Inference Service, following the OpenAI-compatible chat completions API format.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Endpoint_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"model",
"messages"
],
"properties": {
"model": {
"type": "string",
"description": "The model identifier to use for completion.",
"example": "your-model-name"
},
"messages": {
"type": "array",
"description": "A list of messages comprising the conversation so far.",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"system",
"assistant"
],
"example": "user"
},
"content": {
"type": "string",
"example": "Hello!!"
}
}
}
},
"max_tokens": {
"type": "integer",
"description": "Maximum number of tokens to generate in the response.",
"example": 512
},
"temperature": {
"type": "number",
"description": "Controls randomness. Lower values make output more deterministic, higher values more creative.",
"example": 0.7
},
"top_p": {
"type": "number",
"description": "Nucleus sampling probability mass. Only tokens with cumulative probability up to top_p are considered.",
"example": 1
},
"top_k": {
"type": "integer",
"description": "Limits the number of highest-probability tokens considered at each step.",
"example": 50
},
"frequency_penalty": {
"type": "number",
"description": "Penalizes tokens based on how frequently they have appeared in the text so far.",
"example": 0
},
"stream": {
"type": "boolean",
"description": "If true, responses are streamed as server-sent events.",
"example": false
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful chat completion response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the completion.",
"example": "chatcmpl-ab36a36c-2315-472f-9e58-0f68f19b8bf8"
},
"object": {
"type": "string",
"description": "Object type, always `chat.completion`.",
"example": "chat.completion"
},
"created": {
"type": "integer",
"description": "Unix timestamp of when the completion was created.",
"example": 1776750085
},
"model": {
"type": "string",
"description": "The model used for the completion.",
"example": "meta-llama/Llama-3.2-1B-Instruct"
},
"choices": {
"type": "array",
"description": "List of generated completion choices.",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"example": 0
},
"message": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "assistant"
},
"content": {
"type": "string",
"example": "In Nature's embrace, I find my peace,\nA world of wonder, a world to cease,\nFrom mountains high to valleys low,\nA tapestry of life, in all its glow."
},
"refusal": {
"type": "string",
"nullable": true,
"example": null
},
"tool_calls": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"reasoning": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"logprobs": {
"type": "string",
"nullable": true,
"example": null
},
"finish_reason": {
"type": "string",
"example": "stop"
},
"stop_reason": {
"type": "string",
"nullable": true,
"example": null
},
"token_ids": {
"type": "string",
"nullable": true,
"example": null
}
}
}
},
"service_tier": {
"type": "string",
"nullable": true,
"example": null
},
"system_fingerprint": {
"type": "string",
"nullable": true,
"example": null
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "integer",
"example": 40
},
"completion_tokens": {
"type": "integer",
"example": 274
},
"total_tokens": {
"type": "integer",
"example": 314
},
"prompt_tokens_details": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"prompt_logprobs": {
"type": "string",
"nullable": true,
"example": null
},
"prompt_token_ids": {
"type": "string",
"nullable": true,
"example": null
},
"kv_transfer_params": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
}
}
}
}
},
"/model_evaluation/": {
"get": {
"operationId": "get-model-evaluation",
"summary": "List Model Evaluation Jobs",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"message": {
"type": "string"
},
"total_page_number": {
"type": "integer"
},
"total_count": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"project_id": {
"type": "integer"
},
"input_dataset": {
"type": "string",
"nullable": true
},
"input_dataset_config": {
"type": "object",
"properties": {
"dataset_path": {
"type": "string",
"nullable": true
},
"hf_dataset_name": {
"type": "string"
},
"custom_hf_dataset_name": {
"type": "string"
},
"dataset_split": {
"type": "string"
},
"input_column": {
"type": "string"
},
"output_column": {
"type": "string"
},
"reference_answer_column": {
"type": "string"
},
"num_rows_limit": {
"type": "integer"
},
"dataset_type": {
"type": "string"
}
}
},
"output_dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"project_id": {
"type": "integer"
},
"storage_type": {
"type": "string"
},
"status": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"framework": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"description": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
}
}
}
}
}
},
"evaluator_llm_name": {
"type": "string"
},
"evaluation_config": {
"type": "object",
"properties": {
"temperature": {
"type": "number"
},
"max_tokens": {
"type": "integer"
},
"top_p": {
"type": "number"
}
}
},
"status": {
"type": "string"
},
"run": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"run_id": {
"type": "string"
},
"state": {
"type": "string"
},
"progress": {
"type": "string"
},
"finished_at": {
"type": "string",
"format": "date-time"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"source": {
"type": "string"
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-model-evaluation",
"summary": "Create Model Evaluation",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "tir-job-021915025656"
},
"input_dataset_id": {
"type": "string",
"example": ""
},
"output_dataset_id": {
"type": "string",
"example": "async-invocations-02171142022"
},
"input_dataset_config": {
"type": "object",
"properties": {
"dataset_type": {
"type": "string",
"enum": [
"huggingface",
"EOS Dataset"
],
"example": "huggingface"
},
"dataset_split": {
"type": "string",
"example": "train"
},
"input_column": {
"type": "string",
"example": "question"
},
"output_column": {
"type": "string",
"example": "answer"
},
"reference_answer_column": {
"type": "string",
"example": ""
},
"num_rows_limit": {
"type": "integer",
"example": -1
},
"custom_hf_dataset_name": {
"type": "string",
"example": ""
},
"hf_dataset_name": {
"type": "string",
"enum": [
"GAIR/o1-journey",
"chenle015/OpenMP_Question_Answering",
"sujayC66/text_summarization_512_length_1_2000",
"JeswinMS4/code_text_classification"
],
"example": "GAIR/o1-journey"
}
}
},
"framework_id": {
"type": "integer",
"example": 1,
"description": "1 - text-summarization\n2 - general_assistant\n3 - question_answering\n4 - text_classification\n"
},
"evaluator_llm_id": {
"type": "integer",
"example": 2,
"description": "1 - llama3_2_3b_instruct\n2 - llama3_1_8b_instruct\n"
},
"evaluation_config": {
"type": "object",
"properties": {
"temperature": {
"type": "number",
"format": "float",
"minimum": 0,
"maximum": 1,
"example": 0
},
"max_tokens": {
"type": "integer",
"minimum": 16,
"maximum": 2000,
"example": 1024
},
"top_p": {
"type": "number",
"format": "float",
"minimum": 0,
"maximum": 1,
"example": 1
}
}
},
"model_evaluation_prompt": {
"type": "string",
"example": "test"
},
"sku_item_price_id": {
"type": "integer",
"description": "SKU item price ID for the evaluation job. This value is region-specific.\nUse the plans-and-pricing API to get valid IDs for your region.\n",
"example": 207
},
"huggingface_integration_id": {
"type": "string",
"nullable": true,
"example": null
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Evaluation request created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 126
},
"name": {
"type": "string",
"example": "tir-job-021915025656"
},
"project_id": {
"type": "integer",
"example": 4528
},
"input_dataset": {
"type": "string",
"nullable": true,
"example": null
},
"input_dataset_config": {
"type": "object",
"properties": {
"dataset_path": {
"type": "string",
"nullable": true,
"example": null
},
"hf_dataset_name": {
"type": "string",
"example": "GAIR/o1-journey"
},
"custom_hf_dataset_name": {
"type": "string",
"example": ""
},
"dataset_split": {
"type": "string",
"example": "train"
},
"custom_dataset_split": {
"type": "string",
"nullable": true,
"example": null
},
"input_column": {
"type": "string",
"example": "question"
},
"output_column": {
"type": "string",
"example": "answer"
},
"reference_answer_column": {
"type": "string",
"example": ""
},
"num_rows_limit": {
"type": "integer",
"example": -1
},
"dataset_type": {
"type": "string",
"example": "huggingface"
}
}
},
"output_dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1617
},
"name": {
"type": "string",
"example": "async-invocations-02171142022"
},
"project_id": {
"type": "integer",
"example": 4528
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true,
"example": null
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3068
},
"bucket_name": {
"type": "string",
"example": "d-gpu-6a93eb6a-5a3e-411e-80ec-b91b31e7a93f"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-6a93eb6a-5a3e-411e-80ec-b91b31e7a93f/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 11488
}
}
},
"status": {
"type": "string",
"example": "OK"
}
}
},
"framework": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"name": {
"type": "string",
"example": "general_assistant"
},
"display_name": {
"type": "string",
"example": "General Assistant"
},
"description": {
"type": "string",
"example": "Use this metric for evaluating the general assistant capability of your LLM."
}
}
},
"evaluator_llm_name": {
"type": "string",
"example": "llama3_2_3b_instruct"
},
"status": {
"type": "string",
"example": "Creating"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-19T09:34:52.615513Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/model_evaluation/genai_evaluation_models/": {
"get": {
"operationId": "get-model-evaluation-genai-evaluation-models",
"summary": "Get available GenAI evaluation models",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 25
},
"name": {
"type": "string",
"example": "llama3_2_3b_instruct"
},
"display_name": {
"type": "string",
"example": "Llama 3.2 3B Instruct"
},
"category": {
"type": "string",
"example": "txt2txt"
},
"description": {
"type": "string",
"example": "This low-latency model is perfect for text summarization, classification, and language translation, ideal for mobile writing assistants and customer service apps."
},
"is_active": {
"type": "boolean",
"example": true
},
"url_info": {
"type": "string",
"example": "{}"
},
"icon": {
"type": "string",
"example": "/framework/Llama-3.2-3B-Instruct.png"
},
"total_runs_count": {
"type": "integer",
"example": 0
},
"is_internal": {
"type": "boolean",
"example": false
},
"is_inventory_available": {
"type": "boolean",
"example": true
}
}
},
"pricing": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"example": "INR"
},
"cost_per_n_input_tokens": {
"type": "number",
"example": 54.6
},
"cost_per_n_output_tokens": {
"type": "number",
"example": 231
},
"n_value": {
"type": "integer",
"example": 1000000
}
}
},
"is_model_available_for_evaluation": {
"type": "boolean",
"example": true
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/model_evaluation/evaluation_frameworks": {
"get": {
"operationId": "get-model-evaluation-evaluation-frameworks",
"summary": "Get evaluation frameworks",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with evaluation frameworks",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"description": {
"type": "string"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"display_name": {
"type": "string"
}
}
}
},
"is_internal": {
"type": "boolean"
}
}
}
},
"errors": {
"type": "object"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/model_evaluation/{evaluation_id}/metric_results/": {
"get": {
"operationId": "get-model-evaluation-evaluation-id-metric-results",
"summary": "Retrieve model evaluation result",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "evaluation_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful response with evaluation metrics",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"completeness": {
"type": "object",
"properties": {
"mean": {
"type": "number",
"format": "float",
"example": 3.7737
},
"median": {
"type": "number",
"format": "float",
"example": 5
},
"std_dev": {
"type": "number",
"format": "float",
"example": 1.4954
},
"min": {
"type": "integer",
"example": 0
},
"max": {
"type": "integer",
"example": 5
},
"count": {
"type": "integer",
"example": 327
},
"invalid_count": {
"type": "integer",
"example": 0
}
}
},
"correctness": {
"type": "object",
"properties": {
"mean": {
"type": "number",
"format": "float",
"example": 3.7737
},
"median": {
"type": "number",
"format": "float",
"example": 5
},
"std_dev": {
"type": "number",
"format": "float",
"example": 1.4954
},
"min": {
"type": "integer",
"example": 0
},
"max": {
"type": "integer",
"example": 5
},
"count": {
"type": "integer",
"example": 327
},
"invalid_count": {
"type": "integer",
"example": 0
}
}
},
"precision": {
"type": "object",
"properties": {
"mean": {
"type": "number",
"format": "float",
"example": 3.7737
},
"median": {
"type": "number",
"format": "float",
"example": 5
},
"std_dev": {
"type": "number",
"format": "float",
"example": 1.4954
},
"min": {
"type": "integer",
"example": 0
},
"max": {
"type": "integer",
"example": 5
},
"count": {
"type": "integer",
"example": 327
},
"invalid_count": {
"type": "integer",
"example": 0
}
}
},
"toxicity": {
"type": "object",
"properties": {
"mean": {
"type": "number",
"format": "float",
"example": 3.7737
},
"median": {
"type": "number",
"format": "float",
"example": 5
},
"std_dev": {
"type": "number",
"format": "float",
"example": 1.4954
},
"min": {
"type": "integer",
"example": 0
},
"max": {
"type": "integer",
"example": 5
},
"count": {
"type": "integer",
"example": 327
},
"invalid_count": {
"type": "integer",
"example": 0
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/model_evaluation/{evaluation_id}/": {
"put": {
"operationId": "put-model-evaluation-evaluation-id",
"summary": "Terminate and Retry Model Evaluation Job",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "evaluation_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"enum": [
"retry",
"terminate"
]
}
}
],
"responses": {
"200": {
"description": "Successful termination",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {
"type": "object"
},
"errors": {
"type": "object"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-model-evaluation-evaluation-id",
"summary": "Delete Model Evaluation Job",
"tags": [
"Model Evaluation"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "evaluation_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 126
},
"name": {
"type": "string",
"example": "tir-job-021915025656"
},
"project_id": {
"type": "integer",
"example": 4528
},
"input_dataset": {
"type": "string",
"nullable": true,
"example": null
},
"input_dataset_config": {
"type": "object",
"properties": {
"dataset_path": {
"type": "string",
"nullable": true,
"example": null
},
"hf_dataset_name": {
"type": "string",
"example": "GAIR/o1-journey"
},
"custom_hf_dataset_name": {
"type": "string",
"example": ""
},
"dataset_split": {
"type": "string",
"example": "train"
},
"input_column": {
"type": "string",
"example": "question"
},
"output_column": {
"type": "string",
"example": "answer"
},
"num_rows_limit": {
"type": "integer",
"example": -1
},
"dataset_type": {
"type": "string",
"example": "huggingface"
}
}
},
"output_dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1617
},
"name": {
"type": "string",
"example": "async-invocations-02171142022"
},
"storage_type": {
"type": "string",
"example": "managed"
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3068
},
"bucket_name": {
"type": "string",
"example": "d-gpu-6a93eb6a-5a3e-411e-80ec-b91b31e7a93f"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-6a93eb6a-5a3e-411e-80ec-b91b31e7a93f/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
}
}
}
}
},
"framework": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"name": {
"type": "string",
"example": "general_assistant"
},
"display_name": {
"type": "string",
"example": "General Assistant"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "relevance_metric"
},
"display_name": {
"type": "string",
"example": "Relevance"
}
}
}
}
}
},
"evaluator_llm_name": {
"type": "string",
"example": "llama3_2_3b_instruct"
},
"evaluation_config": {
"type": "object",
"properties": {
"temperature": {
"type": "number",
"example": 0
},
"max_tokens": {
"type": "integer",
"example": 1024
},
"top_p": {
"type": "number",
"example": 1
}
}
},
"status": {
"type": "string",
"example": "Deleting"
},
"run": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2787
},
"name": {
"type": "string",
"example": "tir-job-021915025656"
},
"state": {
"type": "string",
"example": "Succeeded"
},
"progress": {
"type": "string",
"example": "1/1"
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4877
},
"name": {
"type": "string",
"example": "Meghna Meghna"
},
"email": {
"type": "string",
"example": "meghna@e2enetworks.com"
}
}
}
}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/model_playground/": {
"get": {
"operationId": "get-model-playground",
"summary": "Model List",
"tags": [
"GenAI API"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with a list of AI models.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code.",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique ID of the model.",
"example": 26
},
"name": {
"type": "string",
"description": "Name of the model.",
"example": "llama_3_2_11b_vision_instruct"
},
"display_name": {
"type": "string",
"description": "Display name of the model.",
"example": "Llama 3.2 11B Vision Instruct"
},
"category": {
"type": "string",
"description": "Category of the model (e.g., txt2txt, txt2img).",
"example": "multimodal"
},
"description": {
"type": "string",
"description": "Description of the model's capabilities and use cases.",
"example": "Llama 3.2 Vision Instruct is designed for commercial and research use..."
},
"is_active": {
"type": "boolean",
"description": "Indicates whether the model is active.",
"example": true
},
"icon": {
"type": "string",
"description": "URL or path to the model's icon image.",
"example": "/framework/llama3_vision.jpg"
},
"total_runs_count": {
"type": "integer",
"description": "Total number of times the model has been run.",
"example": 2342
},
"is_internal": {
"type": "boolean",
"description": "Indicates if the model is internal.",
"example": false
},
"is_inventory_available": {
"type": "boolean",
"description": "Indicates if the model is available in inventory.",
"example": true
}
}
}
},
"errors": {
"type": "object",
"description": "Errors encountered, if any.",
"example": {}
},
"message": {
"type": "string",
"description": "A message indicating the status of the operation.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/datasets/genai/objects/urls/": {
"get": {
"operationId": "get-datasets-genai-objects-urls",
"summary": "Generate upload URL",
"tags": [
"GenAI API"
],
"description": "This API allows users to generate an upload URL for dataset objects.\nUser must update the `file_name` of the file he is going to upload.\nCopy the `upload_url` to use in a the put file request.\n",
"parameters": [
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"upload"
]
}
},
{
"name": "file_name",
"in": "query",
"required": true,
"schema": {
"type": "string",
"example": "IMG_20240827_233637.jpg"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully generated upload URL",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"upload_url": {
"type": "string",
"format": "uri",
"example": "https://objectstore.e2enetworks.net/d-gpu-0eb7f421-74cf-4fc4-b7ed-ad6131c261b6/4543-1738835747-0.wav?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=K8%2rT%2F20%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=786423&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=t7832r9tugvi7"
},
"model_input_url": {
"type": "string",
"example": "/mnt/data/4543-1738742155-IMG_20240827_233637.jpg"
},
"file_path": {
"type": "string",
"example": "4543-1738742155-IMG_20240827_233637.jpg"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/project/p-{Project_Id}/genai/llama3_1_8b_instruct/v1/chat/completions": {
"post": {
"operationId": "post-project-p-project-id-genai-llama3-1-8b-instruct-v1-chat-completions",
"summary": "Llama 3.1 8B Instruct",
"tags": [
"GenAI API"
],
"description": "Llama 3.1 represents Meta's most advanced language model to date. It integrates state-of-the-art techniques in natural language processing to deliver unparalleled performance in various tasks.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"temperature": {
"type": "number",
"default": 0.5
},
"max_tokens": {
"type": "integer",
"default": 1024
},
"top_p": {
"type": "number",
"default": 1
},
"frequency_penalty": {
"type": "number",
"default": 0
},
"presence_penalty": {
"type": "number",
"default": 1
},
"stream": {
"type": "boolean",
"default": false
},
"model": {
"type": "string",
"example": "llama3_1_8b_instruct"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "user"
},
"content": {
"type": "string",
"example": "Hello"
}
}
}
}
}
}
}
}
},
"responses": {
"default": {
"description": "Successful response (Non-streaming)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "chat-a8fa533f74b346688f780c3b2e14638f"
},
"object": {
"type": "string",
"example": "chat.completion"
},
"created": {
"type": "integer",
"example": 1738753122
},
"model": {
"type": "string",
"example": "llama3_1_8b_instruct"
},
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"example": 0
},
"message": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "assistant"
},
"content": {
"type": "string",
"example": "It looks like we're saying hello twice. How's your day going so far?"
},
"tool_calls": {
"type": "array",
"items": {
"type": "string"
},
"example": []
}
}
},
"logprobs": {
"type": "string",
"nullable": true
},
"finish_reason": {
"type": "string",
"example": "stop"
},
"stop_reason": {
"type": "string",
"nullable": true
}
}
}
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "integer",
"example": 56
},
"completion_tokens": {
"type": "integer",
"example": 18
},
"total_tokens": {
"type": "integer",
"example": 74
}
}
}
}
}
}
}
}
}
}
},
"/project/p-{Project_Id}/genai/qwen3_32b/v1/chat/completions": {
"post": {
"operationId": "post-project-p-project-id-genai-qwen3-32b-v1-chat-completions",
"summary": "Qwen3 32B",
"tags": [
"GenAI API"
],
"description": "Qwen3-32B is a powerful reasoning model with strong performance in complex tasks, featuring built-in reasoning capabilities.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"temperature": {
"type": "number",
"example": 0.5
},
"max_tokens": {
"type": "integer",
"example": 1500
},
"top_p": {
"type": "number",
"example": 1
},
"frequency_penalty": {
"type": "number",
"example": 0
},
"presence_penalty": {
"type": "number",
"example": 1
},
"stream": {
"type": "boolean",
"example": false
},
"model": {
"type": "string",
"example": "qwen3_32b"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "user"
},
"content": {
"type": "string",
"example": "Can you write a poem about open source machine learning?"
}
}
}
}
}
}
}
}
},
"responses": {
"default": {
"description": "Successful response (Non-streaming)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "chatcmpl-fac93c60-a0c4-4fc8-9b75-bb41d8838e90"
},
"object": {
"type": "string",
"example": "chat.completion"
},
"created": {
"type": "integer",
"example": 1770613777
},
"model": {
"type": "string",
"example": "qwen3_32b"
},
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"example": 0
},
"message": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "assistant"
},
"reasoning_content": {
"type": "string",
"description": "The internal reasoning process of the model before generating the final response",
"example": "\nOkay, the user wants a poem about open source machine learning. Let me start by breaking down the key elements here..."
},
"content": {
"type": "string",
"example": "\n\n**Ode to Open Source Machine Learning** \n\nIn circuits deep where whispered code is sown..."
},
"tool_calls": {
"type": "array",
"items": {
"type": "string"
},
"example": []
}
}
},
"logprobs": {
"type": "string",
"nullable": true
},
"finish_reason": {
"type": "string",
"example": "stop"
},
"stop_reason": {
"type": "string",
"nullable": true
}
}
}
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "integer",
"example": 19
},
"total_tokens": {
"type": "integer",
"example": 670
},
"completion_tokens": {
"type": "integer",
"example": 651
},
"prompt_tokens_details": {
"type": "string",
"nullable": true
}
}
},
"prompt_logprobs": {
"type": "string",
"nullable": true
},
"kv_transfer_params": {
"type": "string",
"nullable": true
}
}
}
}
}
}
}
}
},
"/project/p-{Project_Id}/genai/gpt_oss_120b/v1/chat/completions": {
"post": {
"operationId": "post-project-p-project-id-genai-gpt-oss-120b-v1-chat-completions",
"summary": "GPT OSS 120B",
"tags": [
"GenAI API"
],
"description": "GPT OSS 120B is a large-scale open-source reasoning model with exceptional performance in complex reasoning tasks and natural language understanding.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"temperature": {
"type": "number",
"example": 0.5
},
"max_tokens": {
"type": "integer",
"example": 1024
},
"top_p": {
"type": "number",
"example": 1
},
"frequency_penalty": {
"type": "number",
"example": 0
},
"presence_penalty": {
"type": "number",
"example": 1
},
"stream": {
"type": "boolean",
"example": false
},
"model": {
"type": "string",
"example": "gpt_oss_120b"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "user"
},
"content": {
"type": "string",
"example": "Can you write a poem about open source machine learning?"
}
}
}
}
}
}
}
}
},
"responses": {
"default": {
"description": "Successful response (Non-streaming)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "chatcmpl-82c7e2c5-a99c-4869-8068-49aa705812ba"
},
"object": {
"type": "string",
"example": "chat.completion"
},
"created": {
"type": "integer",
"example": 1770614085
},
"model": {
"type": "string",
"example": "gpt_oss_120b"
},
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"example": 0
},
"message": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "assistant"
},
"content": {
"type": "string",
"example": "**Open-Source Machine Learning**\n\nIn a lattice of pull-requests and bright PRs, \nthe code breathes—free as wind through silicon trees..."
},
"refusal": {
"type": "string",
"nullable": true
},
"annotations": {
"type": "string",
"nullable": true
},
"audio": {
"type": "string",
"nullable": true
},
"function_call": {
"type": "string",
"nullable": true
},
"tool_calls": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"reasoning": {
"type": "string",
"description": "The internal reasoning process of the model before generating the final response",
"example": "The user asks: \"Can you write a poem about open source machine learning?\" So we need to produce a poem..."
},
"reasoning_content": {
"type": "string",
"description": "The internal reasoning process of the model (duplicate field for compatibility)",
"example": "The user asks: \"Can you write a poem about open source machine learning?\" So we need to produce a poem..."
}
}
},
"logprobs": {
"type": "string",
"nullable": true
},
"finish_reason": {
"type": "string",
"example": "stop"
},
"stop_reason": {
"type": "string",
"nullable": true
},
"token_ids": {
"type": "string",
"nullable": true
}
}
}
},
"service_tier": {
"type": "string",
"nullable": true
},
"system_fingerprint": {
"type": "string",
"nullable": true
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "integer",
"example": 76
},
"total_tokens": {
"type": "integer",
"example": 461
},
"completion_tokens": {
"type": "integer",
"example": 385
},
"prompt_tokens_details": {
"type": "string",
"nullable": true
}
}
},
"prompt_logprobs": {
"type": "string",
"nullable": true
},
"prompt_token_ids": {
"type": "string",
"nullable": true
},
"kv_transfer_params": {
"type": "string",
"nullable": true
}
}
}
}
}
}
}
}
},
"/project/p-{Project_Id}/genai/sarvam_translate/v1/chat/completions": {
"post": {
"operationId": "post-project-p-project-id-genai-sarvam-translate-v1-chat-completions",
"summary": "Sarvam Translate",
"tags": [
"GenAI API"
],
"description": "Sarvam Translate is a multilingual translation model specializing in Indian languages, enabling seamless translation across multiple language pairs.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"temperature": {
"type": "number",
"example": 0.5
},
"max_tokens": {
"type": "integer",
"example": 300
},
"top_p": {
"type": "number",
"example": 1
},
"frequency_penalty": {
"type": "number",
"example": 0
},
"presence_penalty": {
"type": "number",
"example": 1
},
"stream": {
"type": "boolean",
"example": false
},
"model": {
"type": "string",
"example": "sarvam_translate"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"system",
"user"
],
"example": "system"
},
"content": {
"type": "string",
"example": "Translate the text below to Hindi."
}
}
},
"example": [
{
"role": "system",
"content": "Translate the text below to Hindi."
},
{
"role": "user",
"content": "Can you write a poem about open source machine learning?"
}
]
}
}
}
}
}
},
"responses": {
"default": {
"description": "Successful response (Non-streaming)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "chatcmpl-5bf016be-7107-4157-98d7-badbf5293e95"
},
"object": {
"type": "string",
"example": "chat.completion"
},
"created": {
"type": "integer",
"example": 1770614476
},
"model": {
"type": "string",
"example": "sarvam_translate"
},
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"example": 0
},
"message": {
"type": "object",
"properties": {
"role": {
"type": "string",
"example": "assistant"
},
"reasoning_content": {
"type": "string",
"nullable": true
},
"content": {
"type": "string",
"description": "The translated text",
"example": "क्या आप ओपन सोर्स मशीन लर्निंग के बारे में कविता लिख सकते हैं?"
},
"tool_calls": {
"type": "array",
"items": {
"type": "string"
},
"example": []
}
}
},
"logprobs": {
"type": "string",
"nullable": true
},
"finish_reason": {
"type": "string",
"example": "stop"
},
"stop_reason": {
"type": "string",
"nullable": true
}
}
}
},
"usage": {
"type": "object",
"properties": {
"prompt_tokens": {
"type": "integer",
"example": 28
},
"total_tokens": {
"type": "integer",
"example": 43
},
"completion_tokens": {
"type": "integer",
"example": 15
},
"prompt_tokens_details": {
"type": "string",
"nullable": true
}
}
},
"prompt_logprobs": {
"type": "string",
"nullable": true
},
"kv_transfer_params": {
"type": "string",
"nullable": true
}
}
}
}
}
}
}
}
},
"/finetuning/model_types/": {
"get": {
"operationId": "get-finetuning-model-types",
"summary": "Model Types",
"tags": [
"Fine Tune Models"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with a list of models.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "array",
"description": "List of models.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the model.",
"example": "meta-llama/Llama-2-7b-hf"
},
"description": {
"type": "string",
"description": "A brief description of the model.",
"example": "Model For Finetuning LLAMA"
},
"is_internal": {
"type": "boolean",
"description": "Indicates if the model is internal.",
"example": false
},
"model_icon_url": {
"type": "string",
"description": "URL for the model icon image.",
"example": "/framework/llma2.jpeg"
}
}
}
},
"errors": {
"type": "object",
"description": "Contains any errors that occurred.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message confirming the operation.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/finetuning/": {
"get": {
"operationId": "get-finetuning",
"summary": "Fine Tuning List",
"tags": [
"Fine Tune Models"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with a list of training job details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "array",
"description": "List of training job details.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the training job.",
"example": 810
},
"name": {
"type": "string",
"description": "Name of the training job.",
"example": "tir-finetuning-111511093030"
},
"model_name": {
"type": "string",
"description": "Name of the model used for training.",
"example": "stabilityai/stable-diffusion-2-1"
},
"training_inputs": {
"type": "object",
"description": "Configuration of the training job.",
"properties": {
"dataset": {
"type": "string",
"example": "lambdalabs/naruto-blip-captions"
},
"dataset_name": {
"type": "string",
"example": "lambdalabs/naruto-blip-captions"
},
"source_model_repo_info": {
"type": "string",
"example": ""
},
"source_repository_type": {
"type": "string",
"example": "base_model"
},
"source_model_path": {
"type": "string",
"example": ""
},
"task": {
"type": "string",
"example": "Instruction-Finetuning"
},
"dataset_type": {
"type": "string",
"example": "huggingface"
},
"train_batch_size": {
"type": "integer",
"example": 1
},
"gradient_accumulation_steps": {
"type": "integer",
"example": 1
},
"epochs": {
"type": "integer",
"example": 3
},
"max_steps": {
"type": "integer",
"example": -1
},
"checkpointing_steps": {
"type": "integer",
"example": 500
},
"checkpoints_total_limit": {
"type": "integer",
"example": 10
},
"peft_lora_r": {
"type": "integer",
"example": 64
},
"peft_lora_alpha": {
"type": "integer",
"example": 16
},
"load_in_8bit": {
"type": "boolean",
"example": false
},
"mixed_precision": {
"type": "string",
"example": "no"
},
"validation_prompt": {
"type": "string",
"example": "A photo of a man with green eyes"
},
"num_validation_images": {
"type": "integer",
"example": 2
},
"logging_steps": {
"type": "integer",
"example": 5
},
"learning_rate": {
"type": "number",
"format": "float",
"example": 0.0000141
},
"limit_training_records_count": {
"type": "integer",
"example": -1
},
"caption_column": {
"type": "string",
"example": "text"
},
"image_column": {
"type": "string",
"example": "image"
},
"save_strategy": {
"type": "string",
"example": "steps"
},
"stop_training_when": {
"type": "string",
"example": "epoch_count"
}
}
},
"run": {
"type": "object",
"description": "Details of the training run.",
"properties": {
"id": {
"type": "integer",
"example": 2444
},
"name": {
"type": "string",
"example": "tir-finetuning-111511093030"
},
"run_id": {
"type": "string",
"example": "b9177463-124d-4d98-94d8-2eec42ded928"
},
"state": {
"type": "string",
"example": "Pending"
},
"progress": {
"type": "string",
"example": ""
},
"finished_at": {
"type": "string",
"format": "date-time",
"example": "1970-01-01T00:00:00Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-15T06:10:07.626165Z"
},
"source": {
"type": "string",
"example": "finetuning"
},
"scheduled_job": {
"type": "string",
"example": null
}
}
},
"status": {
"type": "string",
"description": "Current status of the training job.",
"example": "Pending"
},
"created_by": {
"type": "object",
"description": "User details who created the job.",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-15T06:10:06.278937Z"
},
"hugging_face_integration_name": {
"type": "string",
"example": "tir"
},
"sku_item_price": {
"type": "object",
"description": "Pricing details for the training job.",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 763
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"unit_price": {
"type": "number",
"format": "float",
"example": 470.4
},
"currency": {
"type": "string",
"example": "INR"
}
}
},
"sku": {
"type": "object",
"description": "SKU information of the compute resource.",
"properties": {
"sku_id": {
"type": "integer",
"example": 166
},
"name": {
"type": "string",
"example": "GDC.1xH200-30.375GB_SXM"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 30
},
"gpu": {
"type": "integer",
"example": 1
},
"memory": {
"type": "number",
"format": "float",
"example": 375
}
}
}
}
}
},
"errors": {
"type": "object",
"description": "Contains any errors that occurred.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message confirming the operation.",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-finetuning",
"summary": "Create Fine Tune",
"tags": [
"Fine Tune Models"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the training job"
},
"training_type": {
"type": "string",
"description": "The type of training"
},
"training_inputs": {
"type": "object",
"description": "Configuration for training inputs",
"properties": {
"source_repository_type": {
"type": "string"
},
"dataset": {
"type": "string"
},
"dataset_type": {
"type": "string"
},
"validation_split_ratio": {
"type": "number"
},
"target_dataset_field": {
"type": "string"
},
"gradient_accumulation_steps": {
"type": "integer"
},
"context_length": {
"type": "integer"
},
"learning_rate": {
"type": "number"
},
"epochs": {
"type": "integer"
},
"stop_training_when": {
"type": "string"
},
"max_steps": {
"type": "integer"
},
"batch_size": {
"type": "integer"
},
"peft_lora_alpha": {
"type": "integer"
},
"peft_lora_r": {
"type": "integer"
},
"max_grad_norm": {
"type": "number"
},
"save_strategy": {
"type": "string"
},
"save_steps": {
"type": "integer"
},
"save_total_limit": {
"type": "integer"
},
"lora_dropout": {
"type": "number"
},
"lora_bias": {
"type": "string"
},
"load_in_4bit": {
"type": "boolean"
},
"image_column": {
"type": "string"
},
"caption_column": {
"type": "string"
},
"validation_prompt": {
"type": "string"
},
"num_validation_images": {
"type": "integer"
},
"train_batch_size": {
"type": "integer"
},
"load_in_8bit": {
"type": "boolean"
},
"mixed_precision": {
"type": "string"
},
"checkpointing_steps": {
"type": "integer"
},
"checkpoints_total_limit": {
"type": "integer"
},
"task": {
"type": "string"
},
"prompt_configuration": {
"type": "string"
}
}
},
"isClone": {
"type": "boolean"
},
"model_name": {
"type": "string"
},
"sku_item_price_id": {
"type": "integer"
},
"sku_item_plan": {
"type": "string"
},
"sku_item_price": {
"type": "string"
},
"huggingface_integration_id": {
"type": "integer"
}
},
"required": [
"name",
"training_type",
"training_inputs",
"model_name",
"sku_item_price_id",
"sku_item_plan",
"sku_item_price",
"huggingface_integration_id"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful response with training job details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "object",
"description": "Details of the training job.",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the training job.",
"example": 810
},
"name": {
"type": "string",
"description": "Name of the training job.",
"example": "tir-finetuning-111511093030"
},
"model_name": {
"type": "string",
"description": "Name of the model used for training.",
"example": "stabilityai/stable-diffusion-2-1"
},
"training_inputs": {
"type": "object",
"description": "Configuration of the training job.",
"properties": {
"dataset": {
"type": "string",
"description": "Dataset identifier.",
"example": "lambdalabs/naruto-blip-captions"
},
"dataset_name": {
"type": "string",
"description": "Name of the dataset.",
"example": "lambdalabs/naruto-blip-captions"
},
"source_model_repo_info": {
"type": "string",
"description": "Information about the source model repository.",
"example": ""
},
"source_repository_type": {
"type": "string",
"description": "Type of the source repository.",
"example": "base_model"
},
"source_model_path": {
"type": "string",
"description": "Path to the source model.",
"example": ""
},
"task": {
"type": "string",
"description": "Task type for training.",
"example": "Instruction-Finetuning"
},
"dataset_type": {
"type": "string",
"description": "Dataset type.",
"example": "huggingface"
},
"train_batch_size": {
"type": "integer",
"description": "Training batch size.",
"example": 1
},
"gradient_accumulation_steps": {
"type": "integer",
"description": "Number of gradient accumulation steps.",
"example": 1
},
"epochs": {
"type": "integer",
"description": "Number of training epochs.",
"example": 3
},
"max_steps": {
"type": "integer",
"description": "Maximum training steps.",
"example": -1
},
"checkpointing_steps": {
"type": "integer",
"description": "Number of steps between checkpoints.",
"example": 500
},
"checkpoints_total_limit": {
"type": "integer",
"description": "Total limit of checkpoints.",
"example": 10
},
"peft_lora_r": {
"type": "integer",
"description": "LoRA hyperparameter 'r'.",
"example": 64
},
"peft_lora_alpha": {
"type": "integer",
"description": "LoRA hyperparameter 'alpha'.",
"example": 16
},
"load_in_8bit": {
"type": "boolean",
"description": "Indicates if 8-bit loading is enabled.",
"example": false
},
"mixed_precision": {
"type": "string",
"description": "Type of mixed precision used.",
"example": "no"
},
"validation_prompt": {
"type": "string",
"description": "Prompt used for validation.",
"example": "A photo of a man with green eyes"
},
"num_validation_images": {
"type": "integer",
"description": "Number of validation images.",
"example": 2
},
"logging_steps": {
"type": "integer",
"description": "Number of steps between logging.",
"example": 5
},
"learning_rate": {
"type": "number",
"format": "float",
"description": "Learning rate for training.",
"example": 0.0000141
},
"limit_training_records_count": {
"type": "integer",
"description": "Limit on the number of training records.",
"example": -1
},
"caption_column": {
"type": "string",
"description": "Column used for captions.",
"example": "text"
},
"image_column": {
"type": "string",
"description": "Column used for images.",
"example": "image"
},
"save_strategy": {
"type": "string",
"description": "Strategy for saving checkpoints.",
"example": "steps"
},
"stop_training_when": {
"type": "string",
"description": "Condition to stop training.",
"example": "epoch_count"
}
}
},
"description": {
"type": "string",
"description": "Description of the training job.",
"example": null
},
"status": {
"type": "string",
"description": "Current status of the training job.",
"example": "Creating"
},
"created_by": {
"type": "object",
"description": "Details of the user who created the job.",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of job creation.",
"example": "2024-11-15T06:10:06.278937Z"
},
"hugging_face_integration_name": {
"type": "string",
"description": "Name of the Hugging Face integration.",
"example": "tir"
},
"sku_item_price": {
"type": "object",
"description": "Pricing details of the training job.",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 763
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 470.4
},
"currency": {
"type": "string",
"example": "INR"
},
"description": {
"type": "string",
"example": "Hourly Compute Instance: pipeline"
}
}
},
"sku": {
"type": "object",
"description": "SKU information for the compute resource.",
"properties": {
"sku_id": {
"type": "integer",
"example": 166
},
"name": {
"type": "string",
"example": "GDC.1xH200-30.375GB_SXM"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 30
},
"gpu": {
"type": "integer",
"example": 1
},
"memory": {
"type": "number",
"format": "float",
"example": 375
},
"is_free": {
"type": "boolean",
"example": false
}
}
}
}
},
"errors": {
"type": "object",
"description": "Contains any errors that occurred.",
"example": {}
},
"message": {
"type": "string",
"description": "Result message confirming the operation.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/finetuning/{FineTuneID}/": {
"put": {
"operationId": "put-finetuning-finetuneid",
"summary": "Retry/Terminate FineTune",
"tags": [
"Fine Tune Models"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "FineTuneID",
"in": "path",
"required": true,
"description": "FineTune id",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"enum": [
"retry",
"terminate"
]
}
}
],
"responses": {
"200": {
"description": "Successful operation response with no data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "object",
"description": "Empty object indicating no additional data.",
"example": {}
},
"errors": {
"type": "object",
"description": "Object to represent any errors; empty if no errors.",
"example": {}
},
"message": {
"type": "string",
"description": "A message indicating the success of the operation.",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-finetuning-finetuneid",
"summary": "Delete Fine Tune",
"tags": [
"Fine Tune Models"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "FineTuneID",
"in": "path",
"required": true,
"description": "FineTune id",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with finetuning job details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code.",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Job ID.",
"example": 810
},
"name": {
"type": "string",
"description": "Name of the finetuning job.",
"example": "tir-finetuning-111511093030"
},
"model_name": {
"type": "string",
"description": "Name of the model being fine-tuned.",
"example": "stabilityai/stable-diffusion-2-1"
},
"training_inputs": {
"type": "object",
"description": "Configuration details of the training job.",
"properties": {
"dataset": {
"type": "string",
"description": "The dataset used for finetuning.",
"example": "lambdalabs/naruto-blip-captions"
},
"epochs": {
"type": "integer",
"description": "Number of training epochs.",
"example": 3
},
"learning_rate": {
"type": "number",
"format": "float",
"description": "The learning rate for training.",
"example": 0.0000141
},
"validation_prompt": {
"type": "string",
"description": "A prompt used for validation.",
"example": "A photo of a man with green eyes"
},
"num_validation_images": {
"type": "integer",
"description": "Number of images used for validation.",
"example": 2
},
"mixed_precision": {
"type": "string",
"description": "The precision level used during training.",
"example": "no"
}
}
},
"run": {
"type": "object",
"description": "Details of the run state.",
"properties": {
"id": {
"type": "integer",
"description": "Run ID.",
"example": 2444
},
"state": {
"type": "string",
"description": "Current state of the job.",
"example": "Terminating"
},
"progress": {
"type": "string",
"description": "Progress of the run.",
"example": "0/1"
}
}
},
"status": {
"type": "string",
"description": "Overall status of the job.",
"example": "Deleting"
},
"created_by": {
"type": "object",
"description": "Creator information.",
"properties": {
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Nipun"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"sku_item_price": {
"type": "object",
"description": "Pricing information for the job.",
"properties": {
"unit_price": {
"type": "number",
"format": "float",
"description": "Price per unit time (e.g., hourly).",
"example": 470.4
},
"currency": {
"type": "string",
"description": "Currency code.",
"example": "INR"
}
}
}
}
},
"errors": {
"type": "object",
"description": "Errors encountered, if any.",
"example": {}
},
"message": {
"type": "string",
"description": "A message indicating the status of the operation.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/distributed_jobs_v2/deployment_images/{Framework}/": {
"get": {
"operationId": "get-distributed-jobs-v2-deployment-images-framework",
"summary": "List Cluster Images",
"tags": [
"Training Cluster"
],
"description": "Returns available Training Cluster images and their versions for the specified framework.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Framework",
"in": "path",
"required": true,
"description": "Framework type for which to list images.",
"schema": {
"type": "string",
"enum": [
"Slurm"
]
}
},
{
"name": "job_type",
"in": "query",
"required": true,
"description": "Job type filter — must match the path parameter value.",
"schema": {
"type": "string",
"enum": [
"Slurm"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with available cluster images and their versions.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Ubuntu Slurm"
},
"slug_name": {
"type": "string",
"example": "ubuntu-slurm"
},
"framework": {
"type": "string",
"example": "Slurm"
},
"description": {
"type": "string",
"example": ""
},
"is_internal": {
"type": "boolean",
"example": false
},
"versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"image_version_id": {
"type": "integer",
"example": 2
},
"version": {
"type": "string",
"example": "v2-slurm25.11-ubuntu24.04"
},
"description": {
"type": "string",
"example": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"is_internal": {
"type": "boolean",
"example": false
}
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/distributed_jobs_v2/cluster/plans/": {
"get": {
"operationId": "get-distributed-jobs-v2-cluster-plans",
"summary": "Training Cluster Plans",
"tags": [
"Training Cluster"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "variant",
"in": "query",
"required": true,
"description": "Cluster variant",
"schema": {
"type": "string",
"enum": [
"e2e"
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 309
},
"name": {
"type": "string",
"example": "GDC.8xH10080-208.2000GB_SXM_v1"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "string",
"example": "208"
},
"gpu": {
"type": "string",
"nullable": true,
"example": "8"
},
"memory": {
"type": "string",
"example": "2000GB"
},
"gpu_memory": {
"type": "string",
"example": "640GB"
},
"sku_type": {
"type": "string",
"example": "GDC-8xH10080"
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 3416
},
"sku_type": {
"type": "string",
"enum": [
"hourly",
"committed"
],
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"example": 1995.2
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": "Hourly Compute Instance: distributed_job"
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
},
"gpu_card_type": {
"type": "string",
"nullable": true,
"example": "H100"
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"available_inventory_count": {
"type": "integer",
"example": 0
},
"variant": {
"type": "string",
"example": "e2e"
},
"category": {
"type": "string",
"example": "distributed_job"
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"optimal_rack": {
"type": "string",
"nullable": true,
"example": null
},
"is_inventory_available": {
"type": "boolean",
"example": false
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/distributed_jobs_v2/cluster/": {
"get": {
"operationId": "get-distributed-jobs-v2-cluster",
"summary": "List Training Clusters",
"tags": [
"Training Cluster"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response with a list of training clusters.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
},
"is_primary_contact": {
"type": "boolean",
"example": true
},
"currency": {
"type": "string",
"example": "INR"
},
"is_suspended": {
"type": "boolean",
"example": false
}
}
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"no_of_gpu": {
"type": "string",
"example": "8"
},
"no_of_cpu": {
"type": "string",
"example": "208"
},
"node_memory": {
"type": "string",
"example": "2000GB"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-15T10:30:00Z"
},
"available_gpu": {
"type": "integer",
"example": 0
},
"available_cpu": {
"type": "integer",
"example": 0
},
"available_memory": {
"type": "string",
"example": "0GB"
},
"status": {
"type": "string",
"example": "Creating"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 309
},
"name": {
"type": "string",
"example": "GDC.8xH10080-208.2000GB_SXM_v1"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 208
},
"gpu": {
"type": "integer",
"example": 8
},
"memory": {
"type": "integer",
"example": 2000
},
"ephemeral_storage": {
"type": "integer",
"example": 0
},
"gpu_memory": {
"type": "integer",
"example": 640
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "GDC-8xH10080"
},
"gpu_card_type": {
"type": "string",
"nullable": true,
"example": "H100"
},
"category": {
"type": "string",
"example": "distributed_job"
},
"variant": {
"type": "string",
"example": "e2e"
},
"no_of_nodes": {
"type": "integer",
"example": 1
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 3416
},
"sku_type": {
"type": "string",
"enum": [
"hourly",
"committed"
],
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"example": 1995.2
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": "Hourly Compute Instance: distributed_job"
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
}
},
"private_cloud_name": {
"type": "string",
"nullable": true,
"example": null
},
"private_cloud_id": {
"type": "integer",
"nullable": true,
"example": null
},
"has_local_storage": {
"type": "boolean",
"example": false
},
"image_version": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"version": {
"type": "string",
"example": "v2-slurm25.11-ubuntu24.04"
},
"description": {
"type": "string",
"example": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"name": {
"type": "string",
"example": "Ubuntu Slurm"
},
"slug_name": {
"type": "string",
"example": "ubuntu-slurm"
},
"framework": {
"type": "string",
"example": "Slurm"
},
"is_internal": {
"type": "boolean",
"example": false
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-distributed-jobs-v2-cluster",
"summary": "Create Training Cluster",
"tags": [
"Training Cluster"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the training cluster."
},
"image_version_id": {
"type": "integer",
"description": "ID of the image version to use for cluster nodes (Ubuntu Slurm or NeMo)."
},
"ssh_key_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of SSH key IDs to attach to the cluster login node."
},
"security_group_id": {
"type": "integer",
"description": "Security group ID controlling inbound and outbound traffic to cluster nodes."
},
"script_added": {
"type": "boolean",
"description": "Whether a lifecycle script has been provided."
},
"lifecycle_script": {
"type": "string",
"description": "Script executed on each node after the cluster starts."
},
"sfs_mount_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"mount_path": {
"type": "string"
}
}
},
"description": "Shared File System volumes to mount on cluster nodes."
},
"pfs_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"description": "Parallel File System volumes to mount on cluster nodes."
},
"dataset_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"description": "Read-only dataset volumes to mount on cluster nodes."
},
"sku_id": {
"type": "integer",
"description": "SKU ID for the cluster node type."
},
"no_of_nodes": {
"type": "integer",
"description": "Number of nodes in the cluster."
},
"sku_item_price_id": {
"type": "integer",
"description": "SKU item price ID for the cluster plan. This value is region-specific."
}
},
"required": [
"name",
"image_version_id",
"ssh_key_ids",
"security_group_id",
"sku_id",
"no_of_nodes",
"sku_item_price_id"
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Cluster created successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
},
"is_primary_contact": {
"type": "boolean",
"example": true
},
"currency": {
"type": "string",
"example": "INR"
},
"is_suspended": {
"type": "boolean",
"example": false
}
}
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-15T10:30:00Z"
},
"private_cloud_id": {
"type": "integer",
"nullable": true,
"example": null
},
"private_cloud_name": {
"type": "string",
"nullable": true,
"example": null
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 139
},
"name": {
"type": "string",
"example": "C3.32GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 8
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 32
},
"ephemeral_storage": {
"type": "integer",
"example": 0
},
"gpu_memory": {
"type": "integer",
"example": 0
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "C3-250GB"
},
"gpu_card_type": {
"type": "string",
"nullable": true,
"example": null
},
"category": {
"type": "string",
"example": "distributed_job"
},
"variant": {
"type": "string",
"example": "e2e"
},
"no_of_nodes": {
"type": "integer",
"example": 1
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 645
},
"sku_type": {
"type": "string",
"enum": [
"hourly",
"committed"
],
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"example": 12.3
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
}
},
"total_gpu": {
"type": "integer",
"example": 0
},
"total_cpu": {
"type": "integer",
"example": 0
},
"total_memory": {
"type": "string",
"example": "0 GB"
},
"available_gpu": {
"type": "integer",
"example": 0
},
"available_cpu": {
"type": "integer",
"example": 0
},
"available_memory": {
"type": "string",
"example": "0 GB"
},
"worker_nodes": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"has_local_storage": {
"type": "boolean",
"example": false
},
"local_storage_per_node": {
"type": "integer",
"nullable": true,
"example": null
},
"status": {
"type": "string",
"example": "Creating"
},
"image_pull_policy": {
"type": "string",
"example": "IfNotPresent"
},
"image_version": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"version": {
"type": "string",
"example": "v2-slurm25.11-ubuntu24.04"
},
"description": {
"type": "string",
"example": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"name": {
"type": "string",
"example": "Ubuntu Slurm"
},
"slug_name": {
"type": "string",
"example": "ubuntu-slurm"
},
"framework": {
"type": "string",
"example": "Slurm"
},
"is_internal": {
"type": "boolean",
"example": false
}
}
},
"ssh_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pk": {
"type": "integer",
"example": 1001
},
"label": {
"type": "string",
"example": "my-ssh-key"
},
"ssh_key": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB... user@example.com"
}
}
}
},
"ssh_public_ip": {
"type": "string",
"example": ""
},
"has_floating_ip": {
"type": "boolean",
"example": true
},
"reserve_ip": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"clone_data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"image_version_id": {
"type": "integer",
"example": 2
},
"ssh_key_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1001
]
},
"security_group_id": {
"type": "integer",
"example": 1001
},
"script_added": {
"type": "boolean",
"example": false
},
"lifecycle_script": {
"type": "string",
"example": ""
},
"sfs_mount_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "tir-file-system-010125103000"
},
"mount_path": {
"type": "string",
"example": "/shared"
}
}
},
"example": []
},
"pfs_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"dataset_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"sku_id": {
"type": "integer",
"example": 139
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"sku_item_price_id": {
"type": "integer",
"example": 645
},
"project_id": {
"type": "integer",
"example": 10001
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Cluster created successfully"
}
}
}
}
}
},
"400": {
"description": "Bad request due to invalid parameters.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 400
},
"errors": {
"type": "object",
"example": {
"sku_id": [
"This field is required."
]
}
},
"message": {
"type": "string",
"example": "Bad Request"
}
}
}
}
}
},
"401": {
"description": "Unauthorized — missing or invalid API key.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 401
},
"message": {
"type": "string",
"example": "Unauthorized access."
}
}
}
}
}
}
}
}
},
"/distributed_jobs_v2/cluster/{Cluster_Id}/": {
"get": {
"operationId": "get-distributed-jobs-v2-cluster-cluster-id",
"summary": "Training Cluster Details",
"tags": [
"Training Cluster"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Cluster_Id",
"in": "path",
"required": true,
"description": "Cluster ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response with training cluster details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
},
"is_primary_contact": {
"type": "boolean",
"example": true
},
"currency": {
"type": "string",
"example": "INR"
},
"is_suspended": {
"type": "boolean",
"example": false
}
}
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-15T10:30:00Z"
},
"private_cloud_id": {
"type": "integer",
"nullable": true,
"example": null
},
"private_cloud_name": {
"type": "string",
"nullable": true,
"example": null
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 309
},
"name": {
"type": "string",
"example": "GDC.8xH10080-208.2000GB_SXM_v1"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 208
},
"gpu": {
"type": "integer",
"example": 8
},
"memory": {
"type": "integer",
"example": 2000
},
"ephemeral_storage": {
"type": "integer",
"example": 0
},
"gpu_memory": {
"type": "integer",
"example": 640
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "GDC-8xH10080"
},
"gpu_card_type": {
"type": "string",
"nullable": true,
"example": "H100"
},
"category": {
"type": "string",
"example": "distributed_job"
},
"variant": {
"type": "string",
"example": "e2e"
},
"no_of_nodes": {
"type": "integer",
"example": 1
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 3416
},
"sku_type": {
"type": "string",
"enum": [
"hourly",
"committed"
],
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"example": 1995.2
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": "Hourly Compute Instance: distributed_job"
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
}
},
"total_gpu": {
"type": "integer",
"example": 8
},
"total_cpu": {
"type": "integer",
"example": 208
},
"total_memory": {
"type": "string",
"example": "2000 GB"
},
"available_gpu": {
"type": "integer",
"example": 0
},
"available_cpu": {
"type": "integer",
"example": 0
},
"available_memory": {
"type": "string",
"example": "0 GB"
},
"worker_nodes": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"has_local_storage": {
"type": "boolean",
"example": false
},
"local_storage_per_node": {
"type": "integer",
"nullable": true,
"example": null
},
"status": {
"type": "string",
"example": "Running"
},
"image_pull_policy": {
"type": "string",
"example": "IfNotPresent"
},
"image_version": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"version": {
"type": "string",
"example": "v2-slurm25.11-ubuntu24.04"
},
"description": {
"type": "string",
"example": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"name": {
"type": "string",
"example": "Ubuntu Slurm"
},
"slug_name": {
"type": "string",
"example": "ubuntu-slurm"
},
"framework": {
"type": "string",
"example": "Slurm"
},
"is_internal": {
"type": "boolean",
"example": false
}
}
},
"ssh_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pk": {
"type": "integer",
"example": 1001
},
"label": {
"type": "string",
"example": "my-ssh-key"
},
"ssh_key": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB... user@example.com"
}
}
}
},
"ssh_public_ip": {
"type": "string",
"example": "203.0.113.10"
},
"has_floating_ip": {
"type": "boolean",
"example": true
},
"reserve_ip": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"clone_data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"sku_id": {
"type": "integer",
"example": 309
},
"project_id": {
"type": "integer",
"example": 10001
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"ssh_key_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1001
]
},
"script_added": {
"type": "boolean",
"example": false
},
"pfs_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"sfs_mount_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "tir-file-system-010125103000"
},
"mount_path": {
"type": "string",
"example": "/shared"
}
}
},
"example": []
},
"image_version_id": {
"type": "integer",
"example": 2
},
"lifecycle_script": {
"type": "string",
"example": ""
},
"security_group_id": {
"type": "integer",
"example": 1001
},
"sku_item_price_id": {
"type": "integer",
"example": 3416
},
"dataset_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"example": []
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-distributed-jobs-v2-cluster-cluster-id",
"summary": "Cluster Actions",
"tags": [
"Training Cluster"
],
"description": "Performs an action on a running Training Cluster. The `action` field in the request body determines the operation. Additional fields are required depending on the action:\n\n| Action | Required Fields | Description |\n|--------|----------------|-------------|\n| `update_ssh_keys` | `ssh_key_ids` | Replace SSH keys on all cluster nodes |\n| `update_image` | `image_version_id` | Update the container image on all cluster nodes |\n| `restart_workers` | — | Restart all compute (worker) nodes without restarting the Slurm controller |\n| `restart_cluster` | — | Restart the full cluster including the Slurm controller and all nodes |\n| `scale_cluster` | `additional_nodes` | Add nodes to a running cluster without teardown or workload disruption |\n| `attach_ip` | `reserved_ip_id` | Attach a reserved public IP to the cluster. Returns a Reserved IP object instead of a cluster object. |\n| `detach_ip` | `reserved_ip_id`, `ip_type` | Detach a reserved public IP from the cluster. Returns an empty data object. |\n| `add_security_group` | `security_groups_ids` | Attach one or more security groups to the cluster. Returns a success string. |\n| `remove_security_group` | `security_group_id` | Remove a security group from the cluster. Returns a success string. |\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Cluster_Id",
"in": "path",
"required": true,
"description": "Cluster ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"action"
],
"properties": {
"action": {
"type": "string",
"enum": [
"update_ssh_keys",
"update_image",
"restart_workers",
"restart_cluster",
"scale_cluster",
"attach_ip",
"detach_ip",
"add_security_group",
"remove_security_group"
],
"description": "Action to perform on the cluster. Each action may require additional fields."
},
"ssh_key_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Required for `update_ssh_keys`. List of SSH key IDs to attach to all cluster nodes."
},
"image_version_id": {
"type": "integer",
"description": "Required for `update_image`. ID of the image version to apply to all cluster nodes."
},
"additional_nodes": {
"type": "integer",
"description": "Required for `scale_cluster`. Number of nodes to add to the running cluster."
},
"reserved_ip_id": {
"type": "integer",
"description": "Required for `attach_ip` and `detach_ip`. ID of the reserved IP."
},
"ip_type": {
"type": "string",
"description": "Required for `detach_ip`. Type of IP being detached.",
"enum": [
"reserved"
]
},
"security_groups_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Required for `add_security_group`. List of security group IDs to attach to the cluster."
},
"security_group_id": {
"type": "integer",
"description": "Required for `remove_security_group`. ID of the security group to remove from the cluster."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Action performed successfully. Returns the updated cluster object.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
},
"is_primary_contact": {
"type": "boolean",
"example": true
},
"currency": {
"type": "string",
"example": "INR"
},
"is_suspended": {
"type": "boolean",
"example": false
}
}
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-15T10:30:00Z"
},
"private_cloud_id": {
"type": "integer",
"nullable": true,
"example": null
},
"private_cloud_name": {
"type": "string",
"nullable": true,
"example": null
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 139
},
"name": {
"type": "string",
"example": "C3.32GB"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "integer",
"example": 8
},
"gpu": {
"type": "integer",
"example": 0
},
"memory": {
"type": "integer",
"example": 32
},
"ephemeral_storage": {
"type": "integer",
"example": 0
},
"gpu_memory": {
"type": "integer",
"example": 0
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "C3-250GB"
},
"gpu_card_type": {
"type": "string",
"nullable": true,
"example": null
},
"category": {
"type": "string",
"example": "distributed_job"
},
"variant": {
"type": "string",
"example": "e2e"
},
"no_of_nodes": {
"type": "integer",
"example": 1
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 645
},
"sku_type": {
"type": "string",
"enum": [
"hourly",
"committed"
],
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"example": 12.3
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
}
},
"total_gpu": {
"type": "integer",
"example": 0
},
"total_cpu": {
"type": "integer",
"example": 0
},
"total_memory": {
"type": "string",
"example": "0 GB"
},
"available_gpu": {
"type": "integer",
"example": 0
},
"available_cpu": {
"type": "integer",
"example": 0
},
"available_memory": {
"type": "string",
"example": "0 GB"
},
"worker_nodes": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"has_local_storage": {
"type": "boolean",
"example": false
},
"local_storage_per_node": {
"type": "integer",
"nullable": true,
"example": null
},
"status": {
"type": "string",
"example": "Running"
},
"image_pull_policy": {
"type": "string",
"example": "IfNotPresent"
},
"image_version": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"version": {
"type": "string",
"example": "v2-slurm25.11-ubuntu24.04"
},
"description": {
"type": "string",
"example": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"name": {
"type": "string",
"example": "Ubuntu Slurm"
},
"slug_name": {
"type": "string",
"example": "ubuntu-slurm"
},
"framework": {
"type": "string",
"example": "Slurm"
},
"is_internal": {
"type": "boolean",
"example": false
}
}
},
"ssh_keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pk": {
"type": "integer",
"example": 1001
},
"label": {
"type": "string",
"example": "my-ssh-key"
},
"ssh_key": {
"type": "string",
"example": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAB... user@example.com"
}
}
}
},
"ssh_public_ip": {
"type": "string",
"example": "203.0.113.10"
},
"has_floating_ip": {
"type": "boolean",
"example": true
},
"reserve_ip": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"clone_data": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "training-cluster-010125103045"
},
"sku_id": {
"type": "integer",
"example": 139
},
"project_id": {
"type": "integer",
"example": 10001
},
"no_of_nodes": {
"type": "integer",
"example": 1
},
"ssh_key_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1001,
1002
]
},
"script_added": {
"type": "boolean",
"example": false
},
"pfs_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"sfs_mount_list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "tir-file-system-010125103000"
},
"mount_path": {
"type": "string",
"example": "/shared"
}
}
},
"example": []
},
"image_version_id": {
"type": "integer",
"example": 2
},
"lifecycle_script": {
"type": "string",
"example": ""
},
"security_group_id": {
"type": "integer",
"example": 1001
},
"sku_item_price_id": {
"type": "integer",
"example": 645
},
"dataset_mount_list": {
"type": "array",
"items": {
"type": "object"
},
"example": []
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Cluster updated successfully"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-distributed-jobs-v2-cluster-cluster-id",
"summary": "Delete Training Cluster",
"tags": [
"Training Cluster"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Cluster_Id",
"in": "path",
"required": true,
"description": "Cluster ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response when the cluster is deleted.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Cluster deleted successfully"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/private-cluster/": {
"get": {
"operationId": "get-private-cluster",
"summary": "Private Cluster List",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "List of All Private Cluster",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 163
},
"name": {
"type": "string",
"example": "p-cluster-02191709474"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 74
},
"name": {
"type": "string",
"example": "A100"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 1
},
"gpu": {
"type": "integer",
"example": 1
},
"memory": {
"type": "integer",
"example": 40
},
"ephemeral_storage": {
"type": "integer",
"example": 1
},
"gpu_memory": {
"type": "integer",
"example": 0
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "A100"
},
"gpu_card_type": {
"type": "string",
"example": "A100"
},
"category": {
"type": "string",
"example": "private_cloud"
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 195
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 100
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "gpu_private_cloud"
}
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 871
},
"name": {
"type": "string",
"example": "abc"
},
"email": {
"type": "string",
"example": "abc+acl@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc+acl@e2enetworks.com"
}
}
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T05:31:28.730991Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T05:31:28.673753Z"
},
"nodes_count": {
"type": "integer",
"example": 1
},
"committed_info": {
"type": "object",
"nullable": true,
"example": null
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-private-cluster",
"summary": "Create Private Cluster",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the private cluster."
},
"nodes_count": {
"type": "integer",
"description": "Number of nodes in the cluster."
},
"is_mig_enabled": {
"type": "boolean",
"description": "Whether Multi-Instance GPU (MIG) is enabled."
},
"sku_id": {
"type": "integer",
"description": "SKU ID for the cluster node type."
},
"sku_item_price_id": {
"type": "integer",
"description": "SKU item price ID for the cluster. This value is region-specific."
}
},
"required": [
"name",
"nodes_count",
"sku_id",
"sku_item_price_id"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Private cluster created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Private cluster created successfully"
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/private-cluster/{Private_Cluster_id}/": {
"get": {
"operationId": "get-private-cluster-private-cluster-id",
"summary": "Private Cluster Details",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "Private_Cluster_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Each Private Cluster Detail.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 163
},
"name": {
"type": "string",
"example": "p-cluster-02191709474"
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 74
},
"name": {
"type": "string",
"example": "A100"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 1
},
"gpu": {
"type": "integer",
"example": 1
},
"memory": {
"type": "integer",
"example": 40
},
"ephemeral_storage": {
"type": "integer",
"example": 1
},
"gpu_memory": {
"type": "integer",
"example": 0
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "A100"
},
"gpu_card_type": {
"type": "string",
"example": "A100"
},
"category": {
"type": "string",
"example": "private_cloud"
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 195
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 100
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "gpu_private_cloud"
}
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 871
},
"name": {
"type": "string",
"example": "Vishnukant Shukla"
},
"email": {
"type": "string",
"example": "vishnukant.shukla+acl@e2enetworks.com"
},
"username": {
"type": "string",
"example": "vishnukant.shukla+acl@e2enetworks.com"
}
}
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T05:31:28.730991Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T05:31:28.673753Z"
},
"nodes_count": {
"type": "integer",
"example": 1
},
"committed_info": {
"type": "object",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-private-cluster-private-cluster-id",
"summary": "Delete Private Cluster",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "Private_Cluster_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Private cluster deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Private cluster deleted successfully"
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/private-cluster/{Private_Cluster_id}/nodes-info/": {
"get": {
"operationId": "get-private-cluster-private-cluster-id-nodes-info",
"summary": "Private Cluster Node List",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "Private_Cluster_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "e2e_node_202"
},
"worker_type": {
"type": "string",
"example": "private_cloud_56_GDC-8xH10080"
},
"status": {
"type": "string",
"example": "Ready"
},
"total_cpu": {
"type": "integer",
"example": 224
},
"total_gpu": {
"type": "integer",
"example": 8
},
"free_cpu": {
"type": "integer",
"example": 224
},
"allocated_cpu": {
"type": "integer",
"example": 0
},
"allocated_gpu": {
"type": "integer",
"example": 0
},
"free_gpu": {
"type": "integer",
"example": 8
},
"free_memory": {
"type": "integer",
"example": 2164
},
"free_ephemeral_storage": {
"type": "integer",
"example": 783
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/private-cluster/{Private_Cluster_id}/nodes-info/{node_name}/": {
"get": {
"operationId": "get-private-cluster-private-cluster-id-nodes-info-node-name",
"summary": "Monitoring",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "Private_Cluster_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "node_name",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "e2e_node_253"
},
{
"name": "interval",
"in": "query",
"required": true,
"description": "interval of the Private_Cluster",
"schema": {
"type": "integer",
"enum": [
"5m",
"1h",
"1d",
"7d",
"1mn"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "\n\n## All time plans\n\n**Find Template ID here using software ID for each DBaaS - [Template ID](https://docs.e2enetworks.com/api/myaccount/#/paths/rds-plans/get)**. Template Id is required for pricing plans here.\n\n| **Monitoring Period** | interval | \n|------------------------|-----------------| \n| 5 min | 5m | \n| 1 hour | 1h | \n| 1 day | 1d | \n| 7 days | 7d | \n| 1 month | 1mn | ",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"node_memory_MemTotal_bytes": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12:06:05PM",
"12:06:20PM",
"12:06:35PM",
"12:06:50PM",
"12:07:05PM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"92.16097494066116",
"92.17453237565253",
"92.19093818556306",
"92.20230057434853",
"92.21072471230723"
]
}
}
},
"node_cpu_seconds_total": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12:06:05PM",
"12:06:20PM",
"12:06:35PM",
"12:06:50PM",
"12:07:05PM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"7.094318181890147",
"6.230681818296125",
"6.252272727327767",
"6.317045454687276",
"6.315909091023397"
]
}
}
},
"node_disk_read_bytes_total": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12:06:05PM",
"12:06:20PM",
"12:06:35PM",
"12:06:50PM",
"12:07:05PM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"91900170294272",
"91900170818560",
"91900170818560",
"91900170818560",
"91900170818560"
]
}
}
},
"node_disk_written_bytes_total": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12:06:05PM",
"12:06:20PM",
"12:06:35PM",
"12:06:50PM",
"12:07:05PM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"6074665978880",
"6074684582912",
"6074699449344",
"6074714261504",
"6074729580032"
]
}
}
},
"gpu_temperature": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12:06:05PM",
"12:06:20PM",
"12:06:35PM",
"12:06:50PM",
"12:07:05PM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"27",
"27",
"27",
"27",
"27"
]
}
}
},
"gpu_util": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"12:06:05PM",
"12:06:20PM",
"12:06:35PM",
"12:06:50PM",
"12:07:05PM"
]
},
"value_series": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"0",
"0",
"0",
"0",
"0"
]
}
}
},
"node_disk_capacity": {
"type": "integer",
"example": 1572851396608
},
"node_disk_used": {
"type": "integer",
"example": 1251752009728
},
"node_memory_capacity": {
"type": "integer",
"example": 118492266496
},
"node_used_memory": {
"type": "integer",
"example": 19927318528
},
"name": {
"type": "string",
"example": "e2e_node_7"
},
"worker_type": {
"type": "string",
"example": "private_cloud_164_A100"
},
"status": {
"type": "string",
"example": "Ready"
},
"total_cpu": {
"type": "integer",
"example": 16
},
"total_gpu": {
"type": "integer",
"example": 1
},
"free_cpu": {
"type": "integer",
"example": 15
},
"allocated_cpu": {
"type": "integer",
"example": 0
},
"allocated_gpu": {
"type": "integer",
"example": 0
},
"free_gpu": {
"type": "integer",
"example": 1
},
"free_memory": {
"type": "integer",
"example": 118
},
"free_ephemeral_storage": {
"type": "integer",
"example": 1572
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/private-cluster/{Private_Cluster_id}/deployed_resources/": {
"get": {
"operationId": "get-private-cluster-private-cluster-id-deployed-resources",
"summary": "Deployed Resources",
"tags": [
"Private Cluster"
],
"parameters": [
{
"name": "Private_Cluster_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "service_type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"notebook",
"inference_service",
"vector_db"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved data (empty array in this case)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
},
"/reserved_ips/": {
"get": {
"operationId": "get-reserved-ips",
"summary": "Reserve IP List",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "Page number for pagination",
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"example": 5
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"responses": {
"200": {
"description": "List of reserved IPs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"reserved_ips": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1174
},
"ip_address": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.7"
},
"service_name": {
"type": "string",
"example": "vllm-260202213427"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-02T16:35:33.079344Z"
},
"status": {
"type": "string",
"example": "Unavailable"
},
"reserved_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12477
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"service_type": {
"type": "string",
"example": "inferenceservice"
},
"service_id": {
"type": "integer",
"nullable": true,
"example": 8286
},
"location": {
"type": "string",
"example": "Delhi"
},
"egress_ip": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.8"
},
"myaccount_project_id": {
"type": "integer",
"example": 46594
},
"vpc_details": {
"type": "object",
"properties": {
"dns": {
"type": "string",
"example": "8.8.8.8 8.8.4.4"
},
"name": {
"type": "string",
"example": "VPC-681"
},
"price": {
"type": "string",
"example": "Rs. 4.8/Hour or Rs. 3500.0 Monthly"
},
"state": {
"type": "string",
"example": "Active"
},
"subnets": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"location": {
"type": "string",
"example": "Delhi"
},
"vm_count": {
"type": "integer",
"example": 0
},
"ipv4_cidr": {
"type": "string",
"example": "10.8.220.0/23"
},
"is_active": {
"type": "boolean",
"example": true
},
"pool_size": {
"type": "integer",
"example": 512
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-02T15:45:15.336925Z"
},
"gateway_ip": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.1"
},
"is_e2e_vpc": {
"type": "boolean",
"example": true
},
"network_id": {
"type": "integer",
"example": 51117
},
"gateway_node": {
"type": "object",
"properties": {
"state": {
"type": "string",
"example": "Running"
},
"node_id": {
"type": "integer",
"example": 292409
},
"node_name": {
"type": "string",
"example": "VPC-681-gateway"
},
"ip_address_public": {
"type": "string",
"format": "ipv4",
"example": "164.52.211.67"
},
"ip_address_private": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.1"
}
}
},
"network_mask": {
"type": "string",
"example": "255.255.254.0"
},
"project_name": {
"type": "string",
"example": "test"
},
"committed_info": {
"type": "object",
"nullable": true,
"example": null
},
"committed_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"committed_days": {
"type": "integer",
"example": 30
},
"committed_sku_id": {
"type": "integer",
"example": 9798
},
"committed_sku_name": {
"type": "string",
"example": "30 Days Committed , Rs. 3500.0"
},
"committed_sku_price": {
"type": "number",
"example": 3500
},
"committed_upto_date": {
"type": "string",
"example": "04-March-2026 16:35"
},
"committed_node_message": {
"type": "string",
"example": "This committed node will be reserved for next 30 days ( till 04-March-2026 16:35). The cost Rs. 3500.0 of this node will be added in next invoice."
}
}
}
}
}
},
"connection_status": {
"type": "string",
"example": "Connected"
}
}
}
},
"reserved_ip_limit": {
"type": "integer",
"example": 5
},
"available_reserved_ip": {
"type": "integer",
"example": 5
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-reserved-ips",
"summary": "Create Reserve IP",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "IP allocated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 46
},
"ip_address": {
"type": "string",
"format": "ipv4",
"example": "216.48.185.130"
},
"service_name": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-04-09T11:00:22.102193Z"
},
"status": {
"type": "string",
"example": "Available"
},
"reserved_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4947
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"service_type": {
"type": "string",
"example": ""
},
"service_id": {
"type": "integer",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "IP 216.48.185.130 allocated successfully."
}
}
}
}
}
}
}
}
},
"/notebooks/{notebook_id}/actions/": {
"put": {
"operationId": "put-notebooks-notebook-id-actions",
"summary": "Attach/Detach Reserve IP",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "notebook_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"attach_reserve_ip",
"detach_reserve_ip"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"reserved_ip_id": {
"type": "integer",
"example": 49
}
},
"required": [
"reserved_ip_id"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Notebook attached/detach to reserved IP successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Notebook attach_reserve_ip successfully"
}
}
}
}
}
}
}
}
},
"/notebooks/{notebook_id}/reserve-ip/": {
"put": {
"operationId": "put-notebooks-notebook-id-reserve-ip",
"summary": "Convert Floating IP to Reserve IP",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "notebook_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "IP allocated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 51
},
"ip_address": {
"type": "string",
"format": "ipv4",
"example": "216.48.190.238"
},
"service_name": {
"type": "string",
"example": "node-040915365151"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-04-09T11:43:36.706214Z"
},
"status": {
"type": "string",
"example": "Unavailable"
},
"reserved_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4947
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"service_type": {
"type": "string",
"example": "notebook"
},
"service_id": {
"type": "integer",
"example": 8559
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "IP 216.48.190.238 allocated successfully."
}
}
}
}
}
}
}
}
},
"/reserved_ips/{reserve_ip_id}/": {
"delete": {
"operationId": "delete-reserved-ips-reserve-ip-id",
"summary": "Delete Reserve IP",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "reserve_ip_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "IP deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 49
},
"ip_address": {
"type": "string",
"format": "ipv4",
"example": "216.48.188.68"
},
"service_name": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-04-09T11:21:18.124222Z"
},
"status": {
"type": "string",
"example": "Available"
},
"reserved_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4947
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"service_type": {
"type": "string",
"example": ""
},
"service_id": {
"type": "integer",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "IP 216.48.188.68 deleted successfully."
}
}
}
}
}
}
}
}
},
"/reserved_ips/private-ip/": {
"post": {
"operationId": "post-reserved-ips-private-ip",
"summary": "Reserve IP from VPC",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"network_id": {
"type": "string",
"example": "51117",
"description": "The VPC network ID to reserve the IP from"
},
"my_account_project_id": {
"type": "integer",
"example": 46594,
"description": "The MyAccount project ID associated with the VPC"
},
"my_account_location": {
"type": "string",
"example": "Delhi",
"description": "The location of the VPC"
}
},
"required": [
"network_id",
"my_account_project_id",
"my_account_location"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "IP reserved from VPC successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1403
},
"ip_address": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.9"
},
"service_name": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-09T04:54:03.613008Z"
},
"status": {
"type": "string",
"example": "Available"
},
"reserved_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12477
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"service_type": {
"type": "string",
"example": ""
},
"service_id": {
"type": "integer",
"nullable": true,
"example": null
},
"location": {
"type": "string",
"example": "Delhi"
},
"egress_ip": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.10"
},
"myaccount_project_id": {
"type": "integer",
"example": 46594
},
"vpc_details": {
"type": "object",
"properties": {
"dns": {
"type": "string",
"example": "8.8.8.8 8.8.4.4"
},
"name": {
"type": "string",
"example": "VPC-681"
},
"price": {
"type": "string",
"example": "Rs. 4.8/Hour or Rs. 3500.0 Monthly"
},
"state": {
"type": "string",
"example": "Active"
},
"subnets": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"location": {
"type": "string",
"example": "Delhi"
},
"vm_count": {
"type": "integer",
"example": 0
},
"ipv4_cidr": {
"type": "string",
"example": "10.8.220.0/23"
},
"is_active": {
"type": "boolean",
"example": true
},
"pool_size": {
"type": "integer",
"example": 512
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-02T15:45:15.336925Z"
},
"gateway_ip": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.1"
},
"is_e2e_vpc": {
"type": "boolean",
"example": true
},
"network_id": {
"type": "integer",
"example": 51117
},
"gateway_node": {
"type": "object",
"properties": {
"state": {
"type": "string",
"example": "Running"
},
"node_id": {
"type": "integer",
"example": 292409
},
"node_name": {
"type": "string",
"example": "VPC-681-gateway"
},
"ip_address_public": {
"type": "string",
"format": "ipv4",
"example": "164.52.211.67"
},
"ip_address_private": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.1"
}
}
},
"network_mask": {
"type": "string",
"example": "255.255.254.0"
},
"project_name": {
"type": "string",
"example": "test"
},
"committed_info": {
"type": "object",
"nullable": true,
"example": null
},
"committed_details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"committed_days": {
"type": "integer",
"example": 30
},
"committed_sku_id": {
"type": "integer",
"example": 9798
},
"committed_sku_name": {
"type": "string",
"example": "30 Days Committed , Rs. 3500.0"
},
"committed_sku_price": {
"type": "number",
"example": 3500
},
"committed_upto_date": {
"type": "string",
"example": "08-April-2026 04:54"
},
"committed_node_message": {
"type": "string",
"example": "This committed node will be reserved for next 30 days ( till 08-April-2026 04:54). The cost Rs. 3500.0 of this node will be added in next invoice."
}
}
}
}
}
},
"connection_status": {
"type": "string",
"example": "Idle"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/notebooks/{notebook_id}/vpc_ips/{reserve_ip_id}/": {
"post": {
"operationId": "post-notebooks-notebook-id-vpc-ips-reserve-ip-id",
"summary": "Attach VPC IP to Notebook",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "notebook_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reserve_ip_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"responses": {
"200": {
"description": "VPC IP attached successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "VPC IP attach action scheduled successfully."
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-notebooks-notebook-id-vpc-ips-reserve-ip-id",
"summary": "Detach VPC IP from Notebook",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "notebook_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reserve_ip_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"responses": {
"200": {
"description": "VPC IP detached successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "VPC IP detach action scheduled successfully."
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/serving/inference/{inference_id}/vpc_ips/{reserve_ip_id}/": {
"post": {
"operationId": "post-serving-inference-inference-id-vpc-ips-reserve-ip-id",
"summary": "Attach VPC IP to Inference",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reserve_ip_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"responses": {
"200": {
"description": "VPC IP attached to inference service successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "VPC IP attach action scheduled successfully."
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-serving-inference-inference-id-vpc-ips-reserve-ip-id",
"summary": "Detach VPC IP from Inference",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "inference_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reserve_ip_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"responses": {
"200": {
"description": "VPC IP detached from inference service successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "VPC IP detach action scheduled successfully."
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/reserved_ips/private-ip/{reserve_ip_id}/": {
"delete": {
"operationId": "delete-reserved-ips-private-ip-reserve-ip-id",
"summary": "Delete VPC IP",
"tags": [
"Reserve IP"
],
"parameters": [
{
"name": "reserve_ip_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": false,
"description": "Filter by location",
"schema": {
"type": "string",
"example": "Delhi"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID",
"schema": {
"type": "integer",
"example": 6706
}
}
],
"responses": {
"200": {
"description": "VPC IP deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1403
},
"ip_address": {
"type": "string",
"format": "ipv4",
"example": "10.8.220.9"
},
"service_name": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-09T04:54:03.613008Z"
},
"status": {
"type": "string",
"example": "Done"
},
"reserved_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12477
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"service_type": {
"type": "string",
"example": ""
},
"service_id": {
"type": "integer",
"nullable": true,
"example": null
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "IP 10.8.220.9 deleted successfully."
}
}
}
}
}
}
}
}
},
"/security_groups/": {
"get": {
"operationId": "get-security-groups",
"summary": "List Security Groups",
"tags": [
"Security Groups"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "List of security groups",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 17258
},
"name": {
"type": "string",
"example": "tir-sg-260115154544"
},
"description": {
"type": "string",
"example": ""
},
"location": {
"type": "string",
"example": "Delhi"
},
"is_ssh_security_group": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 9266
},
"name": {
"type": "string",
"example": "Sahil Verma"
},
"email": {
"type": "string",
"example": "sahil+new@e2enetworks.com"
},
"username": {
"type": "string",
"example": "sahil+new@e2enetworks.com"
}
}
},
"attached_services": {
"type": "object",
"properties": {
"notebook": {
"type": "array",
"items": {}
},
"inference_service": {
"type": "array",
"items": {}
},
"distributed_job": {
"type": "array",
"items": {}
}
}
},
"is_ssh_port_enabled": {
"type": "boolean",
"example": false
},
"inbound_rules_count": {
"type": "integer",
"example": 1
},
"outbound_rules_count": {
"type": "integer",
"example": 1
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-01-15T10:19:10.925925Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-01-15T10:19:10.925942Z"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-security-groups",
"summary": "Create Security Group",
"tags": [
"Security Groups"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"rules"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the security group",
"example": "tir-sg-26020516370"
},
"description": {
"type": "string",
"description": "Description of the security group",
"example": ""
},
"rules": {
"type": "array",
"description": "List of inbound and outbound security rules",
"items": {
"type": "object",
"required": [
"rule_type",
"protocol",
"protocol_type",
"network_type",
"ports"
],
"properties": {
"rule_type": {
"type": "string",
"description": "Direction of traffic",
"enum": [
"inbound",
"outbound"
],
"example": "inbound"
},
"protocol": {
"type": "string",
"description": "Network protocol",
"enum": [
"TCP",
"UDP",
"All"
],
"example": "TCP"
},
"protocol_type": {
"type": "string",
"description": "Protocol category",
"enum": [
"CustomTCP",
"CustomUDP",
"AllTraffic"
],
"example": "CustomTCP"
},
"network_type": {
"type": "string",
"description": "Source/Destination network type",
"enum": [
"any",
"manual"
],
"example": "any"
},
"ports": {
"type": "array",
"description": "List of ports for the rule",
"items": {
"type": "integer"
},
"example": [
22
]
},
"cidr_ip": {
"type": "string",
"nullable": true,
"description": "CIDR IP address (required when network_type is manual)",
"example": "1.1.1.1"
},
"cidr_subnet": {
"type": "integer",
"nullable": true,
"description": "CIDR subnet mask",
"example": 32
},
"description": {
"type": "string",
"description": "Rule description",
"example": ""
}
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Security group created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 19272
},
"name": {
"type": "string",
"example": "tir-sg-260205155743"
},
"description": {
"type": "string",
"example": ""
},
"location": {
"type": "string",
"example": "Delhi"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 40689
},
"rule_type": {
"type": "string",
"example": "inbound"
},
"protocol_type": {
"type": "string",
"example": "CustomTCP"
},
"protocol": {
"type": "string",
"example": "TCP"
},
"ports": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
22
]
},
"cidr_ip": {
"type": "string",
"nullable": true,
"example": null
},
"cidr_subnet": {
"type": "integer",
"example": 32
},
"description": {
"type": "string",
"example": ""
},
"network_type": {
"type": "string",
"example": "any"
},
"network_details": {
"type": "object",
"example": {}
},
"my_account_project_id": {
"type": "integer",
"nullable": true,
"example": null
},
"my_account_location": {
"type": "string",
"nullable": true,
"example": null
},
"vpc_id": {
"type": "integer",
"nullable": true,
"example": null
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T10:28:04.156794Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T10:28:04.156805Z"
}
}
}
},
"is_ssh_security_group": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 9266
},
"name": {
"type": "string",
"example": "Sahil Verma"
},
"email": {
"type": "string",
"example": "sahil+new@e2enetworks.com"
},
"username": {
"type": "string",
"example": "sahil+new@e2enetworks.com"
}
}
},
"attached_services": {
"type": "object",
"properties": {
"notebook": {
"type": "array",
"items": {}
},
"inference_service": {
"type": "array",
"items": {}
},
"distributed_job": {
"type": "array",
"items": {}
}
}
},
"is_ssh_port_enabled": {
"type": "boolean",
"example": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T10:28:04.154448Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T10:28:04.154467Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/security_groups/{security_group_id}/": {
"put": {
"operationId": "put-security-groups-security-group-id",
"summary": "Update Sg Name and Description",
"tags": [
"Security Groups"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "security_group_id",
"in": "path",
"required": true,
"description": "Security Group ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Updated name of the security group",
"example": "tir-sg-test-1"
},
"description": {
"type": "string",
"description": "Updated description of the security group",
"example": "testing"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Security group name and description updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 22283
},
"name": {
"type": "string",
"example": "tir-sg-test-1"
},
"description": {
"type": "string",
"example": "testing"
},
"location": {
"type": "string",
"example": "Delhi"
},
"is_ssh_security_group": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4947
},
"name": {
"type": "string",
"example": "xyz"
},
"email": {
"type": "string",
"example": "abc@e2enetworks.com"
},
"username": {
"type": "string",
"example": "abc@e2enetworks.com"
}
}
},
"attached_services": {
"type": "object",
"properties": {
"notebook": {
"type": "array",
"items": {}
},
"inference_service": {
"type": "array",
"items": {}
},
"distributed_job": {
"type": "array",
"items": {}
}
}
},
"is_ssh_port_enabled": {
"type": "boolean",
"example": false
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-09T05:00:00.000000Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-09T05:10:00.000000Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/security_groups/{security_group_id}/rules/": {
"put": {
"operationId": "put-security-groups-security-group-id-rules",
"summary": "Update Security Group Rules",
"tags": [
"Security Groups"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "security_group_id",
"in": "path",
"required": true,
"description": "Security Group ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "List of security group rules to update or create",
"items": {
"type": "object",
"required": [
"rule_type",
"protocol",
"protocol_type",
"network_type",
"ports"
],
"properties": {
"id": {
"type": "integer",
"nullable": true,
"description": "Existing rule ID (omit for new rules)",
"example": 40729
},
"rule_type": {
"type": "string",
"enum": [
"inbound",
"outbound"
],
"example": "inbound"
},
"protocol": {
"type": "string",
"enum": [
"TCP",
"UDP",
"All"
],
"example": "TCP"
},
"protocol_type": {
"type": "string",
"enum": [
"CustomTCP",
"CustomUDP",
"AllTraffic"
],
"example": "CustomTCP"
},
"network_type": {
"type": "string",
"enum": [
"any",
"manual"
],
"example": "any"
},
"ports": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
22
]
},
"cidr_ip": {
"type": "string",
"nullable": true,
"description": "CIDR IP (required when network_type is manual)",
"example": "1.1.1.1"
},
"cidr_subnet": {
"type": "integer",
"nullable": true,
"example": 32
},
"description": {
"type": "string",
"example": ""
},
"isNew": {
"type": "boolean",
"nullable": true,
"description": "Indicates a newly added rule",
"example": true
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Security group fetched successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 19293
},
"name": {
"type": "string",
"example": "tir-sg-26020516370"
},
"description": {
"type": "string",
"example": ""
},
"location": {
"type": "string",
"example": "Delhi"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 40737
},
"rule_type": {
"type": "string",
"example": "inbound"
},
"protocol_type": {
"type": "string",
"example": "CustomUDP"
},
"protocol": {
"type": "string",
"example": "UDP"
},
"ports": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
2000
]
},
"cidr_ip": {
"type": "string",
"nullable": true,
"example": null
},
"cidr_subnet": {
"type": "integer",
"example": 32
},
"description": {
"type": "string",
"example": ""
},
"network_type": {
"type": "string",
"example": "any"
},
"network_details": {
"type": "object",
"example": {}
},
"my_account_project_id": {
"type": "integer",
"nullable": true,
"example": null
},
"my_account_location": {
"type": "string",
"nullable": true,
"example": null
},
"vpc_id": {
"type": "integer",
"nullable": true,
"example": null
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T11:13:04.204445Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T11:13:04.204461Z"
}
}
}
},
"is_ssh_security_group": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 9266
},
"name": {
"type": "string",
"example": "Sahil Verma"
},
"email": {
"type": "string",
"example": "sahil+new@e2enetworks.com"
},
"username": {
"type": "string",
"example": "sahil+new@e2enetworks.com"
}
}
},
"attached_services": {
"type": "object",
"properties": {
"notebook": {
"type": "array",
"items": {}
},
"inference_service": {
"type": "array",
"items": {}
},
"distributed_job": {
"type": "array",
"items": {}
}
}
},
"is_ssh_port_enabled": {
"type": "boolean",
"example": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T11:08:08.327727Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-02-05T11:08:08.327751Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-security-groups-security-group-id-rules",
"summary": "Delete Security Group",
"tags": [
"Security Groups"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "security_group_id",
"in": "path",
"required": true,
"description": "Security Group ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Security group deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Security Group deleted successfully"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/auth-token/": {
"get": {
"operationId": "get-auth-token",
"summary": "List API Tokens",
"tags": [
"Security"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of API tokens",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2833
},
"token_name": {
"type": "string",
"example": "new-token22"
},
"api_key": {
"type": "string",
"format": "uuid",
"example": "d2f41f70-917c-4b24-9f3c-de7a4bbec386"
},
"auth_token": {
"type": "string",
"example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
},
"created_at": {
"type": "string",
"example": "1 Months ago"
},
"expiry": {
"type": "string",
"format": "date",
"example": "2027-02-11"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-auth-token",
"summary": "Create API Token",
"tags": [
"Security"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"token_name"
],
"properties": {
"token_name": {
"type": "string",
"example": "tir-token-260320155516"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "API token created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2977
},
"token_name": {
"type": "string",
"example": "tir-token-260320153924"
},
"api_key": {
"type": "string",
"format": "uuid",
"example": "73d830cd-5fd6-4543-8a9d-8a9c400d3d77"
},
"auth_token": {
"type": "string",
"example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
},
"created_at": {
"type": "string",
"example": "0 Day ago"
},
"expiry": {
"type": "string",
"format": "date",
"example": "2027-03-20"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/auth-token/{token_id}/": {
"delete": {
"operationId": "delete-auth-token-token-id",
"summary": "Delete API Token",
"tags": [
"Security"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "token_id",
"in": "path",
"required": true,
"description": "API Token ID",
"schema": {
"type": "integer",
"example": 2977
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "API token deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "tir-token-260320153924 - Deleted Successfully"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ssh_keys/": {
"get": {
"operationId": "get-ssh-keys",
"summary": "List SSH Keys",
"tags": [
"Security"
],
"parameters": [
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of SSH keys",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pk": {
"type": "integer",
"example": 2589
},
"label": {
"type": "string",
"example": "ssh_key_name"
},
"ssh_key": {
"type": "string",
"example": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user@hostname"
},
"timestamp": {
"type": "string",
"example": "20-Mar-2026"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-ssh-keys",
"summary": "Add SSH Key",
"tags": [
"Security"
],
"parameters": [
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"label",
"ssh_key"
],
"properties": {
"label": {
"type": "string",
"example": "ssh_key_name"
},
"ssh_key": {
"type": "string",
"example": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user@hostname"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "SSH key added successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"label": {
"type": "string",
"example": "ssh_key_name"
},
"ssh_key": {
"type": "string",
"example": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx user@hostname"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Your SSH Key has been added"
}
}
}
}
}
}
}
}
},
"/ssh_keys/{ssh_key_id}/": {
"delete": {
"operationId": "delete-ssh-keys-ssh-key-id",
"summary": "Delete SSH Key",
"tags": [
"Security"
],
"parameters": [
{
"name": "ssh_key_id",
"in": "path",
"required": true,
"description": "SSH Key ID",
"schema": {
"type": "integer",
"example": 2590
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "SSH key deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "SSH Key has been deleted successfully."
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/": {
"get": {
"operationId": "list-gateways",
"summary": "List Gateways",
"tags": [
"Gateway"
],
"description": "Returns a list of all gateways in the project.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of gateways in the project.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique gateway ID.",
"example": 12
},
"name": {
"type": "string",
"description": "Gateway name.",
"example": "my-ai-gateway"
},
"description": {
"type": "string",
"nullable": true,
"description": "Gateway description.",
"example": "Production gateway for LLM routing"
},
"domain": {
"type": "string",
"description": "Auto-generated domain assigned to the gateway.",
"example": "gw-12-abc123.e2enetworks.net"
},
"public_ip": {
"type": "string",
"nullable": true,
"description": "Public IP address of the gateway.",
"example": "203.0.113.10"
},
"environment": {
"type": "string",
"nullable": true,
"description": "Environment tag.",
"example": "production"
},
"status": {
"type": "string",
"description": "Current gateway status.",
"enum": [
"Initializing",
"Running",
"Stopped",
"Failed",
"Done"
],
"example": "Running"
},
"created_by": {
"type": "object",
"description": "User who created the gateway.",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"rules": {
"type": "array",
"description": "Active routing rules attached to this gateway.",
"items": {
"type": "object",
"properties": {
"matches": {
"type": "object",
"properties": {
"http": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "PathPrefix"
},
"value": {
"type": "string",
"example": "/v1/chat"
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
}
}
}
},
"grpc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
}
}
}
}
}
},
"backendRefs": {
"type": "object",
"description": "Backend inference endpoints this rule routes to.",
"properties": {
"http": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"example": "Service"
},
"name": {
"type": "string",
"example": "is-3036"
},
"port": {
"type": "integer",
"example": 80
},
"weight": {
"type": "integer",
"example": 100
}
}
}
},
"grpc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"example": "Service"
},
"name": {
"type": "string",
"example": "is-3036"
},
"port": {
"type": "integer",
"example": 9000
},
"weight": {
"type": "integer",
"example": 100
}
}
}
}
}
}
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "create-gateway",
"summary": "Create Gateway",
"tags": [
"Gateway"
],
"description": "Creates a new AI gateway. The gateway receives a unique domain upon creation.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the gateway. Must be unique within the project.",
"example": "my-ai-gateway"
},
"description": {
"type": "string",
"nullable": true,
"description": "Optional description for the gateway.",
"example": "Production gateway for LLM routing"
},
"environment": {
"type": "string",
"nullable": true,
"description": "Optional environment tag.",
"example": "production"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Gateway created successfully. Use the Get Gateway Details endpoint to fetch `domain`, `status`, and `rules`.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique gateway ID.",
"example": 12
},
"name": {
"type": "string",
"description": "Gateway name.",
"example": "my-ai-gateway"
},
"description": {
"type": "string",
"nullable": true,
"description": "Gateway description.",
"example": "Production gateway for LLM routing"
},
"environment": {
"type": "string",
"nullable": true,
"description": "Environment tag.",
"example": "production"
},
"created_by": {
"type": "object",
"description": "User who created the gateway.",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/gateway/count/": {
"get": {
"operationId": "gateway-count",
"summary": "Gateway Count",
"tags": [
"Gateway"
],
"description": "Returns the total number of gateways in the project.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Total number of gateways in the project.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of gateways.",
"example": 3
},
"running": {
"type": "integer",
"description": "Number of gateways currently running.",
"example": 1
},
"stopped": {
"type": "integer",
"description": "Number of gateways currently stopped.",
"example": 0
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/metrics_list/": {
"get": {
"operationId": "gateway-metrics-list",
"summary": "List Available Metrics",
"tags": [
"Gateway"
],
"description": "Returns all metric names available for gateway monitoring. Use these names with the **Gateway Metric Data** endpoint.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of available metrics for gateway monitoring.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metric_key": {
"type": "string",
"description": "Key used to query this metric via the Metric Data endpoint.",
"example": "request_count"
},
"metric_name": {
"type": "string",
"description": "Display name of the metric.",
"example": "Request Count (QPS)"
},
"description": {
"type": "string",
"description": "What the metric measures.",
"example": "Total requests per second handled by the gateway"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/": {
"get": {
"operationId": "get-gateway-detail",
"summary": "Gateway Details",
"tags": [
"Gateway"
],
"description": "Returns the full details of a specific gateway including its active routing rules.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Gateway details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"type": "string",
"example": "my-ai-gateway"
},
"description": {
"type": "string",
"nullable": true,
"example": "Production gateway for LLM routing"
},
"domain": {
"type": "string",
"example": "gw-12-abc123.e2enetworks.net"
},
"public_ip": {
"type": "string",
"nullable": true,
"example": "203.0.113.10"
},
"environment": {
"type": "string",
"nullable": true,
"example": "production"
},
"status": {
"type": "string",
"enum": [
"Initializing",
"Running",
"Stopped",
"Failed",
"Done"
],
"example": "Running"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"rules": {
"type": "array",
"items": {
"type": "object",
"properties": {
"matches": {
"type": "object",
"properties": {
"http": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "PathPrefix"
},
"value": {
"type": "string",
"example": "/v1/chat"
}
}
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
}
}
}
},
"grpc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
}
}
}
}
}
},
"backendRefs": {
"type": "object",
"properties": {
"http": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"example": "Service"
},
"name": {
"type": "string",
"example": "is-3036"
},
"port": {
"type": "integer",
"example": 80
},
"weight": {
"type": "integer",
"example": 100
}
}
}
},
"grpc": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"example": "Service"
},
"name": {
"type": "string",
"example": "is-3036"
},
"port": {
"type": "integer",
"example": 9000
},
"weight": {
"type": "integer",
"example": 100
}
}
}
}
}
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"put": {
"operationId": "update-gateway",
"summary": "Update Gateway",
"tags": [
"Gateway"
],
"description": "Updates gateway configuration fields (name, description, environment).",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated gateway name.",
"example": "updated-gateway"
},
"description": {
"type": "string",
"nullable": true,
"description": "Updated description.",
"example": "Updated description"
},
"environment": {
"type": "string",
"nullable": true,
"description": "Updated environment tag.",
"example": "staging"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Gateway updated successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"type": "string",
"example": "updated-gateway"
},
"description": {
"type": "string",
"nullable": true,
"example": "Updated description"
},
"environment": {
"type": "string",
"nullable": true,
"example": "staging"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-gateway",
"summary": "Delete Gateway",
"tags": [
"Gateway"
],
"description": "Permanently deletes a gateway and all associated routing rules.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Deleted successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"deleted": {
"type": "boolean",
"example": true
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/logs/": {
"get": {
"operationId": "get-gateway-logs",
"summary": "Gateway Logs",
"tags": [
"Gateway"
],
"description": "Returns recent log output from the gateway. Use `last_n_lines` or `last_n_seconds` to scope the result.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "last_n_lines",
"in": "query",
"required": false,
"description": "Number of most recent log lines to return.",
"schema": {
"type": "integer",
"example": 100
}
},
{
"name": "last_n_seconds",
"in": "query",
"required": false,
"description": "Return logs from the last N seconds.",
"schema": {
"type": "integer",
"example": 300
}
}
],
"responses": {
"200": {
"description": "Gateway log output.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"logs": {
"type": "array",
"description": "Log lines from the gateway.",
"items": {
"type": "string"
},
"example": []
}
}
},
"errors": {
"type": "object",
"example": {}
},
"log": {
"type": "string",
"example": "Success"
},
"success": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/metrics_summary/": {
"get": {
"operationId": "get-gateway-metrics-summary",
"summary": "Metrics Summary",
"tags": [
"Gateway"
],
"description": "Returns an aggregated summary of all metrics for the gateway over the given interval.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "interval",
"in": "query",
"required": false,
"description": "Time window for metric aggregation.",
"schema": {
"type": "string",
"default": "5m",
"enum": [
"5m",
"1h",
"1d",
"7d"
],
"example": "5m"
}
}
],
"responses": {
"200": {
"description": "Aggregated metrics summary for the gateway.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"metric_name": {
"type": "string",
"description": "Display name of the metric.",
"example": "Request Count (QPS)"
},
"description": {
"type": "string",
"description": "What the metric measures.",
"example": "Total requests per second handled by the gateway"
},
"current_value": {
"type": "string",
"description": "Current value of the metric.",
"example": "0.00"
},
"unit": {
"type": "string",
"description": "Unit of measurement.",
"example": "req/s"
}
}
},
"example": {
"request_count": {
"metric_name": "Request Count (QPS)",
"description": "Total requests per second handled by the gateway",
"current_value": "0.00",
"unit": "req/s"
},
"latency_p50": {
"metric_name": "Latency P50",
"description": "Median request latency (milliseconds)",
"current_value": "0.00",
"unit": "ms"
},
"latency_p90": {
"metric_name": "Latency P90",
"description": "90th percentile request latency (milliseconds)",
"current_value": "0.00",
"unit": "ms"
},
"latency_p99": {
"metric_name": "Latency P99",
"description": "99th percentile request latency (milliseconds)",
"current_value": "0.00",
"unit": "ms"
},
"error_rate": {
"metric_name": "Error Rate",
"description": "Percentage of 4xx and 5xx responses to total requests",
"current_value": "0.00",
"unit": "%"
},
"success_rate": {
"metric_name": "Success Rate",
"description": "Percentage of 2xx responses out of total requests",
"current_value": "0.00",
"unit": "%"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/metrics/{metric_name}/": {
"get": {
"operationId": "get-gateway-metric",
"summary": "Gateway Metric Data",
"tags": [
"Gateway"
],
"description": "Returns time-series monitoring data for a specific metric. Use the **List Available Metrics** endpoint to get valid metric names.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "metric_name",
"in": "path",
"required": true,
"description": "Name of the metric to retrieve. Get valid names from the **List Available Metrics** endpoint.",
"schema": {
"type": "string",
"example": "request_rate"
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "interval",
"in": "query",
"required": false,
"description": "Time window for metric aggregation.",
"schema": {
"type": "string",
"default": "5m",
"enum": [
"5m",
"1h",
"1d",
"7d"
],
"example": "5m"
}
}
],
"responses": {
"200": {
"description": "Time-series data for the requested metric.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"description": "Timestamps for each data point.",
"items": {
"type": "string",
"format": "date-time"
},
"example": []
},
"value_series": {
"type": "array",
"description": "Metric values corresponding to each timestamp.",
"items": {
"type": "number"
},
"example": []
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/{action_type}/": {
"put": {
"operationId": "gateway-action",
"summary": "Gateway Actions (Start / Stop)",
"tags": [
"Gateway"
],
"description": "Perform a lifecycle action on a gateway.\n\n| `action_type` | Purpose |\n|---|---|\n| `start` | Start a stopped gateway |\n| `stop` | Stop a running gateway |\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action_type",
"in": "path",
"required": true,
"description": "Action to perform on the gateway.",
"schema": {
"type": "string",
"enum": [
"start",
"stop"
]
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "No request body required for `start` or `stop`."
}
}
}
},
"responses": {
"200": {
"description": "Action performed successfully on the gateway.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action that was performed.",
"example": "stop"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/rules/": {
"get": {
"operationId": "list-gateway-rules",
"summary": "List Rules",
"tags": [
"Gateway"
],
"description": "Returns all routing rules attached to the gateway.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of routing rules for the gateway.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"example": [
{
"id": 1,
"route_name": "weight-route",
"routing_strategy": "Weight-Based",
"rules": {
"path": "/v1/chat",
"endpoints": [
{
"id": 3036,
"weight": 100
}
]
},
"status": "Active",
"created_by": {
"id": 101,
"name": "John Doe",
"email": "user@example.com",
"username": "user@example.com"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": 2,
"route_name": "prefix-route",
"routing_strategy": "Prefix-Based",
"rules": {
"path": "/v1/chat",
"endpoints": [
{
"id": 3036,
"weight": 100
}
]
},
"status": "Active",
"created_by": {
"id": 101,
"name": "John Doe",
"email": "user@example.com",
"username": "user@example.com"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": 3,
"route_name": "header-route",
"routing_strategy": "Header-Based",
"rules": {
"path": "/v1/chat",
"headers": [
{
"key": "x-model",
"type": "Exact",
"value": "llama"
}
],
"endpoints": [
{
"id": 3036,
"weight": 100
}
]
},
"status": "Active",
"created_by": {
"id": 101,
"name": "John Doe",
"email": "user@example.com",
"username": "user@example.com"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
},
{
"id": 4,
"route_name": "path-route",
"routing_strategy": "Path-Based",
"rules": {
"path": "/v1/chat",
"endpoints": [
{
"id": 3036,
"weight": 100
}
]
},
"status": "Active",
"created_by": {
"id": 101,
"name": "John Doe",
"email": "user@example.com",
"username": "user@example.com"
},
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Rule ID.",
"example": 5
},
"route_name": {
"type": "string",
"description": "Rule name.",
"example": "llama-route"
},
"routing_strategy": {
"type": "string",
"enum": [
"Weight-Based",
"Prefix-Based",
"Header-Based",
"Path-Based"
]
},
"rules": {
"type": "object",
"nullable": true,
"description": "Routing configuration. `headers` is only present for `Header-Based` strategy.",
"properties": {
"path": {
"type": "string",
"nullable": true,
"example": "/v1/chat"
},
"headers": {
"type": "array",
"nullable": true,
"description": "Only present for `Header-Based` routing strategy.",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
},
"endpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3036
},
"weight": {
"type": "integer",
"example": 100
}
}
}
}
}
},
"status": {
"type": "string",
"enum": [
"Active",
"Inactive"
],
"example": "Active"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "create-gateway-rule",
"summary": "Create Rule",
"tags": [
"Gateway"
],
"description": "Adds a new routing rule to the gateway.\n\n| `routing_strategy` | Behaviour |\n|---|---|\n| `Weight-Based` | Distributes traffic according to the `weight` assigned to each endpoint. |\n| `Prefix-Based` | Routes requests by URL path prefix. All referenced endpoints must be in `READY` status. |\n| `Header-Based` | Routes requests by matching HTTP request headers. |\n| `Path-Based` | Routes requests by matching the full URL path. |\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"route_name",
"routing_strategy"
],
"properties": {
"route_name": {
"type": "string",
"description": "Name of the routing rule. Must be unique within the gateway.",
"example": "llama-route"
},
"routing_strategy": {
"type": "string",
"description": "Traffic routing strategy.\n- `Weight-Based` — distributes traffic by weight across endpoints.\n- `Prefix-Based` — routes by URL path prefix. All referenced endpoints must be in `READY` status.\n- `Header-Based` — routes by matching HTTP request headers.\n- `Path-Based` — routes by matching the full URL path.\n",
"enum": [
"Weight-Based",
"Prefix-Based",
"Header-Based",
"Path-Based"
]
},
"status": {
"type": "string",
"description": "Initial status of the rule.",
"enum": [
"Active",
"Inactive"
],
"default": "Active",
"example": "Active"
},
"rules": {
"type": "object",
"nullable": true,
"description": "Routing configuration.",
"properties": {
"path": {
"type": "string",
"nullable": true,
"description": "URL path to match (used in `Prefix-Based` and `Path-Based`).",
"example": "/v1/chat"
},
"headers": {
"type": "array",
"nullable": true,
"description": "HTTP headers to match (used in `Header-Based`).",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
},
"endpoints": {
"type": "array",
"description": "List of inference endpoints to route traffic to. Retrieve available endpoint IDs from the [Model Endpoints List](/operations/list-model-endpoints) API (`GET /teams/{Team_Id}/projects/{Project_Id}/serving/inference/`).",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the inference endpoint. Obtain this from the [Model Endpoints List](/operations/list-model-endpoints) API (`GET /teams/{Team_Id}/projects/{Project_Id}/serving/inference/`).",
"example": 3036
},
"weight": {
"type": "integer",
"description": "Traffic weight for this endpoint."
}
}
},
"example": [
{
"id": 3036,
"weight": 70
},
{
"id": 3035,
"weight": 20
},
{
"id": 3037,
"weight": 10
}
]
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Routing rule details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5
},
"route_name": {
"type": "string",
"example": "llama-route"
},
"routing_strategy": {
"type": "string",
"enum": [
"Weight-Based",
"Prefix-Based",
"Header-Based",
"Path-Based"
],
"example": "Weight-Based"
},
"rules": {
"type": "object",
"nullable": true,
"properties": {
"path": {
"type": "string",
"nullable": true,
"example": "/v1/chat"
},
"headers": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
},
"endpoints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3036
},
"weight": {
"type": "integer",
"example": 100
}
}
}
}
}
},
"status": {
"type": "string",
"enum": [
"Active",
"Inactive"
],
"example": "Active"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 101
},
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-01-15T10:30:00Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/gateway/{gateway_id}/rules/{rule_id}/": {
"get": {
"operationId": "get-gateway-rule",
"summary": "Rule Details",
"tags": [
"Gateway"
],
"description": "Returns the full configuration of a specific routing rule.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "rule_id",
"in": "path",
"required": true,
"description": "Rule ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
},
"put": {
"operationId": "update-gateway-rule",
"summary": "Update Rule",
"tags": [
"Gateway"
],
"description": "Updates a routing rule's name, strategy, or match configuration.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "rule_id",
"in": "path",
"required": true,
"description": "Rule ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"route_name": {
"type": "string",
"description": "Updated rule name.",
"example": "updated-route"
},
"routing_strategy": {
"type": "string",
"description": "Updated routing strategy.",
"enum": [
"Weight-Based",
"Prefix-Based",
"Header-Based",
"Path-Based"
]
},
"status": {
"type": "string",
"description": "Updated rule status.",
"enum": [
"Active",
"Inactive"
]
},
"rules": {
"type": "object",
"nullable": true,
"description": "Updated routing configuration.",
"properties": {
"path": {
"type": "string",
"nullable": true,
"example": "/v1/chat"
},
"headers": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "x-model"
},
"type": {
"type": "string",
"example": "Exact"
},
"value": {
"type": "string",
"example": "llama"
}
}
}
},
"endpoints": {
"type": "array",
"description": "List of inference endpoints to route traffic to. Retrieve available endpoint IDs from the [Model Endpoints List](/operations/list-model-endpoints) API (`GET /teams/{Team_Id}/projects/{Project_Id}/serving/inference/`).",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the inference endpoint. Obtain this from the [Model Endpoints List](/operations/list-model-endpoints) API (`GET /teams/{Team_Id}/projects/{Project_Id}/serving/inference/`).",
"example": 3036
},
"weight": {
"type": "integer",
"example": 100
}
}
}
}
}
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "Successful response"
}
}
},
"delete": {
"operationId": "delete-gateway-rule",
"summary": "Delete Rule",
"tags": [
"Gateway"
],
"description": "Removes a routing rule from the gateway.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "gateway_id",
"in": "path",
"required": true,
"description": "Gateway ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "rule_id",
"in": "path",
"required": true,
"description": "Rule ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
}
},
"/rag/knowledgebase/": {
"get": {
"operationId": "get-rag-knowledgebase",
"summary": "List Knowledge Base",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 463
},
"name": {
"type": "string",
"example": "tir-kb-020311335151"
},
"document_count": {
"type": "integer",
"example": 0
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-03T06:03:55.125447Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-03T06:03:55.125492Z"
},
"embedding_model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"display_name": {
"type": "string",
"example": "BAAI/bge-large-en-v1.5"
},
"model_name": {
"type": "string",
"example": "bge-large-en-v1_5"
},
"model_source": {
"type": "string",
"example": "genai"
},
"dimensions": {
"type": "integer",
"example": 1024
}
}
},
"chunking_method": {
"type": "string",
"example": "general"
},
"chunking_configuration": {
"type": "object",
"properties": {
"delimiter": {
"type": "string",
"example": "\n!?;。；！？"
},
"chunk_size": {
"type": "integer",
"example": 128
},
"entity_types": {
"type": "array",
"items": {
"type": "string",
"example": "organization"
}
},
"layout_recognition": {
"type": "boolean",
"example": true
}
}
},
"model_source": {
"type": "string",
"example": "genai"
},
"model_name": {
"type": "string",
"example": "bge-large-en-v1_5"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": true
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-rag-knowledgebase",
"summary": "Create Knowledge Base",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the knowledge base (must be unique per project)"
},
"project_id": {
"type": "integer",
"description": "Project ID the knowledge base belongs to"
},
"chunking_method": {
"type": "string",
"enum": [
"general",
"qa",
"manual",
"table",
"paper",
"book",
"laws",
"presentation",
"one",
"knowledge_graph"
],
"description": "Document chunking strategy"
},
"chunking_configuration": {
"type": "object",
"description": "Chunking parameters (varies by chunking_method)",
"properties": {
"chunk_size": {
"type": "integer",
"description": "Token count per chunk (min 32, max 2048; max 16384 for knowledge_graph)"
},
"delimiter": {
"type": "string",
"description": "Delimiter characters for splitting"
},
"layout_recognition": {
"type": "boolean",
"description": "Enable layout-aware chunking"
},
"entity_types": {
"type": "array",
"items": {
"type": "string"
},
"description": "Entity types for knowledge_graph method"
},
"enable_keywords": {
"type": "boolean",
"description": "Auto-generate keywords"
},
"auto_questions": {
"type": "integer",
"description": "Number of auto-generated questions (0-10)"
}
}
},
"embedding_details": {
"type": "object",
"description": "Embedding model configuration",
"properties": {
"model_id": {
"type": "integer",
"description": "Embedding model ID"
},
"model_source": {
"type": "string",
"enum": [
"genai",
"inference"
],
"description": "Source of the embedding model"
},
"model_name": {
"type": "string",
"description": "Model name (required if model_source is inference)"
},
"max_tokens": {
"type": "integer",
"description": "Maximum tokens for the embedding model"
}
},
"required": [
"model_id",
"model_source"
]
},
"llm_details": {
"type": "object",
"description": "LLM model configuration",
"properties": {
"model_id": {
"type": "integer",
"description": "LLM model ID"
},
"model_source": {
"type": "string",
"enum": [
"genai",
"inference"
],
"description": "Source of the LLM model"
},
"model_name": {
"type": "string",
"description": "Model name (required if model_source is inference)"
},
"max_tokens": {
"type": "integer",
"description": "Maximum tokens for the LLM model"
}
},
"required": [
"model_id",
"model_source"
]
},
"pagerank": {
"type": "integer",
"description": "Priority when multiple KBs in assistant (0-100)",
"default": 0
}
},
"required": [
"name",
"project_id",
"chunking_method",
"chunking_configuration",
"embedding_details",
"llm_details"
]
}
}
}
},
"responses": {
"201": {
"description": "Created Successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 281
},
"name": {
"type": "string",
"example": "tir-kb-12241fd517000"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-12-24T10:03:25.361601Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-12-24T10:03:25.640855Z"
},
"embedding_model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2
},
"display_name": {
"type": "string",
"example": "BAAI/bge-large-en-v1.5"
},
"model_name": {
"type": "string",
"example": "bge-large-en-v1_5"
},
"model_source": {
"type": "string",
"example": "genai"
},
"dimensions": {
"type": "integer",
"example": 1024
}
}
},
"chunking_method": {
"type": "string",
"example": "qa"
},
"chunking_configuration": {
"type": "object",
"properties": {}
},
"model_source": {
"type": "string",
"example": "genai"
},
"model_name": {
"type": "string",
"example": "bge-large-en-v1_5"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/": {
"put": {
"operationId": "put-rag-knowledgebase-kb-id",
"summary": "Update Knowledge Base",
"tags": [
"RAG (Knowledge Base)"
],
"description": "Update knowledge base configuration including name, chunking, embedding model, and LLM settings.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "testing"
},
"chunking_method": {
"type": "string",
"enum": [
"general",
"qa",
"manual",
"table",
"paper",
"book",
"laws",
"presentation",
"one",
"knowledge_graph"
],
"example": "general"
},
"embedding_details": {
"type": "object",
"properties": {
"model_id": {
"type": "integer",
"example": 11
},
"model_name": {
"type": "string",
"example": "bge_large_en_v1_5"
},
"model_source": {
"type": "string",
"example": "genai"
},
"max_tokens": {
"type": "integer",
"example": 512
}
}
},
"llm_details": {
"type": "object",
"properties": {
"model_id": {
"type": "integer",
"example": 14
},
"model_name": {
"type": "string",
"example": "gpt_oss_120b"
},
"model_source": {
"type": "string",
"example": "genai"
},
"max_tokens": {
"type": "integer",
"example": 131072
}
}
},
"chunking_configuration": {
"type": "object",
"properties": {
"chunk_size": {
"type": "integer",
"example": 256
},
"auto_questions": {
"type": "integer",
"example": 1
},
"pagerank": {
"type": "integer",
"example": 50
},
"delimiter": {
"type": "string",
"example": "!?;。；！？"
},
"entity_types": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"organization"
]
}
}
},
"kbId": {
"type": "integer",
"example": 1300
}
},
"required": [
"name",
"chunking_method",
"embedding_details",
"llm_details",
"chunking_configuration"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Knowledge base updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1300
},
"name": {
"type": "string",
"example": "testing"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-26T09:57:31Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-26T09:57:31Z"
},
"embedding_model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 11
},
"display_name": {
"type": "string",
"example": "BAAI/bge-large-en-v1.5"
},
"model_name": {
"type": "string",
"example": "bge_large_en_v1_5"
},
"model_source": {
"type": "string",
"example": "genai"
},
"max_tokens": {
"type": "integer",
"example": 512
},
"location": {
"type": "string",
"example": "Delhi"
},
"dimensions": {
"type": "integer",
"example": 1024
}
}
},
"chunking_method": {
"type": "string",
"example": "general"
},
"chunking_configuration": {
"type": "object",
"properties": {
"chunk_size": {
"type": "integer",
"example": 256
},
"auto_questions": {
"type": "integer",
"example": 1
},
"pagerank": {
"type": "integer",
"example": 50
},
"delimiter": {
"type": "string",
"example": "!?;。；！？"
},
"entity_types": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"organization"
]
}
}
},
"llm_model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 14
},
"display_name": {
"type": "string",
"example": "openai/gpt-oss-120b"
},
"model_name": {
"type": "string",
"example": "gpt_oss_120b"
},
"model_source": {
"type": "string",
"example": "genai"
},
"max_tokens": {
"type": "integer",
"example": 131072
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-rag-knowledgebase-kb-id",
"summary": "Delete Knowledge Base",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Chunk deleted successfully"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/documents/": {
"get": {
"operationId": "get-rag-knowledgebase-kb-id-documents",
"summary": "Document List in Knowledge Base",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of uploaded files",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "929bd236c12011ef866456883a4e8c86"
},
"name": {
"type": "string",
"example": "tir-job-121712374040_31_results_completeness_2024-12-17_07-10-40.json"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-12-23T16:55:11.458000+05:30"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-12-23T16:55:11.458000+05:30"
},
"status": {
"type": "string",
"example": "Uploaded"
},
"parse_progress": {
"type": "integer",
"example": 0
},
"document_enabled": {
"type": "boolean",
"example": true
},
"chunk_count": {
"type": "integer",
"example": 0
},
"chunking_method": {
"type": "string",
"example": "general"
},
"chunking_configuration": {
"type": "object",
"properties": {
"chunk_size": {
"type": "integer",
"example": 128
},
"delimiter": {
"type": "string",
"example": "!?;。；！？"
},
"entity_types": {
"type": "array",
"items": {
"type": "string"
},
"example": null
},
"layout_recognition": {
"type": "boolean",
"example": true
},
"pages_range": {
"type": "string",
"example": null
},
"raptor": {
"type": "string",
"example": null
},
"task_per_page": {
"type": "string",
"example": null
}
}
},
"progress_log": {
"type": "string",
"example": ""
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"total_count": {
"type": "integer",
"example": 4
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-rag-knowledgebase-kb-id-documents",
"summary": "Bulk Action on KB Document",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"start",
"stop",
"enable",
"disable",
"delete"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"document_ids": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Successfully enabled the documents"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/retrieval/": {
"post": {
"operationId": "post-rag-knowledgebase-kb-id-retrieval",
"summary": "Retrieval Testing on Knowledge Base",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"example": 1
},
"size": {
"type": "integer",
"example": 10
},
"question": {
"type": "string",
"example": "item"
},
"similarity_threshold": {
"type": "number",
"format": "float",
"example": 0.2
},
"vector_similarity_weight": {
"type": "number",
"format": "float",
"example": 0.21
},
"top_k": {
"type": "integer",
"example": 1024
},
"rerank_id": {
"type": "integer",
"example": 5
},
"doc_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": []
}
},
"required": [
"page",
"size",
"question",
"similarity_threshold",
"vector_similarity_weight",
"top_k",
"rerank_id",
"doc_ids"
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"chunks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"chunk_id": {
"type": "string",
"example": "1510993c99b187dd071ac655b7f7e838"
},
"content_ltks": {
"type": "string",
"example": "e-enetworks.t 0.00 f) inco from previ mployer pay item am total linc th> | \n| (i) Iing |
|---|
\n| Sub Total | |
|---|
\n"
},
"doc_id": {
"type": "string",
"example": "f337f46eb88111efafd816fd5bc7de9f"
},
"docnm_kwd": {
"type": "string",
"example": "Aashish (4).pdf"
},
"img_id": {
"type": "string",
"example": "ragf-4624e122b78911ef943362d4577b3e2b-1510993c99b187dd071ac655b7f7e838"
},
"important_kwd": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"kb_id": {
"type": "string",
"example": "ragf-4624e122b78911ef943362d4577b3e2b"
},
"positions": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"example": [
[
1,
28,
298,
316,
829
]
]
},
"similarity": {
"type": "number",
"format": "float",
"example": 0.21638480767672919
},
"term_similarity": {
"type": "number",
"format": "float",
"example": 0.6761202015558534
},
"vector_similarity": {
"type": "number",
"format": "float",
"example": 0.094176665
}
}
}
},
"doc_aggs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 1
},
"doc_id": {
"type": "string",
"example": "f337f46eb88111efafd816fd5bc7de9f"
},
"doc_name": {
"type": "string",
"example": "Aashish (4).pdf"
}
}
}
},
"total": {
"type": "integer",
"example": 3
}
}
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/documents/{Doc_Id}/action/": {
"put": {
"operationId": "put-rag-knowledgebase-kb-id-documents-doc-id-action",
"summary": "Action on Document",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"start",
"stop",
"enable",
"disable"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Successfully disabled the documents"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/documents/{Doc_Id}/": {
"put": {
"operationId": "put-rag-knowledgebase-kb-id-documents-doc-id",
"summary": "Update Document",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "DBMS_Full_Notes.pdf"
},
"chunking_method": {
"type": "string",
"enum": [
"general",
"qa",
"manual",
"table",
"paper",
"book",
"laws",
"presentation",
"one",
"knowledge_graph"
]
},
"chunking_configuration": {
"type": "object",
"properties": {
"chunk_size": {
"type": "integer",
"example": 128
},
"delimiter": {
"type": "string",
"example": "!?;。；！？"
},
"layout_recognition": {
"type": "boolean",
"example": true
},
"task_page_size": {
"type": "integer",
"example": 12
},
"pages": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
}
},
"example": [
[
1,
30
],
[
45,
56
]
]
},
"entity_types": {
"type": "array",
"items": {
"type": "string"
},
"example": []
}
}
}
},
"required": [
"name",
"chunking_method",
"chunking_configuration"
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Document Chunking Method updated successfully"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-rag-knowledgebase-kb-id-documents-doc-id",
"summary": "Delete Document",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Document deleted successfully"
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/documents/{Doc_Id}/chunks/": {
"get": {
"operationId": "get-rag-knowledgebase-kb-id-documents-doc-id-chunks",
"summary": "Get Chunk List in the Document",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"available_int": {
"type": "integer",
"example": 1
},
"chunk_id": {
"type": "string",
"example": "88b4bea734a9b6bbfef0dfdbf71fa45f"
},
"content_with_weight": {
"type": "string",
"example": "4r4"
},
"doc_id": {
"type": "string",
"example": "929bd236c12011ef866456883a4e8c86"
},
"docnm_kwd": {
"type": "string",
"example": "tir-job-121712374040_31_results_completeness_2024-12-17_07-10-40.json"
},
"img_id": {
"type": "string",
"example": ""
},
"important_kwd": {
"type": "string",
"example": "4f"
},
"positions": {
"type": "array",
"items": {
"type": "string"
},
"example": [
""
]
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-rag-knowledgebase-kb-id-documents-doc-id-chunks",
"summary": "Add chunks to the Document",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string",
"example": "John"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"John"
]
}
},
"required": [
"content",
"keywords"
]
}
}
}
},
"responses": {
"201": {
"description": "Created Successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"chunk_id": {
"type": "string",
"example": "3a10d0c433c5c2e0d3a5738f3110c96d"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-rag-knowledgebase-kb-id-documents-doc-id-chunks",
"summary": "Bulk action on chunks",
"tags": [
"RAG (Knowledge Base)"
],
"description": "Enable, disable, or delete chunks in a document",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"enable",
"disable",
"delete"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"chunk_ids": {
"type": "array",
"description": "List of chunk IDs to modify",
"items": {
"type": "string"
}
}
},
"required": [
"chunk_ids"
]
},
"example": {
"chunk_ids": [
"359fa1f03ca7914adbf2a71b448",
"0d871faf6aba43c518d2c599527"
]
}
}
}
},
"responses": {
"200": {
"description": "Successfully modified the chunks",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {
"type": "string"
},
"errors": {
"type": "object"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/documents/{Doc_Id}/chunks/{Chunk_Id}/action/{action}/": {
"put": {
"operationId": "put-rag-knowledgebase-kb-id-documents-doc-id-chunks-chunk-id-action-action",
"summary": "Enable or disable a chunk",
"tags": [
"RAG (Knowledge Base)"
],
"description": "Perform an action (enable or disable) on a specific chunk of a document",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "Chunk_Id",
"in": "path",
"required": true,
"description": "Chunk_Id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action",
"in": "path",
"required": true,
"description": "Action to perform on the chunk (enable or disable)",
"schema": {
"type": "string",
"enum": [
"enable",
"disable"
]
}
}
],
"responses": {
"200": {
"description": "Successfully updated the chunk status",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer"
},
"data": {
"type": "string"
},
"errors": {
"type": "object"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"/rag/knowledgebase/{KB_Id}/documents/{Doc_Id}/chunks/{Chunk_Id}/": {
"put": {
"operationId": "put-rag-knowledgebase-kb-id-documents-doc-id-chunks-chunk-id",
"summary": "Update Chunk",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "Chunk_Id",
"in": "path",
"required": true,
"description": "Chunk_Id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"content": {
"type": "string",
"example": "your-content"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"gtgt",
"cece"
]
}
},
"required": [
"content",
"keywords"
]
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Chunk updated successfully"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-rag-knowledgebase-kb-id-documents-doc-id-chunks-chunk-id",
"summary": "Delete Chunk",
"tags": [
"RAG (Knowledge Base)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Doc_Id",
"in": "path",
"required": true,
"description": "document_id",
"schema": {
"type": "string"
}
},
{
"name": "Chunk_Id",
"in": "path",
"required": true,
"description": "Chunk_Id",
"schema": {
"type": "string"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
}
},
"/rag/knowledgebase/{KB_Id}/import/": {
"post": {
"operationId": "post-rag-knowledgebase-kb-id-import",
"summary": "Import Documents",
"tags": [
"RAG (Knowledge Base)"
],
"description": "Import documents into the knowledge base from a connected data source or dataset.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "KB_Id",
"in": "path",
"required": true,
"description": "knowledgebase_id",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"config": {
"type": "object",
"properties": {
"dataset_id": {
"type": "integer",
"example": 3606
}
}
},
"file_search_filter": {
"type": "array",
"description": "File patterns to include",
"items": {
"type": "string"
},
"example": [
"*"
]
},
"path_array": {
"type": "array",
"description": "Specific paths to import (empty means full dataset)",
"items": {
"type": "string"
},
"example": []
},
"run": {
"type": "integer",
"description": "Flag to trigger execution immediately",
"example": 1
},
"source_connector_id": {
"type": "integer",
"description": "ID of the source connector",
"example": 6
}
},
"required": [
"config",
"run",
"source_connector_id"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Import job started successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Import job ID",
"example": 537
},
"status": {
"type": "string",
"description": "Current status of import job",
"enum": [
"pending",
"running",
"completed",
"failed"
],
"example": "running"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-26T10:33:39Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-26T10:33:39Z"
},
"streamAggregatedStats": {
"type": "array",
"description": "Aggregated stats for streaming import",
"items": {
"type": "object"
},
"example": []
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/rag/assistant/": {
"get": {
"operationId": "get-rag-assistant",
"summary": "Chat Assistant List",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "jkhgti7667tiuyg67fiu"
},
"name": {
"type": "string",
"example": "tir-rag-assistant-013011464343"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-30T11:46:49.045000+05:30"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-30T11:46:49.045000+05:30"
},
"knowledge_bases": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"tir-kb-013011463636"
]
},
"kb_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
415
]
},
"llm_setting": {
"type": "object",
"properties": {
"frequency_penalty": {
"type": "number",
"example": 0.7
},
"max_tokens": {
"type": "integer",
"example": 512
},
"presence_penalty": {
"type": "number",
"example": 0.4
},
"temperature": {
"type": "number",
"example": 0.1
},
"top_p": {
"type": "number",
"example": 0.3
}
}
},
"prompt_config": {
"type": "object",
"properties": {
"empty_response_prompt": {
"type": "string",
"example": "The answer you are looking for is not found in the knowledge base!"
},
"greeting": {
"type": "string",
"example": "Hi! I'm your assistant, what can I do for you?"
},
"system_prompt": {
"type": "string",
"example": "You are an intelligent assistant..."
},
"show_quote": {
"type": "boolean",
"example": true
},
"prev_n_conv": {
"type": "integer",
"example": 5
},
"query_optimization": {
"type": "boolean",
"example": false
}
}
},
"top_k": {
"type": "integer",
"example": 1024
},
"rerank_id": {
"type": "string",
"example": ""
},
"llm_id": {
"type": "integer",
"example": 4
},
"similarity_threshold": {
"type": "number",
"example": 0.2
},
"vector_similarity_weight": {
"type": "number",
"example": 0.7
},
"top_n": {
"type": "integer",
"example": 8
},
"llm_model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4
},
"display_name": {
"type": "string",
"example": "Mistral-7B-Instruct-v0.3"
},
"model_name": {
"type": "string",
"example": "mistral_7b_instruct"
},
"model_source": {
"type": "string",
"example": "genai"
}
}
},
"llm_model_name": {
"type": "string",
"example": "mistral_7b_instruct"
},
"llm_model_source": {
"type": "string",
"example": "genai"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-rag-assistant",
"summary": "Create an assistant",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "tir-rag-assistant-260326161850"
},
"prompt_config": {
"type": "object",
"properties": {
"show_quote": {
"type": "boolean",
"example": true
},
"prev_n_conv": {
"type": "integer",
"example": 5
},
"greeting": {
"type": "string",
"example": "Hi! I'm your assistant, what can I do for you?"
},
"system_prompt": {
"type": "string",
"example": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When no relevant information is found in the knowledge base, your answer must include \"relevant information was not found in the knowledge base!\" Answers need to consider chat history."
},
"empty_response_prompt": {
"type": "string",
"example": "The answer you are looking for is not found in the knowledge base!"
},
"query_optimization": {
"type": "boolean",
"example": false
}
}
},
"similarity_threshold": {
"type": "number",
"format": "float",
"example": 0.2
},
"vector_similarity_weight": {
"type": "number",
"format": "float",
"example": 0.7
},
"top_n": {
"type": "integer",
"example": 8
},
"isConversationsEnabled": {
"type": "boolean",
"example": false
},
"top_k": {
"type": "integer",
"example": 1024
},
"llm_model_source": {
"type": "string",
"example": "genai"
},
"llm_max_tokens": {
"type": "integer",
"example": 131072
},
"llm_setting": {
"type": "object",
"properties": {
"frequency_penalty": {
"type": "number",
"format": "float",
"example": 0.7
},
"max_tokens": {
"type": "integer",
"example": 16000
},
"presence_penalty": {
"type": "number",
"format": "float",
"example": 0.4
},
"temperature": {
"type": "number",
"format": "float",
"example": 0.1
},
"top_p": {
"type": "number",
"format": "float",
"example": 0.3
}
}
},
"kb_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
1299
]
},
"llm_id": {
"type": "integer",
"example": 1
}
},
"required": [
"name",
"prompt_config",
"similarity_threshold",
"vector_similarity_weight",
"top_n",
"isConversationsEnabled",
"top_k",
"llm_model_source",
"llm_max_tokens",
"llm_setting",
"kb_ids",
"llm_id"
]
}
}
}
},
"responses": {
"201": {
"description": "Assistant created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"assistant_id": {
"type": "string",
"example": "juti78uyt76yufg6r7"
}
}
},
"errors": {
"type": "object"
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/rag/assistant/{Assistant_Id}": {
"get": {
"operationId": "get-rag-assistant-assistant-id",
"summary": "Assistant Details",
"tags": [
"RAG (Chat Assistant)"
],
"description": "**Note:** Please copy and save the \"api_key\" received in the response for using in: \"List Chats\", \"Conversation\" and \"Conversation History\", \"Rename Conversation\"\n",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Assistant_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved assistant configuration",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "jhgtu6t7iuyfi76urtfu"
},
"name": {
"type": "string",
"example": "tir-rag-assistant-013014213636"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-30T14:21:41.660000+05:30"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-01-30T14:21:41.660000+05:30"
},
"knowledge_bases": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"keyboard-shortcuts"
]
},
"kb_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
371
]
},
"llm_setting": {
"type": "object",
"properties": {
"frequency_penalty": {
"type": "number",
"format": "float",
"example": 0.7
},
"max_tokens": {
"type": "integer",
"example": 512
},
"presence_penalty": {
"type": "number",
"format": "float",
"example": 0.4
},
"temperature": {
"type": "number",
"format": "float",
"example": 0.1
},
"top_p": {
"type": "number",
"format": "float",
"example": 0.3
}
}
},
"prompt_config": {
"type": "object",
"properties": {
"empty_response_prompt": {
"type": "string",
"example": "The answer you are looking for is not found in the knowledge base!"
},
"greeting": {
"type": "string",
"example": "Hi! I'm your assistant, what can I do for you?"
},
"system_prompt": {
"type": "string",
"example": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question.\nPlease list the data in the knowledge base and answer in detail.\nWhen no relevant information is found in the knowledge base, your answer must include \"relevant information was not found in the knowledge base!\" Answers need to consider chat history.\n"
},
"show_quote": {
"type": "boolean",
"example": true
},
"prev_n_conv": {
"type": "integer",
"example": 5
},
"query_optimization": {
"type": "boolean",
"example": false
}
}
},
"top_k": {
"type": "integer",
"example": 1024
},
"rerank_id": {
"type": "string",
"example": ""
},
"llm_id": {
"type": "integer",
"example": 4
},
"similarity_threshold": {
"type": "number",
"format": "float",
"example": 0.2
},
"vector_similarity_weight": {
"type": "number",
"format": "float",
"example": 0.7
},
"top_n": {
"type": "integer",
"example": 8
},
"llm_model": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4
},
"display_name": {
"type": "string",
"example": "Mistral-7B-Instruct-v0.3"
},
"model_name": {
"type": "string",
"example": "mistral_7b_instruct"
},
"model_source": {
"type": "string",
"example": "genai"
}
}
},
"llm_model_name": {
"type": "string",
"example": "mistral_7b_instruct"
},
"llm_model_source": {
"type": "string",
"example": "genai"
},
"api_key": {
"type": "string",
"example": "rag-ZkOWI5Mzg4ZGVlNzExZWZiOTcxMmUxZW"
}
}
},
"errors": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-rag-assistant-assistant-id",
"summary": "Update an assistant",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Assistant_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "iyt87i76tfgi76kuiyi7t7g8g"
},
"name": {
"type": "string",
"example": "testing-assistant"
},
"kb_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
354,
371
]
},
"prompt_config": {
"type": "object",
"properties": {
"empty_response_prompt": {
"type": "string",
"example": "404! Not found"
},
"greeting": {
"type": "string",
"example": "Hello, how are you?"
},
"system_prompt": {
"type": "string",
"example": "You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question.\nPlease list the data in the knowledge base and answer in detail.\nWhen no relevant information is found in the knowledge base, your answer must include 'relevant information was not found in the knowledge base!' Answers need to consider chat history.\n"
},
"show_quote": {
"type": "boolean",
"example": true
},
"prev_n_conv": {
"type": "integer",
"example": -1
},
"query_optimization": {
"type": "boolean",
"example": true
}
}
},
"similarity_threshold": {
"type": "number",
"format": "float",
"example": 0.27
},
"vector_similarity_weight": {
"type": "number",
"format": "float",
"example": 0.63
},
"top_n": {
"type": "integer",
"example": 8
},
"llm_id": {
"type": "integer",
"example": 4
},
"llm_setting": {
"type": "object",
"properties": {
"frequency_penalty": {
"type": "number",
"format": "float",
"example": 0.7
},
"max_tokens": {
"type": "integer",
"example": 512
},
"presence_penalty": {
"type": "number",
"format": "float",
"example": 0.4
},
"temperature": {
"type": "number",
"format": "float",
"example": 0.1
},
"top_p": {
"type": "number",
"format": "float",
"example": 0.3
}
}
},
"rerank_id": {
"type": "integer",
"example": 5
},
"top_k": {
"type": "integer",
"example": 1024
},
"llm_model_source": {
"type": "string",
"example": "genai"
},
"llm_model_name": {
"type": "string",
"example": "mistral_7b_instruct"
},
"isConversationsEnabled": {
"type": "boolean",
"example": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "Assistant updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Assistant updated successfully"
},
"errors": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/rag/assistant/{Assistant_Id}/": {
"delete": {
"operationId": "delete-rag-assistant-assistant-id",
"summary": "Delete an assistant",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Assistant_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Assistant deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Assistant deleted successfully"
},
"errors": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/conversation_list/": {
"get": {
"operationId": "get-conversation-list",
"summary": "List Chats for Assistant",
"tags": [
"RAG (Chat Assistant)"
],
"description": "**Note:** \"Use the Rag token saved in \"Assistant Details\" request\"\n",
"parameters": [
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"create_date": {
"type": "string",
"format": "date-time",
"example": "Thu, 30 Jan 2025 09:36:04 GMT"
},
"create_time": {
"type": "integer",
"example": 1738229764128
},
"deleted": {
"type": "boolean",
"example": false
},
"deleted_at": {
"type": "string",
"nullable": true,
"example": null
},
"dialog_id": {
"type": "string",
"example": "jgh45yu4wielh589iuthbeli"
},
"duration": {
"type": "integer",
"example": 0
},
"id": {
"type": "string",
"example": "4i375yo87yugh4387tiukg"
},
"message": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string",
"example": "Hi! I'm your assistant, what can I do for you?"
},
"role": {
"type": "string",
"example": "assistant"
}
}
}
},
"name": {
"type": "string",
"example": ""
},
"reference": {
"type": "array",
"items": {
"type": "string"
}
},
"round": {
"type": "integer",
"example": 0
},
"source": {
"type": "string",
"nullable": true,
"example": null
},
"thumb_up": {
"type": "integer",
"example": 0
},
"tokens": {
"type": "integer",
"example": 0
},
"update_date": {
"type": "string",
"format": "date-time",
"example": "Thu, 30 Jan 2025 09:36:04 GMT"
},
"update_time": {
"type": "integer",
"example": 1738229764128
},
"user_id": {
"type": "string",
"example": ""
}
}
}
},
"retcode": {
"type": "integer",
"example": 0
},
"retmsg": {
"type": "string",
"example": "success"
}
}
}
}
}
}
}
}
},
"/rag/assistant/{Assistant_Id}/chat/": {
"post": {
"operationId": "post-rag-assistant-assistant-id-chat",
"summary": "Create a new chat in assistant",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Assistant_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully created a conversation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "eyt47843iughbjfkreu7yt478i"
},
"name": {
"type": "string",
"example": ""
},
"message": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string",
"example": "Hi! I'm your assistant, what can I do for you?"
},
"role": {
"type": "string",
"example": "assistant"
}
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/conversation/{Conversation_Id}": {
"get": {
"operationId": "get-conversation-conversation-id",
"summary": "Conversation History",
"tags": [
"RAG (Chat Assistant)"
],
"description": "**Note:** \"Use the Rag token saved in \"Assistant Details\" request\"\n",
"parameters": [
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Conversation_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved dialog information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"create_date": {
"type": "string",
"example": "Thu, 30 Jan 2025 10:13:15 GMT"
},
"create_time": {
"type": "integer",
"example": 1738231995009
},
"deleted": {
"type": "boolean",
"example": false
},
"deleted_at": {
"type": "string",
"nullable": true,
"example": null
},
"dialog_id": {
"type": "string",
"example": "7iyf78dofyiuhfgiu87"
},
"duration": {
"type": "integer",
"example": 0
},
"id": {
"type": "string",
"example": "i8ydf78ohdf7yg7dfh8"
},
"message": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"role": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"example": [
{
"content": "Hi! I'm your assistant, what can I do for you?",
"role": "assistant"
},
{
"content": "Hello, How are you?\n",
"id": "jyt78ugo6yugt78tg87t87guy",
"role": "user"
},
{
"content": "The answer you are looking for is not found in the knowledge base!",
"id": "bkjhutyi78t6gyi76uf75tfi6",
"role": "assistant"
}
]
},
"name": {
"type": "string",
"example": "Hello, How are you?\n"
},
"reference": {
"type": "array",
"items": {
"type": "object",
"properties": {
"chunks": {
"type": "array"
},
"doc_aggs": {
"type": "array"
},
"total": {
"type": "integer"
}
}
},
"example": [
{
"chunks": [],
"doc_aggs": [],
"total": 0
}
]
},
"round": {
"type": "integer",
"example": 1
},
"source": {
"type": "string",
"nullable": true,
"example": null
},
"thumb_up": {
"type": "integer",
"example": 0
},
"tokens": {
"type": "integer",
"example": 0
},
"update_date": {
"type": "string",
"example": "Thu, 30 Jan 2025 10:18:30 GMT"
},
"update_time": {
"type": "integer",
"example": 1738232310638
},
"user_id": {
"type": "string",
"example": ""
}
}
},
"errors": {
"type": "object",
"additionalProperties": true,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-conversation-conversation-id",
"summary": "Rename Conversation",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Conversation_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Testing Rename"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"retcode": {
"type": "integer",
"example": 0
},
"retmsg": {
"type": "string",
"example": "success"
},
"data": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
}
},
"/completion": {
"post": {
"operationId": "post-completion",
"summary": "Chat Completion",
"tags": [
"RAG (Chat Assistant)"
],
"description": "**Note:** \"Use the Rag token saved in \"Assistant Details\" request\"\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"conversation_id": {
"type": "string",
"description": "Unique ID of the conversation.",
"example": "65776ir5tifgtuytjj6"
},
"messages": {
"type": "array",
"description": "List of messages exchanged in the conversation.",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"description": "The role of the sender (e.g., user, assistant).",
"example": "user"
},
"content": {
"type": "string",
"description": "The message content sent by the user.",
"example": "hello\n"
}
}
}
},
"quote": {
"type": "boolean",
"description": "Whether to include citations (quotes) in the response.",
"example": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"retcode": {
"type": "integer"
},
"retmsg": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"answer": {
"type": "string"
},
"reference": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"chunks": {
"type": "array",
"items": {}
},
"doc_aggs": {
"type": "array",
"items": {}
}
}
},
"audio_binary": {
"type": "string",
"nullable": true
},
"id": {
"type": "string"
}
}
}
},
"example": {
"retcode": 0,
"retmsg": "",
"data": {
"answer": "The answer you are looking for is not found in the knowledge base!",
"reference": {
"total": 0,
"chunks": [],
"doc_aggs": []
},
"audio_binary": null,
"id": "7678t7tygugi67ygiyg6iut"
}
}
},
{
"type": "object",
"properties": {
"retcode": {
"type": "integer"
},
"retmsg": {
"type": "string"
},
"data": {
"type": "boolean"
}
},
"example": {
"retcode": 0,
"retmsg": "",
"data": true
}
}
]
}
}
}
}
}
}
},
"/conversation/{Conversation_Id}/v1/chat/completions": {
"post": {
"operationId": "post-conversation-conversation-id-v1-chat-completions",
"summary": "Chat Completion (Open AI)",
"tags": [
"RAG (Chat Assistant)"
],
"description": "Send a prompt to the chat model and receive a response (OPEN AI Compatible) | **Note:** \"Use the Rag token saved in \"Assistant Details\" request\"",
"parameters": [
{
"name": "Conversation_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"model": {
"type": "string",
"description": "Model to use for chat completion. Available models:\n - `mistral_7b_instruct` (Mistral-7B-Instruct-v0.3)\n - `gemma_7b` (Gemma-7B-It)\n - `llama3_1_8b_instruct` (Llama-3.1-8B-Instruct)\n - `llama_3_2_11b_vision_instruct` (Llama-3.2-11B-Vision-Instruct)\n - `llama3_2_3b_instruct` (Llama-3.2-3B-Instruct)\n - `llama_3_3_70b_instruct_fp8` (Llama-3.3-70B-Instruct)\n - `phi_3_medium_128k_instruct` (Phi-3-Medium-128K-Instruct)\n"
},
"messages": {
"type": "array",
"description": "List of messages in the conversation",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"user",
"system",
"assistant"
],
"description": "Role of the message sender"
},
"content": {
"type": "string",
"description": "Message content"
}
}
}
},
"stream": {
"type": "boolean",
"description": "Whether to stream the response",
"default": true
}
},
"required": [
"model",
"messages"
]
}
}
}
},
"responses": {
"200": {
"description": "Streamed chat response with multiple chunks",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the response"
},
"object": {
"type": "string",
"description": "Type of response object",
"enum": [
"chat.completion.chunk"
]
},
"created": {
"type": "integer",
"description": "Timestamp of response creation (milliseconds)"
},
"model": {
"type": "string",
"description": "Model used for the response"
},
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"description": "Index of the response choice"
},
"delta": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"assistant",
null
],
"description": "Role of the sender (null if continuation chunk)"
},
"content": {
"type": "string",
"description": "Partial or complete response content"
},
"tool_calls": {
"type": "array",
"items": {
"type": "object"
},
"description": "Tool call details (if any)"
}
}
},
"logprobs": {
"type": "object",
"nullable": true,
"description": "Log probabilities for token predictions"
},
"finish_reason": {
"type": "string",
"nullable": true,
"enum": [
"stop",
null
],
"description": "Completion reason (`stop` if finished, `null` if continuing)"
},
"stop_reason": {
"type": "string",
"nullable": true,
"description": "Additional stopping reason (if any)"
}
}
}
},
"usage": {
"type": "object",
"nullable": true,
"properties": {
"prompt_tokens": {
"type": "integer",
"description": "Number of tokens in the prompt"
},
"completion_tokens": {
"type": "integer",
"description": "Number of tokens generated"
},
"total_tokens": {
"type": "integer",
"description": "Total token count"
}
}
}
}
}
}
}
}
}
}
},
"/rag/assistant/{Assistant_Id}/chat/{Conversation_Id}/": {
"delete": {
"operationId": "delete-rag-assistant-assistant-id-chat-conversation-id",
"summary": "Delete a conversation",
"tags": [
"RAG (Chat Assistant)"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Assistant_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Conversation_Id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Chat deleted successfully"
},
"errors": {
"type": "object",
"example": {}
},
"messages": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/": {
"get": {
"operationId": "get-pipelines",
"summary": "Pipeline List",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_size",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful retrieval of pipeline list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1556
},
"name": {
"type": "string",
"example": "helloworld-124-1731580109"
},
"description": {
"type": "string",
"example": "initial"
},
"parameters": {
"type": "string",
"example": ""
},
"pipeline_id": {
"type": "string",
"example": "824dccf7-edab-4b69-8f7a-6b77f726f74b"
},
"runs": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"default_version_id": {
"type": "string",
"example": "1c48f3a2-70cb-4deb-9b83-36678c2f507c"
},
"pipeline_type": {
"type": "string",
"example": "Argo"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:29.987561Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:31.355315Z"
},
"source": {
"type": "string",
"example": "pipeline"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/pipelines/upload/": {
"post": {
"operationId": "post-pipelines-upload",
"summary": "Create Pipeline",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "name",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "description",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "initial_setup",
"in": "query",
"required": false,
"description": "Set to true to create a default hello-world pipeline without uploading a YAML file. When true and no file is uploaded, the name is auto-generated.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"uploadfile": {
"type": "string",
"format": "binary",
"description": "Pipeline YAML file to upload. Required when initial_setup is false or not provided."
}
}
}
}
}
},
"responses": {
"200": {
"description": "Pipeline updated or created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1555
},
"name": {
"type": "string",
"example": "helloworld-124-1731578705"
},
"description": {
"type": "string",
"example": "initial pipeline"
},
"parameters": {
"type": "string",
"example": ""
},
"pipeline_id": {
"type": "string",
"example": "41593f2d-2376-4d66-b1e8-7cc54744e2f0"
},
"runs": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"default_version_id": {
"type": "string",
"example": "2bed88c1-f50f-4468-a223-48c39492bf33"
},
"pipeline_type": {
"type": "string",
"example": "Argo"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:05:05.835283Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:05:06.149908Z"
},
"source": {
"type": "string",
"example": "pipeline"
},
"new_version_id": {
"type": "integer",
"example": 1791
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/pipelines/{pipeline_id}/": {
"get": {
"operationId": "get-pipelines-pipeline-id",
"summary": "Pipeline Details",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful retrieval of pipeline details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1556
},
"name": {
"type": "string",
"example": "helloworld-124-1731580109"
},
"description": {
"type": "string",
"example": "initial"
},
"parameters": {
"type": "string",
"example": ""
},
"pipeline_id": {
"type": "string",
"example": "824dccf7-edab-4b69-8f7a-6b77f726f74b"
},
"runs": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"default_version_id": {
"type": "string",
"example": "1c48f3a2-70cb-4deb-9b83-36678c2f507c"
},
"pipeline_type": {
"type": "string",
"example": "Argo"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:29.987561Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:31.355315Z"
},
"source": {
"type": "string",
"example": "pipeline"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-pipelines-pipeline-id",
"summary": "Delete Pipeline",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/{pipeline_id}/versions/": {
"get": {
"operationId": "get-pipelines-pipeline-id-versions",
"summary": "Version List",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_size",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response containing pipeline version details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1792
},
"name": {
"type": "string",
"example": "helloworld-124-1731580109"
},
"description": {
"type": "string",
"example": "initial"
},
"version_id": {
"type": "string",
"format": "uuid",
"example": "1c48f3a2-70cb-4deb-9b83-36678c2f507c"
},
"pipeline": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1556
},
"name": {
"type": "string",
"example": "helloworld-124-1731580109"
},
"description": {
"type": "string",
"example": "initial"
},
"parameters": {
"type": "string",
"example": ""
},
"pipeline_id": {
"type": "string",
"format": "uuid",
"example": "824dccf7-edab-4b69-8f7a-6b77f726f74b"
},
"runs": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"default_version_id": {
"type": "string",
"format": "uuid",
"example": "1c48f3a2-70cb-4deb-9b83-36678c2f507c"
},
"pipeline_type": {
"type": "string",
"example": "Argo"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:29.987561Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:31.355315Z"
},
"source": {
"type": "string",
"example": "pipeline"
}
}
},
"is_default_version": {
"type": "boolean",
"example": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:29.997596Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:31.345587Z"
},
"source": {
"type": "string",
"example": "pipeline"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/{pipeline_id}/versions/{version_id}/": {
"get": {
"operationId": "get-pipelines-pipeline-id-versions-version-id",
"summary": "Version Details",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful retrieval of pipeline version details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "object",
"properties": {
"pipeline_id": {
"type": "string",
"format": "uuid",
"example": "824dccf7-edab-4b69-8f7a-6b77f726f74b"
},
"pipeline_version_id": {
"type": "string",
"format": "uuid",
"example": "1c48f3a2-70cb-4deb-9b83-36678c2f507c"
},
"display_name": {
"type": "string",
"example": "helloworld-124-1731580109"
},
"description": {
"type": "string",
"example": "initial"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:28:29.997596Z"
},
"pipeline_spec": {
"type": "object"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-pipelines-pipeline-id-versions-version-id",
"summary": "Delete Version",
"tags": [
"Pipeline"
],
"parameters": [
{
"name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/experiments/": {
"get": {
"operationId": "get-pipelines-experiments",
"summary": "Experiment List",
"tags": [
"Run"
],
"parameters": [
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_size",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response containing experiment details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 843
},
"name": {
"type": "string",
"example": "experiment-11141628022"
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"experiment_id": {
"type": "string",
"format": "uuid",
"example": "26dab7fb-37c2-49fb-97ba-c91922bde1a1"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:04.228536Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:04.228604Z"
},
"source": {
"type": "string",
"example": "pipeline"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-pipelines-experiments",
"summary": "Create Experiment",
"tags": [
"Run"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the experiment"
},
"description": {
"type": "string",
"description": "Description of the experiment"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Experiment created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 843
},
"name": {
"type": "string",
"example": "experiment-11141628022"
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"experiment_id": {
"type": "string",
"format": "uuid",
"example": "26dab7fb-37c2-49fb-97ba-c91922bde1a1"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:04.228536Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:04.228604Z"
},
"source": {
"type": "string",
"example": "pipeline"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/experiments/{experiment_id}/": {
"get": {
"operationId": "get-pipelines-experiments-experiment-id",
"summary": "Experiment Details",
"tags": [
"Run"
],
"parameters": [
{
"name": "experiment_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful retrieval of experiment details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"experiment_id": {
"type": "string",
"format": "uuid",
"example": "26dab7fb-37c2-49fb-97ba-c91922bde1a1"
},
"display_name": {
"type": "string",
"example": "experiment-11141628022"
},
"description": {
"type": "string",
"example": ""
},
"namespace": {
"type": "string",
"example": "p-123"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:04.000000Z"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-pipelines-experiments-experiment-id",
"summary": "Delete Experiment",
"tags": [
"Run"
],
"parameters": [
{
"name": "experiment_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Experiment successfully deleted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Deleted Successfully"
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/runs/": {
"get": {
"operationId": "get-pipelines-runs",
"summary": "Run List",
"tags": [
"Run"
],
"parameters": [
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_size",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "pipeline_version_id",
"in": "query",
"required": false,
"description": "Filter runs by pipeline version ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response containing run details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2439
},
"name": {
"type": "string",
"example": "tir-run-111416275353"
},
"run_id": {
"type": "string",
"format": "uuid",
"example": "116bf10c-6d76-461a-98d2-7feb99fe7d29"
},
"state": {
"type": "string",
"example": "Pending"
},
"progress": {
"type": "string",
"example": ""
},
"finished_at": {
"type": "string",
"format": "date-time",
"example": "1970-01-01T00:00:00Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:23.918155Z"
},
"source": {
"type": "string",
"example": "pipeline"
},
"scheduled_job": {
"type": "string",
"nullable": true,
"example": null
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-pipelines-runs",
"summary": "Create Run",
"tags": [
"Run"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"experiment_id",
"pipeline_version_id",
"sku_item_price_id",
"sku_id"
],
"properties": {
"sku_id": {
"type": "integer",
"description": "SKU ID for the run. Get it from the **SKU List** API response."
},
"sku_item_price_id": {
"type": "integer",
"description": "Price ID for the SKU item. Get it from the **SKU List** API response."
},
"next_sku_item_price_id": {
"type": "integer",
"nullable": true,
"description": "ID for the next SKU item price, if any"
},
"committed_instance_policy": {
"type": "string",
"description": "Committed instance policy"
},
"name": {
"type": "string",
"description": "Name of the run"
},
"description": {
"type": "string",
"description": "Description of the run"
},
"experiment_id": {
"type": "string",
"format": "uuid",
"description": "ID of the associated experiment. Get it from the `experiment_id` field in the **Experiment List** API response."
},
"pipeline_type": {
"type": "string",
"enum": [
"existing",
"new"
],
"description": "Type of pipeline"
},
"pipeline_version_id": {
"type": "string",
"format": "uuid",
"description": "Version ID of the pipeline. Get it from the `version_id` field in the **Version List** API response."
},
"run_parameter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"description": "Runtime parameters for the pipeline run"
},
"run_type": {
"type": "string",
"enum": [
"run",
"scheduled_job"
],
"description": "Type of run"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful response containing run details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2439
},
"name": {
"type": "string",
"example": "tir-run-111416275353"
},
"run_id": {
"type": "string",
"format": "uuid",
"example": "116bf10c-6d76-461a-98d2-7feb99fe7d29"
},
"state": {
"type": "string",
"example": "Pending"
},
"progress": {
"type": "string",
"example": ""
},
"finished_at": {
"type": "string",
"format": "date-time",
"example": "1970-01-01T00:00:00Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:23.918155Z"
},
"source": {
"type": "string",
"example": "pipeline"
},
"scheduled_job": {
"type": "string",
"nullable": true,
"example": null
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/runs/{run_id}/": {
"get": {
"operationId": "get-pipelines-runs-run-id",
"summary": "Run Details",
"tags": [
"Run"
],
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful retrieval of run details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"run": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"example": "116bf10c-6d76-461a-98d2-7feb99fe7d29"
},
"name": {
"type": "string",
"example": "tir-run-111416275353"
},
"description": {
"type": "string",
"example": ""
},
"status": {
"type": "string",
"example": "Succeeded"
},
"scheduled_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T10:58:23.000000Z"
},
"finished_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T11:02:10.000000Z"
},
"pipeline_spec": {
"type": "object"
}
}
},
"pipeline_runtime": {
"type": "object",
"properties": {
"workflow_manifest": {
"type": "string"
}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-pipelines-runs-run-id",
"summary": "Run Action (Terminate/Retry)",
"tags": [
"Run"
],
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"terminate",
"retry"
]
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Run action performed successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-pipelines-runs-run-id",
"summary": "Delete Run",
"tags": [
"Run"
],
"parameters": [
{
"name": "run_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Resource successfully deleted",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "string",
"description": "Confirmation message for successful deletion.",
"example": "Deleted Successfully"
},
"errors": {
"type": "object",
"description": "Error details (empty if none).",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"description": "General response message.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/jobs/": {
"get": {
"operationId": "get-pipelines-jobs",
"summary": "Schedule Run List",
"tags": [
"Schedule Run"
],
"parameters": [
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_size",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "pipeline_version_id",
"in": "query",
"required": false,
"description": "Filter scheduled runs by pipeline version ID",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "A list of scheduled jobs.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the scheduled job.",
"example": 30
},
"name": {
"type": "string",
"description": "The name of the scheduled job.",
"example": "tir-run-111417044747"
},
"job_id": {
"type": "string",
"description": "Unique identifier for the job.",
"example": "e05346aa-97ce-41d0-962f-f9087c86c5f6"
},
"is_enabled": {
"type": "boolean",
"description": "Indicates whether the job is enabled.",
"example": true
},
"experiment_id": {
"type": "string",
"description": "ID of the associated experiment.",
"example": "843"
},
"pipeline_version_id": {
"type": "string",
"description": "ID of the pipeline version.",
"example": "1792"
},
"max_concurrency": {
"type": "integer",
"description": "The maximum number of concurrent runs allowed.",
"example": 1
},
"trigger": {
"type": "object",
"properties": {
"periodic_schedule": {
"type": "object",
"properties": {
"end_time": {
"type": "string",
"format": "date-time",
"description": "The end time for the schedule.",
"example": "2024-11-15T18:25:47Z"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "The start time for the schedule.",
"example": "2024-11-14T18:25:47Z"
},
"interval_second": {
"type": "integer",
"description": "Interval in seconds for periodic execution.",
"example": 86400
}
}
}
}
},
"source": {
"type": "string",
"description": "The source of the job.",
"example": "pipeline"
}
}
}
},
"errors": {
"type": "object",
"description": "Error details (empty if none).",
"additionalProperties": false
},
"message": {
"type": "string",
"description": "General response message.",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-pipelines-jobs",
"summary": "Create Schedule Run",
"tags": [
"Schedule Run"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"experiment_id",
"pipeline_version_id",
"sku_item_price_id",
"sku_id",
"periodic_schedule"
],
"properties": {
"sku_id": {
"type": "integer",
"description": "SKU ID for the run. Get it from the **SKU List** API response."
},
"sku_item_price_id": {
"type": "integer",
"description": "Price ID for the SKU item. Get it from the **SKU List** API response."
},
"next_sku_item_price_id": {
"type": "integer",
"nullable": true,
"description": "ID for the next SKU item price, if any"
},
"committed_instance_policy": {
"type": "string",
"description": "Committed instance policy"
},
"name": {
"type": "string",
"description": "Name of the scheduled run"
},
"description": {
"type": "string",
"description": "Description of the scheduled run"
},
"experiment_id": {
"type": "string",
"format": "uuid",
"description": "ID of the associated experiment. Get it from the `experiment_id` field in the **Experiment List** API response."
},
"pipeline_version_id": {
"type": "string",
"format": "uuid",
"description": "Version ID of the pipeline. Get it from the `version_id` field in the **Version List** API response."
},
"max_concurrency": {
"type": "integer",
"description": "Maximum number of concurrent runs allowed. Defaults to 1 if not provided. Do not include this field in the request body.",
"default": 1
},
"run_parameter": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"description": "Runtime parameters for the pipeline run"
},
"run_type": {
"type": "string",
"enum": [
"scheduled_job"
],
"description": "Type of run"
},
"periodic_schedule": {
"type": "object",
"required": [
"interval_second"
],
"properties": {
"interval_second": {
"type": "integer",
"description": "Interval in seconds between runs (e.g. 86400 for daily)"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Start time for the schedule in UTC (e.g. 2024-11-14T18:25:47Z)"
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "End time for the schedule in UTC. Leave empty for no end time."
}
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Scheduled run created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the scheduled job.",
"example": 30
},
"name": {
"type": "string",
"description": "The name of the scheduled job.",
"example": "tir-scheduled-run-example"
},
"job_id": {
"type": "string",
"description": "Unique identifier for the job.",
"example": "e05346aa-97ce-41d0-962f-f9087c86c5f6"
},
"is_enabled": {
"type": "boolean",
"description": "Indicates whether the job is enabled.",
"example": true
},
"experiment_id": {
"type": "string",
"description": "ID of the associated experiment.",
"example": "843"
},
"pipeline_version_id": {
"type": "string",
"description": "ID of the pipeline version.",
"example": "1792"
},
"max_concurrency": {
"type": "integer",
"description": "The maximum number of concurrent runs allowed.",
"example": 1
},
"trigger": {
"type": "object",
"properties": {
"periodic_schedule": {
"type": "object",
"properties": {
"end_time": {
"type": "string",
"format": "date-time",
"example": "2024-11-15T18:25:47Z"
},
"start_time": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T18:25:47Z"
},
"interval_second": {
"type": "integer",
"example": 86400
}
}
}
}
},
"source": {
"type": "string",
"example": "pipeline"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/pipelines/jobs/{job_id}/": {
"put": {
"operationId": "put-pipelines-jobs-job-id",
"summary": "Enable/Disable Schedule Run",
"tags": [
"Schedule Run"
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"description": "Scheduled job ID. Get it from the `job_id` field in the **Schedule Run List** API response.",
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"disable",
"enable"
]
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Success response with no data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "object",
"description": "The data object, which is empty in this case."
},
"errors": {
"type": "object",
"description": "Error details, which are empty in this case."
},
"message": {
"type": "string",
"description": "General response message.",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-pipelines-jobs-job-id",
"summary": "Delete Scheduled Run",
"tags": [
"Schedule Run"
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"description": "Scheduled job ID. Get it from the `job_id` field in the **Schedule Run List** API response.",
"schema": {
"type": "string"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Success response with no data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "HTTP status code for the operation.",
"example": 200
},
"data": {
"type": "object",
"description": "The data object, which is empty in this case."
},
"errors": {
"type": "object",
"description": "Error details, which are empty in this case."
},
"message": {
"type": "string",
"description": "General response message.",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/users/iam-accounts/": {
"get": {
"operationId": "get-users-iam-accounts",
"summary": "IAM Users",
"tags": [
"IAM Users"
],
"responses": {
"200": {
"description": "Successful response with user details and roles. The `id` field in each item is the **active_iam** value that should be passed as the `active_iam` query parameter in other TIR API calls.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The active IAM ID. Use this value as the `active_iam` query parameter in other API calls.",
"example": 2421
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"phone": {
"type": "string",
"nullable": true,
"example": null
},
"is_primary_contact": {
"type": "boolean",
"example": true
},
"primary_email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"currency": {
"type": "string",
"example": "INR"
},
"is_suspended": {
"type": "boolean",
"example": true
}
}
},
"role": {
"type": "string",
"example": "Owner"
},
"has_ai_labs_access": {
"type": "boolean",
"description": "Whether this IAM account has access to AI Labs.",
"example": true
},
"has_tir_access": {
"type": "boolean",
"description": "Whether this IAM account has access to TIR.",
"example": true
}
}
}
}
}
}
}
}
}
}
}
},
"/gpu/plans-and-pricing/list/": {
"get": {
"operationId": "get-gpu-plans-and-pricing-list",
"summary": "TIR – Plans & Pricing",
"tags": [
"Plans & Pricing"
],
"description": "Returns plans and pricing for TIR services.",
"parameters": [
{
"name": "service",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"notebook",
"rag",
"dataset",
"inference_service",
"pipeline",
"model_playground",
"vector_db",
"private_cloud",
"distributed_job",
"pfs",
"reserve_ip",
"ai_labs",
"container_registry"
]
}
},
{
"name": "location",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "currency",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"INR",
"USD"
]
}
}
],
"responses": {
"default": {
"description": "Successful response"
}
}
}
},
"/gpu_service/sku/": {
"get": {
"operationId": "get-gpu-service-sku",
"summary": "SKU List",
"tags": [
"SKU"
],
"description": "Returns available hardware plans (SKUs). Use `sku_item_price_id` from the response when creating an Instance or Virtual Machine.",
"parameters": [
{
"name": "service",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"notebook",
"vector_db",
"pipeline",
"inference_service",
"private_cloud"
]
}
},
{
"name": "image_version_id",
"in": "query",
"required": false,
"description": "Required for Notebook service. [**Find your Image Version ID here**](/paths/gpu_service-image/get)",
"schema": {
"type": "integer"
}
},
{
"name": "framework",
"in": "query",
"required": false,
"description": "Required for Inference",
"schema": {
"type": "string",
"enum": [
"vllm",
"sglang",
"dynamo",
"pytorch",
"triton",
"custom",
"llma",
"codellama",
"mistral-7b-instruct",
"mixtral-8x7b-instruct",
"gemma-2b-it",
"llama-3-8b-instruct",
"Phi-3-mini-128k-instruct",
"llama-3_1-8b-instruct",
"llama-3_2-3b-instruct",
"llama-3_2-11b-vision-instruct",
"stable_diffusion",
"bge-large-en-v1_5",
"bge-reranker-large",
"stable_diffusion_xl",
"yolov8",
"nemo-rag",
"stable-video-diffusion-img2vid-xt",
"nemotron-3-8b-chat-4k-rlhf",
"nvidia-nv-embed-v1",
"tensorrt",
"riva",
"nemotron-3-nano-30b-a3b",
"nemotron-nano-12b-v2-vl",
"nemotron-speech-streaming-en-0.6b",
"qwen3-235b-a22b-instruct-2507-fp8"
]
}
},
{
"name": "framework_version_id",
"in": "query",
"required": false,
"description": "Required for Inference service. [**Find your Framework Version ID here**](/operations/get-framework-details)",
"schema": {
"type": "integer"
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successful response with available plans",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"CPU": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 35
},
"name": {
"type": "string",
"example": "C3.8GB_Free"
},
"series": {
"type": "string",
"example": "CPU"
},
"cpu": {
"type": "string",
"example": "4"
},
"gpu": {
"type": "string",
"nullable": true,
"example": null
},
"memory": {
"type": "string",
"example": "8GB"
},
"sku_type": {
"type": "string",
"example": "C3-250GB"
},
"is_free": {
"type": "boolean",
"example": true
},
"is_active": {
"type": "boolean",
"example": true
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 86
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 0
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": "Free-Tier Plan"
}
}
}
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"gpu_card_type": {
"type": "string",
"nullable": true,
"example": null
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"available_inventory_count": {
"type": "integer",
"example": 102
},
"is_inventory_available": {
"type": "boolean",
"example": true
}
}
}
},
"GPU": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 76
},
"name": {
"type": "string",
"example": "GDC.A100-16.115GB_Free"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "string",
"example": "16"
},
"gpu": {
"type": "string",
"example": "1"
},
"memory": {
"type": "string",
"example": "115GB"
},
"sku_type": {
"type": "string",
"example": "GDC.A10040"
},
"is_free": {
"type": "boolean",
"example": true
},
"is_active": {
"type": "boolean",
"example": true
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 193
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 0
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"nullable": true,
"example": "Free-Tier Plan"
}
}
}
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"gpu_card_type": {
"type": "string",
"example": "A100"
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"available_inventory_count": {
"type": "integer",
"example": 0
},
"is_inventory_available": {
"type": "boolean",
"example": false
}
}
}
},
"SPOT_INSTANCE": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 180
},
"name": {
"type": "string",
"example": "Spot_GDC.1xH10080-26.250GB_SXM"
},
"series": {
"type": "string",
"example": "SPOT_INSTANCE"
},
"cpu": {
"type": "string",
"example": "26"
},
"gpu": {
"type": "string",
"example": "1"
},
"memory": {
"type": "string",
"example": "250GB"
},
"sku_type": {
"type": "string",
"example": "SPOT-GDC-4xH10080"
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 987
},
"sku_type": {
"type": "string",
"example": "hourly"
},
"committed_days": {
"type": "integer",
"example": 0
},
"unit_price": {
"type": "number",
"format": "float",
"example": 175
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Hourly Compute Instance notebook"
}
}
}
},
"gpu_switch_type": {
"type": "string",
"nullable": true,
"example": null
},
"gpu_card_type": {
"type": "string",
"example": "H100"
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"available_inventory_count": {
"type": "integer",
"example": 4
},
"is_inventory_available": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
}
}
}
}
}
}
},
"/data_syncer/source-connectors/": {
"get": {
"operationId": "get-data-syncer-source-connectors",
"summary": "List Source Types",
"tags": [
"Data Syncer"
],
"description": "Please select Service as **data_syncer**",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "service",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"notebook",
"vector_db",
"pipeline",
"inference_service",
"private_cloud"
]
}
}
],
"responses": {
"200": {
"description": "A list of source connectors",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"source_type": {
"type": "string",
"example": "minio"
},
"name": {
"type": "string",
"example": "MinIO"
},
"icon_url": {
"type": "string",
"example": "/data-syncer-images/minio.png"
},
"description": {
"type": "string",
"example": "MinIO is an open source object storage system."
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/data_syncer/source/": {
"get": {
"operationId": "get-data-syncer-source",
"summary": "List Sources",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved syncer sources",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the syncer source.",
"example": 214
},
"name": {
"type": "string",
"description": "Name of the syncer source.",
"example": "syncer-source-021917393333"
},
"status": {
"type": "string",
"description": "Status of the syncer source.",
"example": "active"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Start date of the syncer source.",
"example": null
},
"file_search_filter": {
"type": "array",
"items": {
"type": "string"
},
"description": "File search filter settings.",
"example": []
},
"file_size_upper_limit": {
"type": "integer",
"description": "Upper limit of file size.",
"example": 0
},
"file_size_lower_limit": {
"type": "integer",
"description": "Lower limit of file size.",
"example": 0
},
"path_array": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of file paths.",
"example": []
},
"regex_pattern": {
"type": "string",
"nullable": true,
"description": "Regular expression pattern for file filtering.",
"example": null
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the creator.",
"example": 4945
},
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator.",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of creation.",
"example": "2025-02-19T12:12:47.457714Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of last update.",
"example": "2025-02-19T12:12:47.549457Z"
},
"source_type": {
"type": "string",
"description": "Type of the source.",
"example": "minio"
},
"source_connector": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the source connector.",
"example": 1
},
"source_type": {
"type": "string",
"description": "Type of the source connector.",
"example": "minio"
},
"name": {
"type": "string",
"description": "Name of the source connector.",
"example": "MinIO"
},
"icon_url": {
"type": "string",
"description": "URL of the icon for the source connector.",
"example": "/data-syncer-images/minio.png"
},
"description": {
"type": "string",
"description": "Description of the source connector.",
"example": "MinIO is an open source object storage system."
}
}
},
"configuration": {
"type": "object",
"properties": {
"bucket_name": {
"type": "string",
"description": "Name of the storage bucket.",
"example": "test-r1"
},
"endpoint_url": {
"type": "string",
"description": "Endpoint URL of the object storage.",
"example": "objectstore.e2enetworks.net"
},
"access_key": {
"type": "string",
"description": "Access key for authentication.",
"example": "OYG8DNWGXK6TOQ2GX1PM"
},
"prefix": {
"type": "string",
"description": "Prefix path within the bucket.",
"example": "/"
}
}
}
}
}
},
"errors": {
"type": "object",
"description": "Contains error details if any.",
"example": {}
},
"message": {
"type": "string",
"description": "Response message.",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"description": "Total number of pages available.",
"example": 1
},
"total_count": {
"type": "integer",
"description": "Total number of syncer sources available.",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-data-syncer-source",
"summary": "Create Source",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the syncer source.",
"example": "syncer-source-021917393333"
},
"source_connector_id": {
"type": "integer",
"description": "ID of the source connector.",
"example": 1
},
"config": {
"type": "object",
"properties": {
"endpoint_url": {
"type": "string",
"description": "Endpoint URL of the object storage.",
"example": "objectstore.e2enetworks.net"
},
"bucket_name": {
"type": "string",
"description": "Name of the storage bucket.",
"example": "test-r1"
},
"prefix": {
"type": "string",
"description": "Prefix path within the bucket.",
"example": "/"
},
"access_key": {
"type": "string",
"description": "Access key for authentication.",
"example": "OYG8DNWGXK6TOQ2GX1PM"
},
"secret_key": {
"type": "string",
"description": "Secret key for authentication.",
"example": "4938ORM9U5KL046CNHSJGYH4X6YZ6OL114GRY0AN"
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Successfully created a syncer source",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Unique identifier of the syncer source.",
"example": 215
},
"name": {
"type": "string",
"description": "Name of the syncer source.",
"example": "syncer-source-021917393333"
},
"status": {
"type": "string",
"description": "Status of the syncer source.",
"example": "active"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Start date of the syncer source.",
"example": null
},
"file_search_filter": {
"type": "array",
"items": {
"type": "string"
},
"description": "File search filter settings.",
"example": []
},
"file_size_upper_limit": {
"type": "integer",
"description": "Upper limit of file size.",
"example": 0
},
"file_size_lower_limit": {
"type": "integer",
"description": "Lower limit of file size.",
"example": 0
},
"path_array": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of file paths.",
"example": []
},
"regex_pattern": {
"type": "string",
"nullable": true,
"description": "Regular expression pattern for file filtering.",
"example": null
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the creator.",
"example": 4945
},
"name": {
"type": "string",
"description": "Name of the creator.",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"description": "Email of the creator.",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"description": "Username of the creator.",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of creation.",
"example": "2025-02-19T12:12:53.612072Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp of last update.",
"example": "2025-02-19T12:12:53.711002Z"
},
"source_type": {
"type": "string",
"description": "Type of the source.",
"example": "minio"
},
"source_connector": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the source connector.",
"example": 1
},
"source_type": {
"type": "string",
"description": "Type of the source connector.",
"example": "minio"
},
"name": {
"type": "string",
"description": "Name of the source connector.",
"example": "MinIO"
},
"icon_url": {
"type": "string",
"description": "URL of the icon for the source connector.",
"example": "/data-syncer-images/minio.png"
},
"description": {
"type": "string",
"description": "Description of the source connector.",
"example": "MinIO is an open source object storage system."
}
}
},
"configuration": {
"type": "object",
"properties": {
"bucket_name": {
"type": "string",
"description": "Name of the storage bucket.",
"example": "test-r1"
},
"endpoint_url": {
"type": "string",
"description": "Endpoint URL of the object storage.",
"example": "objectstore.e2enetworks.net"
},
"access_key": {
"type": "string",
"description": "Access key for authentication.",
"example": "OYG8DNWGXK6TOQ2GX1PM"
},
"prefix": {
"type": "string",
"description": "Prefix path within the bucket.",
"example": "/"
}
}
}
}
},
"errors": {
"type": "object",
"description": "Contains error details if any.",
"example": {}
},
"message": {
"type": "string",
"description": "Response message.",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/data_syncer/source/{Source_Id}/": {
"put": {
"operationId": "put-data-syncer-source-source-id",
"summary": "Update Source",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Source_Id",
"in": "path",
"required": true,
"description": "Source Id",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "syncer-source-0219173"
},
"config": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"example": "/"
},
"bucket_name": {
"type": "string",
"example": "test-r1"
},
"endpoint_url": {
"type": "string",
"example": "objectstore.e2enetworks.net"
},
"access_key": {
"type": "string",
"example": "00TFJ4YSVEX9B9P1UTJU"
},
"secret_key": {
"type": "string",
"example": "FJCGMBRYONT76TLRD2QHCTICIHSZIY9G21RB28H5"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful response with source details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 214
},
"name": {
"type": "string",
"example": "syncer-source-0219173"
},
"status": {
"type": "string",
"example": "active"
},
"start_date": {
"type": "string",
"nullable": true,
"example": null
},
"file_search_filter": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"file_size_upper_limit": {
"type": "integer",
"example": 0
},
"file_size_lower_limit": {
"type": "integer",
"example": 0
},
"path_array": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"regex_pattern": {
"type": "string",
"nullable": true,
"example": null
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-19T12:12:47.457714Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T05:22:53.505091Z"
},
"source_type": {
"type": "string",
"example": "minio"
},
"source_connector": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"source_type": {
"type": "string",
"example": "minio"
},
"name": {
"type": "string",
"example": "MinIO"
},
"icon_url": {
"type": "string",
"example": "/data-syncer-images/minio.png"
},
"description": {
"type": "string",
"example": "MinIO is an open source object storage system."
}
}
},
"configuration": {
"type": "object",
"properties": {
"bucket_name": {
"type": "string",
"example": "test-r1"
},
"endpoint_url": {
"type": "string",
"example": "objectstore.e2enetworks.net"
},
"access_key": {
"type": "string",
"example": "00TFJ4YSVEX9B9P1UTJU"
},
"secret_key": {
"type": "string",
"example": "FJCGMBRYONT76TLRD2QHCTICIHSZIY9G21RB28H5"
},
"prefix": {
"type": "string",
"example": "/"
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-data-syncer-source-source-id",
"summary": "Delete Source",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Source_Id",
"in": "path",
"required": true,
"description": "Source Id",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Source deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Source deleted successfully"
}
}
}
}
}
}
}
}
},
"/data_syncer/destination/": {
"get": {
"operationId": "get-data-syncer-destination",
"summary": "List Destinations",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Success response with a list of destinations",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 146
},
"name": {
"type": "string",
"example": "syncer-destination-02201439044"
},
"destination_type": {
"type": "string",
"example": "tir_dataset"
},
"status": {
"type": "string",
"example": "active"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1637
},
"name": {
"type": "string",
"example": "finetuning-dataset-022013562626"
},
"project_id": {
"type": "integer",
"example": 4601
},
"storage_type": {
"type": "string",
"example": "managed"
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3162
},
"bucket_name": {
"type": "string",
"example": "d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 11604
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3179
},
"access_key": {
"type": "string",
"example": "2092TCITD7JA6IICP299"
},
"tag": {
"type": "string",
"example": "akgpuf8fd86dec56147a8aefb896fef535f03"
},
"is_managed": {
"type": "boolean",
"example": true
}
}
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "OK"
}
}
},
"path_prefix": {
"type": "string",
"example": "/"
},
"run": {
"type": "boolean",
"example": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:14:23.278364Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:14:36.960772Z"
}
}
}
},
"errors": {
"type": "object",
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-data-syncer-destination",
"summary": "Create Destination",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the syncer destination",
"example": "syncer-destination-02201439044"
},
"path_prefix": {
"type": "string",
"description": "Path prefix for the destination",
"example": "/"
},
"dataset_id": {
"type": "integer",
"description": "ID of the dataset to sync to",
"example": 1637
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Destination created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 134
},
"name": {
"type": "string",
"example": "syncer-destination-022012431919"
},
"destination_type": {
"type": "string",
"example": "tir_dataset"
},
"status": {
"type": "string",
"example": "active"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"format": "email",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1636
},
"name": {
"type": "string",
"example": "syncer-destination-022012432323"
},
"project_id": {
"type": "integer",
"example": 4601
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true,
"example": null
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3161
},
"bucket_name": {
"type": "string",
"example": "d-gpu-05a1d225-3340-4383-87ec-c06412ea13a2"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-05a1d225-3340-4383-87ec-c06412ea13a2/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 11602
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3178
},
"access_key": {
"type": "string",
"example": "4RJUR0C58XCVTAZZCFPT"
},
"secret_key": {
"type": "string",
"nullable": true,
"example": null
},
"tag": {
"type": "string",
"example": "akgpu16b8b19cb1864c5ab0f22260338487b5"
},
"is_managed": {
"type": "boolean",
"example": true
}
}
},
"encryption_type": {
"type": "string",
"nullable": true,
"example": null
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "Pending"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"format": "email",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T07:13:27.788331Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T07:13:27.788397Z"
}
}
},
"knowledge_base": {
"type": "string",
"nullable": true,
"example": null
},
"path_prefix": {
"type": "string",
"example": "/"
},
"run": {
"type": "boolean",
"example": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T07:13:43.911473Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T07:14:00.648954Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/data_syncer/destination/{Destination_Id}/": {
"put": {
"operationId": "put-data-syncer-destination-destination-id",
"summary": "Update Destination",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Destination_Id",
"in": "path",
"required": true,
"description": "Destination Id",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the syncer destination",
"example": "syncer-destination-0220"
},
"path_prefix": {
"type": "string",
"description": "Path prefix for the destination",
"example": "/new"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully retrieved syncer destination details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 140
},
"name": {
"type": "string",
"example": "syncer-destination-0220"
},
"destination_type": {
"type": "string",
"example": "tir_dataset"
},
"status": {
"type": "string",
"example": "active"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1637
},
"name": {
"type": "string",
"example": "finetuning-dataset-022013562626"
},
"project_id": {
"type": "integer",
"example": 4601
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true,
"example": null
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3162
},
"bucket_name": {
"type": "string",
"example": "d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 11604
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3179
},
"access_key": {
"type": "string",
"example": "2092TCITD7JA6IICP299"
},
"secret_key": {
"type": "string",
"nullable": true,
"example": null
},
"tag": {
"type": "string",
"example": "akgpuf8fd86dec56147a8aefb896fef535f03"
},
"is_managed": {
"type": "boolean",
"example": true
}
}
},
"encryption_type": {
"type": "string",
"nullable": true,
"example": null
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "OK"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T08:26:31.126205Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T08:26:31.126281Z"
}
}
},
"knowledge_base": {
"type": "string",
"nullable": true,
"example": null
},
"path_prefix": {
"type": "string",
"example": "/new"
},
"run": {
"type": "boolean",
"example": true
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T09:16:13.799623Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T09:44:08.419033Z"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-data-syncer-destination-destination-id",
"summary": "Delete Destination",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Destination_Id",
"in": "path",
"required": true,
"description": "Destination Id",
"schema": {
"type": "integer"
}
}
],
"responses": {
"default": {
"description": "Response"
}
}
}
},
"/data_syncer/connection/": {
"get": {
"operationId": "get-data-syncer-connection",
"summary": "Get Connections",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "List of sync connections retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 171
},
"name": {
"type": "string",
"example": "syncer-connection-022015573333"
},
"schedule_type": {
"type": "string",
"example": "basic"
},
"frequency": {
"type": "string",
"example": "6"
},
"status": {
"type": "string",
"example": "inactive"
},
"sync_mode": {
"type": "string",
"example": "incremental_append"
},
"last_sync": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T11:23:02Z"
},
"latest_sync_status": {
"type": "string",
"example": "succeeded"
},
"next_sync": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:40:01.225117Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T11:39:38.140680Z"
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 222
},
"name": {
"type": "string",
"example": "syncer-source-021917393333"
},
"status": {
"type": "string",
"example": "active"
},
"source_type": {
"type": "string",
"example": "minio"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:26:21.507678Z"
},
"configuration": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"example": "/"
},
"access_key": {
"type": "string",
"example": "OYG8DNWGXK6TOQ2GX1PM"
},
"bucket_name": {
"type": "string",
"example": "test-r1"
},
"endpoint_url": {
"type": "string",
"example": "objectstore.e2enetworks.net"
}
}
}
}
},
"destination": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 147
},
"name": {
"type": "string",
"example": "syncer-destination-02201439044"
},
"destination_type": {
"type": "string",
"example": "tir_dataset"
},
"status": {
"type": "string",
"example": "active"
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1637
},
"name": {
"type": "string",
"example": "finetuning-dataset-022013562626"
},
"project_id": {
"type": "integer",
"example": 4601
},
"storage_type": {
"type": "string",
"example": "managed"
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3162
},
"bucket_name": {
"type": "string",
"example": "d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
}
}
}
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-data-syncer-connection",
"summary": "Create Connection",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "syncer-connection-022015573333"
},
"sync_mode": {
"type": "string",
"enum": [
"incremental_append",
"full_refresh"
],
"example": "incremental_append"
},
"schedule": {
"type": "object",
"properties": {
"schedule_type": {
"type": "string",
"enum": [
"basic",
"advanced"
],
"example": "basic"
},
"basic_schedule": {
"type": "integer",
"description": "Schedule interval in hours",
"example": 6
}
}
},
"source_id": {
"type": "integer",
"description": "ID of the source data",
"example": 222
},
"destination_id": {
"type": "integer",
"description": "ID of the destination data",
"example": 147
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "Response"
}
}
}
},
"/data_syncer/connection/{Connection_Id}/jobs/": {
"get": {
"operationId": "get-data-syncer-connection-connection-id-jobs",
"summary": "Get Connection Sync Jobs",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Connection_Id",
"in": "path",
"required": true,
"description": "Connection Id",
"schema": {
"type": "integer"
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "A list of failed jobs",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 2
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 193
},
"status": {
"type": "string",
"example": "failed"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-21T05:24:24Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-21T05:24:47Z"
},
"streamAggregatedStats": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-data-syncer-connection-connection-id-jobs",
"summary": "Start Connection Sync",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Connection_Id",
"in": "path",
"required": true,
"description": "Connection Id",
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"jobType": {
"type": "string",
"example": "sync"
}
},
"required": [
"jobType"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Sync job created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 184
},
"status": {
"type": "string",
"example": "running"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T11:02:15Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T11:02:15Z"
},
"streamAggregatedStats": {
"type": "array",
"items": {
"type": "object"
},
"example": []
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/data_syncer/connection/{Connection_Id}/": {
"put": {
"operationId": "put-data-syncer-connection-connection-id",
"summary": "Actions on Connection",
"tags": [
"Data Syncer"
],
"description": "Kindly choose request example **update** for action type update and **enable_disable** for action type enable and disable.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Connection_Id",
"in": "path",
"required": true,
"description": "Connection Id",
"schema": {
"type": "integer"
}
},
{
"name": "action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"enable",
"disable",
"update"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "syncer-connection-02201557"
},
"sync_mode": {
"type": "string",
"example": "incremental_append"
},
"schedule": {
"type": "object",
"properties": {
"schedule_type": {
"type": "string",
"example": "manual"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Sync connection details retrieved successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 171
},
"name": {
"type": "string",
"example": "syncer-connection-022015573333"
},
"schedule_type": {
"type": "string",
"example": "basic"
},
"frequency": {
"type": "string",
"example": "6"
},
"status": {
"type": "string",
"example": "inactive"
},
"sync_mode": {
"type": "string",
"example": "incremental_append"
},
"last_sync": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:46:05Z"
},
"latest_sync_status": {
"type": "string",
"example": "succeeded"
},
"next_sync": {
"type": "string",
"example": ""
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:40:01.225117Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T11:24:42.752261Z"
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 222
},
"name": {
"type": "string",
"example": "syncer-source-021917393333"
},
"status": {
"type": "string",
"example": "active"
},
"source_type": {
"type": "string",
"example": "minio"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-02-20T10:26:21.507678Z"
},
"configuration": {
"type": "object",
"properties": {
"prefix": {
"type": "string",
"example": "/"
},
"access_key": {
"type": "string",
"example": "OYG8DNWGXK6TOQ2GX1PM"
},
"bucket_name": {
"type": "string",
"example": "test-r1"
},
"endpoint_url": {
"type": "string",
"example": "objectstore.e2enetworks.net"
}
}
}
}
},
"destination": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 147
},
"name": {
"type": "string",
"example": "syncer-destination-02201439044"
},
"destination_type": {
"type": "string",
"example": "tir_dataset"
},
"status": {
"type": "string",
"example": "active"
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1637
},
"name": {
"type": "string",
"example": "finetuning-dataset-022013562626"
},
"project_id": {
"type": "integer",
"example": 4601
},
"storage_type": {
"type": "string",
"example": "managed"
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3162
},
"bucket_name": {
"type": "string",
"example": "d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-bd21fad1-abcb-45fd-bc11-46142b7c7928/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
}
}
}
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4945
},
"name": {
"type": "string",
"example": "Rahul Tanwar"
},
"email": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
},
"username": {
"type": "string",
"example": "rahul.tanwar@e2enetworks.com"
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-data-syncer-connection-connection-id",
"summary": "Delete Connection",
"tags": [
"Data Syncer"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Connection_Id",
"in": "path",
"required": true,
"description": "Connection Id",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "connection deleted successfully"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/": {
"get": {
"operationId": "get-ai-labs-organization",
"summary": "List Organizations",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved organization list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 38
},
"name": {
"type": "string",
"example": "demo_course"
},
"description": {
"type": "string",
"example": "This is demo organization"
},
"project": {
"type": "object",
"properties": {
"team_id": {
"type": "integer"
},
"project_id": {
"type": "integer"
},
"project_name": {
"type": "string"
},
"team_name": {
"type": "string"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"series": {
"type": "string"
},
"cpu": {
"type": "integer"
},
"gpu": {
"type": "integer"
},
"memory": {
"type": "integer"
},
"ephemeral_storage": {
"type": "integer"
},
"gpu_memory": {
"type": "integer"
},
"is_free": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"gpu_switch_type": {
"type": "string",
"nullable": true
},
"local_storage_in_gb": {
"type": "integer"
},
"sku_type": {
"type": "string"
},
"gpu_card_type": {
"type": "string"
},
"category": {
"type": "string"
},
"variant": {
"type": "string"
},
"no_of_nodes": {
"type": "integer"
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer"
},
"sku_type": {
"type": "string"
},
"committed_days": {
"type": "integer"
},
"unit_price": {
"type": "number"
},
"currency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
}
}
}
}
},
"organization_nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"node_name": {
"type": "string"
},
"node_alias_name": {
"type": "string"
}
}
}
},
"members_count": {
"type": "integer"
},
"max_students": {
"type": "integer"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"resource_count": {
"type": "integer"
},
"iam_info": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"added_user": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"role": {
"type": "string"
},
"iam_type": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"is_student": {
"type": "boolean"
}
}
},
"invited_count": {
"type": "integer"
},
"ai_lab_plan": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"no_of_students": {
"type": "integer"
},
"is_active": {
"type": "boolean"
},
"no_of_nodes": {
"type": "integer"
}
}
},
"committed_info": {
"type": "object",
"nullable": true
},
"status": {
"type": "string"
},
"course_count": {
"type": "integer"
},
"location": {
"type": "string"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-ai-labs-organization",
"summary": "Create Organization",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"sku_item_price_id"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the organization"
},
"description": {
"type": "string",
"description": "Description of the organization"
},
"sku_item_price_id": {
"type": "integer",
"description": "Current SKU item price ID"
}
},
"example": {
"name": "Demo_Organization",
"description": "This is a demo organization",
"sku_item_price_id": 3807
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully created organization",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 38
},
"name": {
"type": "string",
"example": "demo_course"
},
"description": {
"type": "string",
"example": "This is demo organization"
},
"project": {
"type": "object",
"properties": {
"team_id": {
"type": "integer"
},
"project_id": {
"type": "integer"
},
"project_name": {
"type": "string"
},
"team_name": {
"type": "string"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"series": {
"type": "string"
},
"cpu": {
"type": "integer"
},
"gpu": {
"type": "integer"
},
"memory": {
"type": "integer"
},
"ephemeral_storage": {
"type": "integer"
},
"gpu_memory": {
"type": "integer"
},
"is_free": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"gpu_switch_type": {
"type": "string",
"nullable": true
},
"local_storage_in_gb": {
"type": "integer"
},
"sku_type": {
"type": "string"
},
"gpu_card_type": {
"type": "string"
},
"category": {
"type": "string"
},
"variant": {
"type": "string"
},
"no_of_nodes": {
"type": "integer"
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer"
},
"sku_type": {
"type": "string"
},
"committed_days": {
"type": "integer"
},
"unit_price": {
"type": "number"
},
"currency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
}
}
}
}
},
"organization_nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"node_name": {
"type": "string"
},
"node_alias_name": {
"type": "string"
}
}
}
},
"members_count": {
"type": "integer"
},
"max_students": {
"type": "integer"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"resource_count": {
"type": "integer"
},
"iam_info": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"added_user": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"role": {
"type": "string"
},
"iam_type": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"is_student": {
"type": "boolean"
}
}
},
"invited_count": {
"type": "integer"
},
"ai_lab_plan": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"no_of_students": {
"type": "integer"
},
"is_active": {
"type": "boolean"
},
"no_of_nodes": {
"type": "integer"
}
}
},
"committed_info": {
"type": "object",
"nullable": true
},
"status": {
"type": "string"
},
"course_count": {
"type": "integer"
},
"location": {
"type": "string"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id",
"summary": "Get Organization by Id",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved organization details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 40
},
"name": {
"type": "string",
"example": "demo_course"
},
"description": {
"type": "string",
"example": "This is demo organization"
},
"project": {
"type": "object",
"properties": {
"team_id": {
"type": "integer"
},
"project_id": {
"type": "integer"
},
"project_name": {
"type": "string"
},
"team_name": {
"type": "string"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"series": {
"type": "string"
},
"cpu": {
"type": "integer"
},
"gpu": {
"type": "integer"
},
"memory": {
"type": "integer"
},
"ephemeral_storage": {
"type": "integer"
},
"gpu_memory": {
"type": "integer"
},
"is_free": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"gpu_switch_type": {
"type": "string",
"nullable": true
},
"local_storage_in_gb": {
"type": "integer"
},
"sku_type": {
"type": "string"
},
"gpu_card_type": {
"type": "string"
},
"category": {
"type": "string"
},
"variant": {
"type": "string"
},
"no_of_nodes": {
"type": "integer"
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer"
},
"sku_type": {
"type": "string"
},
"committed_days": {
"type": "integer"
},
"unit_price": {
"type": "number"
},
"currency": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"description": {
"type": "string"
},
"location": {
"type": "string"
}
}
}
}
},
"organization_nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"node_name": {
"type": "string"
},
"node_alias_name": {
"type": "string"
}
}
}
},
"members_count": {
"type": "integer"
},
"max_students": {
"type": "integer"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"resource_count": {
"type": "integer"
},
"iam_info": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"added_user": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"role": {
"type": "string"
},
"iam_type": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"is_student": {
"type": "boolean"
}
}
},
"invited_count": {
"type": "integer"
},
"ai_lab_plan": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"no_of_students": {
"type": "integer"
},
"is_active": {
"type": "boolean"
},
"no_of_nodes": {
"type": "integer"
}
}
},
"committed_info": {
"type": "object",
"nullable": true
},
"status": {
"type": "string"
},
"course_count": {
"type": "integer"
},
"location": {
"type": "string"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-ai-labs-organization-organization-id",
"summary": "Delete organization by Id",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully deleted the organization",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Organization deleted successfully"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/sku/update/": {
"put": {
"operationId": "put-ai-labs-organization-organization-id-sku-update",
"summary": "Convert to Committed or Renewal Policy",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region. Convert your organization's AI Labs subscription to a committed plan or update the renewal policy. Change the request body using the dropdown in the examples section to choose between converting to a committed plan or updating the renewal policy.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"description": "ID of the SKU item price to be converted to a committed plan"
},
"committed_instance_policy": {
"type": "string",
"enum": [
"auto_terminate",
"convert_to_hourly_billing",
"auto_renew"
],
"description": "Policy for handling the instance after or during commitment"
},
"next_sku_item_price_id": {
"type": "integer",
"nullable": true,
"description": "ID of the next SKU item price to be used for renewal, if applicable"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully converted to committed plan",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 43
},
"name": {
"type": "string",
"example": "ai-labs-org-251028113044"
},
"description": {
"type": "string",
"nullable": true
},
"project": {
"type": "object",
"properties": {
"team_id": {
"type": "integer",
"example": 10928
},
"project_id": {
"type": "integer",
"example": 8004
},
"project_name": {
"type": "string",
"example": "ai-labs-project-7ccf237b"
},
"team_name": {
"type": "string",
"example": "AI Labs Team-b612cb18"
}
}
},
"sku_details": {
"type": "object",
"properties": {
"specs": {
"type": "object",
"properties": {
"sku_id": {
"type": "integer",
"example": 204
},
"name": {
"type": "string",
"example": "GDC.4xH10080-104.1000GB_SXM"
},
"series": {
"type": "string",
"example": "GPU"
},
"cpu": {
"type": "integer",
"example": 104
},
"gpu": {
"type": "integer",
"example": 4
},
"memory": {
"type": "integer",
"example": 1000
},
"ephemeral_storage": {
"type": "integer",
"example": 50
},
"gpu_memory": {
"type": "integer",
"example": 320
},
"is_free": {
"type": "boolean",
"example": false
},
"is_active": {
"type": "boolean",
"example": true
},
"gpu_switch_type": {
"type": "string",
"nullable": true
},
"local_storage_in_gb": {
"type": "integer",
"example": 0
},
"sku_type": {
"type": "string",
"example": "GDC-8xH10080"
},
"gpu_card_type": {
"type": "string",
"example": "H100"
},
"category": {
"type": "string",
"example": "ai_labs"
},
"variant": {
"type": "string",
"example": "e2e"
},
"no_of_nodes": {
"type": "integer",
"example": 1
}
}
},
"plan": {
"type": "object",
"properties": {
"sku_item_price_id": {
"type": "integer",
"example": 1272
},
"sku_type": {
"type": "string",
"example": "committed"
},
"committed_days": {
"type": "integer",
"example": 30
},
"unit_price": {
"type": "number",
"example": 550000
},
"currency": {
"type": "string",
"example": "INR"
},
"is_active": {
"type": "boolean",
"example": true
},
"description": {
"type": "string",
"example": "Committed ai_labs for 30 days"
},
"location": {
"type": "string",
"example": "Delhi"
}
}
}
}
},
"organization_nodes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"node_name": {
"type": "string",
"example": "spk-4h100-hgx-10"
},
"node_alias_name": {
"type": "string",
"example": "e2e_node_167"
}
}
}
},
"members_count": {
"type": "integer",
"example": 1
},
"max_students": {
"type": "integer",
"example": 50
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:00:50.909464Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:01:31.034750Z"
},
"resource_count": {
"type": "integer",
"example": 0
},
"iam_info": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4753
},
"owner": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"added_user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"role": {
"type": "string",
"example": "Owner"
},
"iam_type": {
"type": "string",
"example": "OwnerIam"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-05-28T12:43:30.244608Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-05-28T12:43:30.244712Z"
},
"is_student": {
"type": "boolean",
"example": true
}
}
},
"invited_count": {
"type": "integer",
"example": 0
},
"ai_lab_plan": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "GDC.4xH10080-104.1000GB_SXM"
},
"no_of_students": {
"type": "integer",
"example": 50
},
"is_active": {
"type": "boolean",
"example": true
},
"no_of_nodes": {
"type": "integer",
"example": 1
}
}
},
"committed_info": {
"type": "object",
"properties": {
"resource_state": {
"type": "string",
"example": "running"
},
"updation_policy": {
"type": "string",
"enum": [
"auto_terminate",
"convert_to_hourly_billing",
"auto_renew"
],
"example": "auto_terminate"
},
"next_sku_item_price": {
"type": "object",
"nullable": true
},
"end_date": {
"type": "string",
"format": "date-time",
"example": "2025-11-27T06:01:31.247235Z"
}
}
},
"status": {
"type": "string",
"example": "active"
},
"course_count": {
"type": "integer",
"example": 0
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/actions/": {
"put": {
"operationId": "put-ai-labs-organization-organization-id-actions",
"summary": "Free up resources",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "action",
"in": "query",
"required": true,
"description": "Action to perform on organization resources",
"schema": {
"type": "string",
"enum": [
"stop_resources"
]
},
"example": "stop_resources"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Empty request body for initiating the free-up resources operation",
"example": {}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully initiated the resource stop operation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Resource stop operation initiated successfully. The resources will shut down shortly."
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/group/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-group",
"summary": "List Groups",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved group list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 55
},
"allowed_plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"plan_id": {
"type": "integer",
"example": 1
},
"plan_name": {
"type": "string",
"example": "GDC.H100.5g.3.9GB_SXM"
},
"max_instances": {
"type": "integer",
"example": 1
}
}
}
},
"policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 363
},
"name": {
"type": "string",
"example": "E2E Default AI-Labs Student Policy."
},
"description": {
"type": "string",
"example": "This policy is created by default to give all the access to the students."
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:09.594211Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:09.594263Z"
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"permissions": {
"type": "integer",
"example": 15
},
"service": {
"type": "object",
"properties": {
"service_id": {
"type": "string",
"example": "notebook"
},
"alias_name": {
"type": "string",
"example": "Node"
},
"description": {
"type": "string",
"example": "notebook"
}
}
}
}
}
}
}
}
},
"tag": {
"type": "string",
"example": "Default"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-ai-labs-organization-organization-id-group",
"summary": "Create Group",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"tag"
],
"properties": {
"tag": {
"type": "string",
"description": "Unique tag for the group",
"example": "group-25102716406"
},
"allowed_plans": {
"type": "array",
"description": "List of allowed plans for the group with max instances",
"items": {
"type": "object",
"properties": {
"plan_id": {
"type": "integer",
"example": 7
},
"plan_name": {
"type": "string",
"example": "GDC.H100.80g.26.250GB_SXM"
},
"max_instances": {
"type": "integer",
"example": 1
}
}
}
},
"policies": {
"type": "array",
"description": "List of service policies with CRUD permissions",
"items": {
"type": "object",
"properties": {
"service_id": {
"type": "string",
"example": "notebook"
},
"create": {
"type": "boolean",
"example": true
},
"read": {
"type": "boolean",
"example": true
},
"update": {
"type": "boolean",
"example": true
},
"delete": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully created a group",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 57
},
"allowed_plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"plan_id": {
"type": "integer",
"example": 1
},
"plan_name": {
"type": "string",
"example": "GDC.H100.5g.3.9GB_SXM"
},
"max_instances": {
"type": "integer",
"example": 1
}
}
}
},
"policies": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 365
},
"name": {
"type": "string",
"example": "AI_Labs_Policy_a14e8"
},
"description": {
"type": "string",
"example": "AI_Labs_Policy_Description_57"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:04:46.805475Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:04:46.805504Z"
},
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"permissions": {
"type": "integer",
"example": 15
},
"service": {
"type": "object",
"properties": {
"service_id": {
"type": "string",
"example": "notebook"
},
"alias_name": {
"type": "string",
"example": "Node"
},
"description": {
"type": "string",
"example": "notebook"
}
}
}
}
}
}
}
}
},
"tag": {
"type": "string",
"example": "group-251028123437"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/group/{Group_Id}/": {
"put": {
"operationId": "put-ai-labs-organization-organization-id-group-group-id",
"summary": "Update Group",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Group_Id",
"in": "path",
"required": true,
"description": "Unique identifier for the group",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"tag"
],
"properties": {
"tag": {
"type": "string",
"description": "Updated tag for the group",
"example": "Default"
},
"allowed_plans": {
"type": "array",
"description": "List of allowed plans for the group with max instances",
"items": {
"type": "object",
"properties": {
"plan_id": {
"type": "integer",
"example": 1
},
"plan_name": {
"type": "string",
"example": "GDC.H100.5g.3.9GB_SXM"
},
"max_instances": {
"type": "integer",
"example": 1
}
}
}
},
"policies": {
"type": "array",
"description": "List of service policies with CRUD permissions",
"items": {
"type": "object",
"properties": {
"service_id": {
"type": "string",
"example": "notebook"
},
"create": {
"type": "boolean",
"example": true
},
"read": {
"type": "boolean",
"example": true
},
"update": {
"type": "boolean",
"example": true
},
"delete": {
"type": "boolean",
"example": true
}
}
}
}
}
}
}
},
"required": true
},
"responses": {
"default": {
"description": "Successful response"
}
}
},
"delete": {
"operationId": "delete-ai-labs-organization-organization-id-group-group-id",
"summary": "Delete Group",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Group_Id",
"in": "path",
"required": true,
"description": "Unique identifier for the group",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully deleted the group",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Group deleted successfully"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/members/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-members",
"summary": "List Members",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully fetched the list of members",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 10400
},
"project_id": {
"type": "integer",
"example": 8007
},
"role": {
"type": "string",
"example": "AI_Labs_Admin"
},
"member": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:08.646183Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:08.646229Z"
},
"group_tags": {
"type": "array",
"items": {
"type": "string"
},
"example": []
},
"services": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"resource_count": {
"type": "integer",
"example": 1
},
"tir_role": {
"type": "string",
"example": "Owner"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-ai-labs-organization-organization-id-members",
"summary": "Add Members",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"member_emails",
"role"
],
"properties": {
"member_emails": {
"type": "array",
"description": "List of member email addresses to be added",
"items": {
"type": "string",
"format": "email",
"example": "test.singh1@gmail.com"
}
},
"role": {
"type": "string",
"description": "Role assigned to the members",
"example": "AI_Labs_Student"
},
"groups": {
"type": "array",
"description": "List of group IDs to which the members should be added",
"items": {
"type": "integer",
"example": 57
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully sent member invite",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "string",
"example": "Member Invite Sent."
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/course/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-course",
"summary": "List Courses",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully fetched the list of courses",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 25
},
"name": {
"type": "string",
"example": "course-251028115114"
},
"description": {
"type": "string",
"example": "This is a course description"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:15.978247Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:17.977078Z"
},
"courseware_details": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3005
},
"name": {
"type": "string",
"example": "ai-labs-course-1761632475"
},
"project_id": {
"type": "integer",
"example": 8007
},
"description": {
"type": "string",
"nullable": true
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5035
},
"bucket_name": {
"type": "string",
"example": "d-gpu-68e7aa62-c3ae-4c42-b09b-dc2186338dfe"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-68e7aa62-c3ae-4c42-b09b-dc2186338dfe/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 16757
},
"location": {
"type": "string",
"example": "Delhi"
},
"bucket_size": {
"type": "string",
"example": "0 bytes"
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5053
},
"access_key": {
"type": "string",
"example": "18NQRRWT4ZGQRNS1VM8I"
},
"secret_key": {
"type": "string",
"nullable": true
},
"tag": {
"type": "string",
"example": "akgpu100eb36863de4d80b08302a9050f21e4"
},
"is_managed": {
"type": "boolean",
"example": true
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"encryption_type": {
"type": "string",
"nullable": true
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "OK"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:17.919029Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:17.919086Z"
},
"pfs": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"professor_title": {
"type": "string",
"example": "Prof."
},
"professor_name": {
"type": "string",
"example": "test"
},
"professor": {
"type": "string",
"example": "Prof. test"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-ai-labs-organization-organization-id-course",
"summary": "Add Course",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"professor_name",
"professor_title"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the course",
"example": "course-251027164554"
},
"description": {
"type": "string",
"description": "Description of the course",
"example": "This is a course description"
},
"professor_name": {
"type": "string",
"description": "Name of the professor",
"example": "Akansha"
},
"professor_title": {
"type": "string",
"enum": [
"Prof.",
"Dr.",
"Mr.",
"Ms.",
"Mrs."
],
"description": "Title of the professor",
"example": "Prof."
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully created a new course",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 26
},
"name": {
"type": "string",
"example": "course-251027164554"
},
"description": {
"type": "string",
"example": "This is a course description"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:44.701976Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:46.515400Z"
},
"courseware_details": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3006
},
"name": {
"type": "string",
"example": "ai-labs-course-1761636164"
},
"project_id": {
"type": "integer",
"example": 8007
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true,
"example": null
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5037
},
"bucket_name": {
"type": "string",
"example": "d-gpu-86822602-a838-432f-af04-06a2e0ea6fdb"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-86822602-a838-432f-af04-06a2e0ea6fdb/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 16759
},
"location": {
"type": "string",
"example": "Delhi"
},
"bucket_size": {
"type": "string",
"example": "0 bytes"
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5055
},
"access_key": {
"type": "string",
"example": "IMJMASCNSBEICHSPG2BN"
},
"secret_key": {
"type": "string",
"nullable": true,
"example": null
},
"tag": {
"type": "string",
"example": "akgpue9b954868841451a9fbec7df7d83f102"
},
"is_managed": {
"type": "boolean",
"example": true
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"encryption_type": {
"type": "string",
"nullable": true,
"example": null
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "Pending"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:46.461837Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:46.461890Z"
},
"pfs": {
"type": "string",
"nullable": true,
"example": null
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"professor_title": {
"type": "string",
"example": "Prof."
},
"professor_name": {
"type": "string",
"example": "test"
},
"professor": {
"type": "string",
"example": "Prof. test"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/course/{Course_Id}/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-course-course-id",
"summary": "Get Course by Id",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully fetched course details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 26
},
"name": {
"type": "string",
"example": "course-251027164554"
},
"description": {
"type": "string",
"example": "This is a course description"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:44.701976Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:46.515400Z"
},
"courseware_details": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3006
},
"name": {
"type": "string",
"example": "ai-labs-course-1761636164"
},
"project_id": {
"type": "integer",
"example": 8007
},
"description": {
"type": "string",
"nullable": true,
"example": null
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true,
"example": null
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5037
},
"bucket_name": {
"type": "string",
"example": "d-gpu-86822602-a838-432f-af04-06a2e0ea6fdb"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-86822602-a838-432f-af04-06a2e0ea6fdb/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 16759
},
"location": {
"type": "string",
"example": "Delhi"
},
"bucket_size": {
"type": "string",
"example": "0 bytes"
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5055
},
"access_key": {
"type": "string",
"example": "IMJMASCNSBEICHSPG2BN"
},
"secret_key": {
"type": "string",
"nullable": true,
"example": null
},
"tag": {
"type": "string",
"example": "akgpue9b954868841451a9fbec7df7d83f102"
},
"is_managed": {
"type": "boolean",
"example": true
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"encryption_type": {
"type": "string",
"nullable": true,
"example": null
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "Pending"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:46.461837Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:22:46.461890Z"
},
"pfs": {
"type": "string",
"nullable": true,
"example": null
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"professor_title": {
"type": "string",
"example": "Prof."
},
"professor_name": {
"type": "string",
"example": "test"
},
"professor": {
"type": "string",
"example": "Prof. test"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/course/{Course_Id}/students/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-course-course-id-students",
"summary": "List Students",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully fetched the list of students",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 10400
},
"project_id": {
"type": "integer",
"example": 8007
},
"role": {
"type": "string",
"example": "AI_Labs_Admin"
},
"member": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:08.646183Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:21:08.646229Z"
},
"group_tags": {
"type": "array",
"items": {
"type": "string"
}
},
"services": {
"type": "array",
"items": {
"type": "string"
}
},
"resource_count": {
"type": "integer",
"example": 1
},
"tir_role": {
"type": "string",
"example": "Owner"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
},
"put": {
"operationId": "put-ai-labs-organization-organization-id-course-course-id-students",
"summary": "Add or Remove Students from Course",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region. Select addition_type as 'group_ids' to add students via group IDs or 'emails' to add via email addresses. Make sure to change the request body using the dropdown in the examples section.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "addition_type",
"in": "query",
"required": true,
"description": "Type of student addition (by group IDs or emails)",
"schema": {
"type": "string",
"enum": [
"group_ids",
"member_ids"
]
},
"example": "group_ids"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"member_ids": {
"type": "array",
"description": "List of student member IDs to add or remove",
"items": {
"type": "integer"
}
},
"group_ids": {
"type": "array",
"description": "List of group IDs to add or remove",
"items": {
"type": "integer"
}
},
"action": {
"type": "string",
"description": "Action to perform — either `add` or `remove`",
"enum": [
"add",
"remove"
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully added or removed students from the course",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "string",
"example": "Successfully added/removed Students from the course"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/course/{Course_Id}/shared-storage/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-course-course-id-shared-storage",
"summary": "List Shared Datasets",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of shared storages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 12
},
"name": {
"type": "string",
"example": "ai-labs-251028130016"
},
"shared_storage_details": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3008
},
"name": {
"type": "string",
"example": "ai-labs-251028130016"
},
"project_id": {
"type": "integer",
"example": 8007
},
"description": {
"type": "string",
"nullable": true
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5039
},
"bucket_name": {
"type": "string",
"example": "d-gpu-2facdeb3-117-9f58-d9db3892cf0e"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-2facdeb37-4117-9f58-d9db3892cf0e/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 16761
},
"location": {
"type": "string",
"example": "Delhi"
},
"bucket_size": {
"type": "string",
"example": "0 bytes"
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5057
},
"access_key": {
"type": "string",
"example": "Y1OE9IWZ5NCRYT4"
},
"secret_key": {
"type": "string",
"nullable": true
},
"tag": {
"type": "string",
"example": "akgpufa3189947ce8028dd35d94b6134"
},
"is_managed": {
"type": "boolean",
"example": true
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"encryption_type": {
"type": "string",
"nullable": true
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "OK"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:30:24.179493Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:30:24.179546Z"
},
"pfs": {
"type": "string",
"nullable": true
},
"is_ai_labs_learning_dataset": {
"type": "boolean",
"example": false
},
"is_mounted_on_another_node": {
"type": "boolean",
"nullable": true
}
}
},
"created_by": {
"type": "integer",
"example": 7483
},
"storage_type": {
"type": "string",
"example": "managed"
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-ai-labs-organization-organization-id-course-course-id-shared-storage",
"summary": "Create Shared Dataset",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name",
"storage_type"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the shared storage",
"example": "ai-labs-251027174445"
},
"storage_type": {
"type": "string",
"description": "Type of storage",
"example": "managed"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully created shared storage",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 13
},
"name": {
"type": "string",
"example": "ai-labs-22"
},
"shared_storage_details": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3009
},
"name": {
"type": "string",
"example": "ai-labs-22"
},
"project_id": {
"type": "integer",
"example": 8007
},
"description": {
"type": "string",
"nullable": true
},
"storage_type": {
"type": "string",
"example": "managed"
},
"pvc": {
"type": "string",
"nullable": true
},
"bucket": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5040
},
"bucket_name": {
"type": "string",
"example": "d-gpu-28911c97-a14c-4bc0-843b-d5c79fb58ee1"
},
"bucket_url": {
"type": "string",
"example": "s3://d-gpu-28911c97-a14c-4bc0-843b-d5c79fb58ee1/"
},
"endpoint": {
"type": "string",
"example": "https://objectstore.e2enetworks.net"
},
"is_managed": {
"type": "boolean",
"example": true
},
"eos_bucket_permission_id": {
"type": "integer",
"example": 16762
},
"location": {
"type": "string",
"example": "Delhi"
},
"bucket_size": {
"type": "string",
"example": "0 bytes"
}
}
},
"access_key": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 5058
},
"access_key": {
"type": "string",
"example": "KQDVZB27TBRE0G7K8AD4"
},
"secret_key": {
"type": "string",
"nullable": true
},
"tag": {
"type": "string",
"example": "akgpu09d7ae590228460d96a0224373482ebd"
},
"is_managed": {
"type": "boolean",
"example": true
},
"location": {
"type": "string",
"example": "Delhi"
}
}
},
"encryption_type": {
"type": "string",
"nullable": true
},
"encryption_enable": {
"type": "boolean",
"example": false
},
"status": {
"type": "string",
"example": "Pending"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 7483
},
"name": {
"type": "string",
"example": "test"
},
"email": {
"type": "string",
"format": "email",
"example": "test@gmail.com"
},
"username": {
"type": "string",
"example": "test@gmail.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:32:33.164317Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T07:32:33.164370Z"
},
"pfs": {
"type": "string",
"nullable": true
},
"is_ai_labs_learning_dataset": {
"type": "boolean",
"example": false
},
"is_mounted_on_another_node": {
"type": "boolean",
"nullable": true
}
}
},
"created_by": {
"type": "integer",
"example": 7483
},
"storage_type": {
"type": "string",
"example": "managed"
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/course/{Course_Id}/shared-storage/{Storage_Id}/": {
"delete": {
"operationId": "delete-ai-labs-organization-organization-id-course-course-id-shared-storage-storage-id",
"summary": "Delete Shared Dataset",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region.",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Storage_Id",
"in": "path",
"required": true,
"description": "Unique identifier for the shared storage",
"schema": {
"type": "integer"
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully deleted shared storage",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"example": {}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Dataset deleted successfully"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/course/{Course_Id}/shared-storage/{Storage_Id}/objects/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-course-course-id-shared-storage-storage-id-objects",
"summary": "List Data Objects",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region. List all objects/files in a shared storage",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Course_Id",
"in": "path",
"required": true,
"description": "Course ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "Storage_Id",
"in": "path",
"required": true,
"description": "Unique identifier for the shared storage",
"schema": {
"type": "integer"
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "prefix",
"in": "query",
"required": false,
"description": "Prefix to filter objects in storage",
"schema": {
"type": "string"
},
"example": ""
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved storage objects list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket_name": {
"type": "string",
"example": "d-gpu-28911c97-a14c-4bc0-843b-d5c79fb58ee1"
},
"contentType": {
"type": "string",
"nullable": true
},
"is_delete_marker": {
"type": "boolean",
"example": false
},
"is_dir": {
"type": "boolean",
"example": false
},
"is_latest": {
"type": "boolean",
"nullable": true
},
"lastModified": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T08:49:17.222000Z"
},
"name": {
"type": "string",
"example": "AI Labs.postman_collection.json"
},
"owner_id": {
"type": "integer",
"nullable": true
},
"owner_name": {
"type": "string",
"nullable": true
},
"size": {
"type": "integer",
"example": 94339
},
"storage_class": {
"type": "string",
"example": "STANDARD"
},
"version_id": {
"type": "string",
"nullable": true
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 1
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/activity-logs/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-activity-logs",
"summary": "List Activity Timeline",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region. Get activity logs and timeline for the organization",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "service_name",
"in": "query",
"required": true,
"description": "Service Name",
"schema": {
"type": "string",
"enum": [
"AI_LABS_SERVICE",
"all",
"INFERENCE_SERVICE",
"NOTEBOOK_SERVICE",
"DATASET_SERVICE",
"MODEL",
"INTEGRATION_SERVICE",
"API_TOKEN",
"AI_LABS_SHARED_STORAGE_SERVICE",
"AI_LABS_GROUP_SERVICE",
"AI_LABS_COURSE_SERVICE"
]
}
},
{
"name": "date_filter",
"in": "query",
"required": false,
"description": "Date filter for activity logs. If custom is selected, use start_date and end_date parameters",
"schema": {
"type": "string",
"enum": [
"current_month",
"previous_month",
"semi_annual",
"custom"
],
"default": "current_month"
},
"example": "current_month"
},
{
"name": "role",
"in": "query",
"required": false,
"description": "Filter activity logs by user role",
"schema": {
"type": "string",
"enum": [
"Professional",
"Student"
]
},
"example": "Professional"
}
],
"responses": {
"200": {
"description": "Response containing activity logs for resources like datasets and notebooks",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"service": {
"type": "string",
"example": "AI_LABS_DATASET_SERVICE"
},
"resource_name": {
"type": "string",
"example": "tir-dataset-060216425656"
},
"resource_id": {
"type": "string",
"example": "2387"
},
"event": {
"type": "string",
"example": "DATASET_CREATE_WITH_DISK"
},
"client_ip": {
"type": "string",
"example": "14.143.159.8"
},
"status": {
"type": "string",
"example": "Success"
},
"detailed_info": {
"type": "object",
"properties": {
"response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"data": {
"type": "object",
"description": "Full dataset or notebook resource object"
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Created Successfully"
}
}
},
"project_id": {
"type": "integer",
"example": 1223
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2025-06-02T11:13:00.446283Z"
},
"event_type": {
"type": "string",
"example": "Create"
},
"description": {
"type": "string",
"example": "Dataset tir-dataset-060216425656 created successfully using a Disk"
},
"activity_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4946
},
"name": {
"type": "string",
"example": "Demo User"
},
"email": {
"type": "string",
"example": "pqrs@stuv.com"
},
"username": {
"type": "string",
"example": "pqrs@stuv.com"
}
}
},
"course_id": {
"type": "integer",
"example": 45
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/metrics/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-metrics",
"summary": "Monitoring Data",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region. Get monitoring metrics for organization resources",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "node_name",
"in": "query",
"required": true,
"description": "Name of the node to retrieve metrics for",
"schema": {
"type": "string"
},
"example": "spk-4h100-hgx-10"
},
{
"name": "interval",
"in": "query",
"required": true,
"description": "Time interval for metrics aggregation",
"schema": {
"type": "string",
"enum": [
"1m",
"5m",
"15m",
"30m",
"1h"
]
},
"example": "5m"
}
],
"responses": {
"200": {
"description": "Successfully retrieved node metrics",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"node_memory_MemTotal_bytes": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "1.9148718093873627"
}
}
}
},
"node_cpu_seconds_total": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "0.286718749999304"
}
}
}
},
"node_disk_read_bytes_total": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "10928503296"
}
}
}
},
"node_disk_written_bytes_total": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "38315643904"
}
}
}
},
"gpu_memory_util": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "0"
}
}
}
}
},
"gpu_power_usage": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "69.512"
}
}
}
}
},
"gpu_temperature": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "33"
}
}
}
}
},
"gpu_util": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"time_series": {
"type": "array",
"items": {
"type": "string",
"example": "02:17:18PM"
}
},
"value_series": {
"type": "array",
"items": {
"type": "string",
"example": "0"
}
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/ai_labs/organization/{Organization_Id}/usage/": {
"get": {
"operationId": "get-ai-labs-organization-organization-id-usage",
"summary": "Resource Utilization",
"tags": [
"AI Labs"
],
"description": "**Note:** AI Labs is currently available only in the **Delhi** region. Get resource utilization and usage statistics for the organization",
"parameters": [
{
"name": "Organization_Id",
"in": "path",
"required": true,
"description": "Organization ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved resource usage",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"data": {
"type": "object",
"properties": {
"resources": {
"type": "object",
"properties": {
"notebooks": {
"type": "object",
"properties": {
"running": {
"type": "integer",
"example": 0
},
"inactive": {
"type": "integer",
"example": 1
},
"total": {
"type": "integer",
"example": 1
},
"last_launched": {
"type": "string",
"format": "date-time",
"example": "2025-10-28T06:23:16.246133Z"
}
}
},
"inference_service": {
"type": "object",
"properties": {
"running": {
"type": "integer",
"example": 0
},
"inactive": {
"type": "integer",
"example": 0
},
"total": {
"type": "integer",
"example": 0
},
"last_launched": {
"type": "string",
"example": ""
}
}
},
"dataset": {
"type": "object",
"properties": {
"running": {
"type": "integer",
"example": 0
},
"inactive": {
"type": "integer",
"example": 0
},
"total": {
"type": "integer",
"example": 0
},
"last_launched": {
"type": "string",
"example": ""
}
}
}
}
},
"used_gpu_percentage": {
"type": "number",
"format": "float",
"example": 0
},
"resource_per_plan": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 1
},
"percentage": {
"type": "number",
"format": "float",
"example": 100
}
}
}
}
}
},
"errors": {
"type": "object",
"example": {}
},
"message": {
"type": "string",
"example": "Success"
}
}
}
}
}
}
}
}
},
"/alerts/": {
"get": {
"operationId": "get-alerts",
"summary": "Alerts List",
"tags": [
"Alerts Management"
],
"description": "Retrieve all configured alerts for a given project with pagination support.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "service",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"",
"notebook",
"inference_service"
]
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response with alerts list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 3
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 42
},
"name": {
"type": "string",
"example": "alert-260320091734"
},
"location": {
"type": "string",
"example": "Delhi"
},
"location_key": {
"type": "string",
"example": "Delhi"
},
"resource_type": {
"type": "string",
"example": "Instance"
},
"resource_type_key": {
"type": "string",
"example": "notebook"
},
"metric_type": {
"type": "string",
"example": "CPU Utilization"
},
"metric_type_key": {
"type": "string",
"example": "cpu"
},
"metric_type_unit": {
"type": "string",
"example": "%"
},
"operator": {
"type": "string",
"example": "Less Than"
},
"operator_key": {
"type": "string",
"example": "<"
},
"threshold_value": {
"type": "number",
"format": "float",
"example": 12
},
"severity": {
"type": "string",
"example": "Critical"
},
"severity_key": {
"type": "string",
"example": "Critical"
},
"monitoring_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 26
},
"name": {
"type": "string",
"example": "Dev-Team"
},
"description": {
"type": "string",
"example": ""
},
"project": {
"type": "integer",
"example": 10450
},
"member_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345
]
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 42
},
"name": {
"type": "string",
"example": "alert-260320091734"
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T11:32:09Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T11:32:09Z"
}
}
}
},
"attached_resources": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-20T03:47:48Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-20T03:47:48Z"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-alerts",
"summary": "Create Alert",
"tags": [
"Alerts Management"
],
"description": "Create a new alert for monitoring notebook resources based on specified thresholds.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "alert-260325112117"
},
"resource_type": {
"type": "string",
"description": "Type of resource to monitor",
"enum": [
"notebook",
"inference_service"
],
"example": "notebook"
},
"metric_type": {
"type": "string",
"description": "Metric on which alert is based",
"enum": [
"cpu",
"memory",
"disk_usage",
"ephemeral_storage",
"gpu_temperature",
"gpu_power"
],
"example": "memory"
},
"operator": {
"type": "string",
"description": "Comparison operator",
"enum": [
">",
"<",
">=",
"<=",
"==",
"!="
],
"example": ">"
},
"threshold_value": {
"type": "number",
"format": "float",
"description": "Threshold value for triggering alert",
"example": 80
},
"monitoring_group_ids": {
"type": "array",
"description": "List of monitoring group IDs",
"items": {
"type": "integer"
},
"example": [
26
]
},
"severity": {
"type": "string",
"enum": [
"Critical",
"Warning",
"Info"
],
"example": "Critical"
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Alert created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Alert created successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 51
},
"name": {
"type": "string",
"example": "alert-260325112117"
},
"location": {
"type": "string",
"example": "Delhi"
},
"location_key": {
"type": "string",
"example": "Delhi"
},
"resource_type": {
"type": "string",
"example": "Instance"
},
"resource_type_key": {
"type": "string",
"example": "notebook"
},
"metric_type": {
"type": "string",
"example": "Memory Utilization"
},
"metric_type_key": {
"type": "string",
"example": "memory"
},
"metric_type_unit": {
"type": "string",
"example": "%"
},
"operator": {
"type": "string",
"example": "Greater Than"
},
"operator_key": {
"type": "string",
"example": ">"
},
"threshold_value": {
"type": "number",
"format": "float",
"example": 80
},
"severity": {
"type": "string",
"example": "Critical"
},
"severity_key": {
"type": "string",
"example": "Critical"
},
"monitoring_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 26
},
"name": {
"type": "string",
"example": "Dev-Team"
},
"description": {
"type": "string",
"example": ""
},
"project": {
"type": "integer",
"example": 10450
},
"member_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345
]
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 51
},
"name": {
"type": "string",
"example": "alert-260325112117"
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T11:32:09Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T11:32:09Z"
}
}
}
},
"attached_resources": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T05:51:36Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T05:51:36Z"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/alerts/{alert_id}/": {
"put": {
"operationId": "put-alerts-alert-id",
"summary": "Update Alert",
"tags": [
"Alerts Management"
],
"description": "Update an existing alert with new configuration such as threshold, metric, or monitoring groups.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "alert_id",
"in": "path",
"required": true,
"description": "Alert ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "alert-260325114033"
},
"metric_type": {
"type": "string",
"description": "Metric on which alert is based",
"enum": [
"cpu",
"memory",
"disk_usage",
"ephemeral_storage",
"gpu_temperature",
"gpu_power"
],
"example": "gpu_power"
},
"operator": {
"type": "string",
"description": "Comparison operator",
"enum": [
">",
"<",
">=",
"<=",
"==",
"!="
],
"example": "=="
},
"threshold_value": {
"type": "number",
"format": "float",
"example": 47
},
"monitoring_group_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
24,
26
]
},
"severity": {
"type": "string",
"enum": [
"Critical",
"Warning",
"Info"
],
"example": "Info"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Alert updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Alert updated successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 55
},
"name": {
"type": "string",
"example": "alert-260325114033"
},
"location": {
"type": "string",
"example": "Delhi"
},
"location_key": {
"type": "string",
"example": "Delhi"
},
"resource_type": {
"type": "string",
"example": "Instance"
},
"resource_type_key": {
"type": "string",
"example": "notebook"
},
"metric_type": {
"type": "string",
"example": "GPU Power"
},
"metric_type_key": {
"type": "string",
"example": "gpu_power"
},
"metric_type_unit": {
"type": "string",
"example": "W"
},
"operator": {
"type": "string",
"example": "Equal To"
},
"operator_key": {
"type": "string",
"example": "=="
},
"threshold_value": {
"type": "number",
"format": "float",
"example": 47
},
"severity": {
"type": "string",
"example": "Info"
},
"severity_key": {
"type": "string",
"example": "Info"
},
"monitoring_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 24
},
"name": {
"type": "string",
"example": "group-name"
},
"description": {
"type": "string",
"example": "group description"
},
"project": {
"type": "integer",
"example": 10450
},
"member_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345
]
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 55
},
"name": {
"type": "string",
"example": "alert-name"
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T10:54:14Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T10:54:14Z"
}
}
}
},
"attached_resources": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:10:46Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:52:46Z"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-alerts-alert-id",
"summary": "Delete Alert",
"tags": [
"Alerts Management"
],
"description": "Delete an existing alert from the project.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "alert_id",
"in": "path",
"required": true,
"description": "Alert ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Alert deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Alert deleted successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/alerts/monitoring-groups/": {
"get": {
"operationId": "get-alerts-monitoring-groups",
"summary": "Monitoring Groups List",
"tags": [
"Alerts Management"
],
"description": "Retrieve all monitoring groups associated with alerts for a given project.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "page_no",
"in": "query",
"required": false,
"description": "The page number from which you want your page search results to be displayed.",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "per_page",
"in": "query",
"required": false,
"description": "Number of results per page",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Successful response with monitoring groups list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"total_page_number": {
"type": "integer",
"example": 1
},
"total_count": {
"type": "integer",
"example": 3
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 26
},
"name": {
"type": "string",
"example": "Dev-Team"
},
"description": {
"type": "string",
"example": ""
},
"project": {
"type": "integer",
"example": 10450
},
"member_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345
]
},
"alerts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 55
},
"name": {
"type": "string",
"example": "alert-260325114033"
}
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T11:32:09Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-19T11:32:09Z"
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-alerts-monitoring-groups",
"summary": "Create Monitoring Group",
"tags": [
"Alerts Management"
],
"description": "Create a new monitoring group to associate users with alerts.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the monitoring group",
"example": "dev-group"
},
"description": {
"type": "string",
"description": "Description of the monitoring group",
"example": "this is the group for all the developers"
},
"member_ids": {
"type": "array",
"description": "List of member IDs to be included in the group",
"items": {
"type": "integer"
},
"example": [
12345
]
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Monitoring group created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Monitoring group created successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 37
},
"name": {
"type": "string",
"example": "dev-group"
},
"description": {
"type": "string",
"example": "this is the group for all the developers"
},
"project": {
"type": "integer",
"example": 10450
},
"member_ids": {
"type": "array",
"items": {
"type": "integer"
},
"example": [
12345
]
},
"alerts": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:22:57Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:22:57Z"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/alerts/monitoring-groups/{Monitoring_Group_Id}/": {
"put": {
"operationId": "put-alerts-monitoring-groups-monitoring-group-id",
"summary": "Update Monitoring Group",
"tags": [
"Alerts Management"
],
"description": "Update an existing monitoring group’s name, description, or members.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Monitoring_Group_Id",
"in": "path",
"required": true,
"description": "Monitoring Group ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Updated name of the monitoring group",
"example": "group-260325120151"
},
"description": {
"type": "string",
"description": "Updated description of the monitoring group",
"example": "this is the description"
},
"member_ids": {
"type": "array",
"description": "List of member IDs to be included in the group",
"items": {
"type": "integer"
},
"example": [
12345,
67890
]
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Monitoring group updated successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Monitoring group updated successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 38
},
"name": {
"type": "string",
"example": "group-260325120151"
},
"description": {
"type": "string",
"example": "this is the description"
},
"project": {
"type": "integer",
"example": 11035
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"project_id": {
"type": "integer",
"example": 11035
},
"role": {
"type": "string",
"example": "Admin"
},
"team_member": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 2001
},
"team_id": {
"type": "integer",
"example": 5816
},
"iam_user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3001
},
"owner_id": {
"type": "integer",
"example": 1001
},
"added_user": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 4001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"role": {
"type": "string",
"example": "Admin"
}
}
},
"role": {
"type": "string",
"example": "Admin"
}
}
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1001
},
"name": {
"type": "string",
"example": "User Name"
},
"email": {
"type": "string",
"example": "user@example.com"
},
"username": {
"type": "string",
"example": "user@example.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:29:37Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:29:37Z"
}
}
}
},
"alerts": {
"type": "array",
"items": {
"type": "object"
},
"example": []
},
"created_by": {
"type": "integer",
"example": 1001
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:32:11Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2026-03-25T06:32:19Z"
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-alerts-monitoring-groups-monitoring-group-id",
"summary": "Delete Monitoring Group",
"tags": [
"Alerts Management"
],
"description": "Delete an existing monitoring group from the project.",
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
},
{
"name": "Monitoring_Group_Id",
"in": "path",
"required": true,
"description": "Monitoring Group ID",
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "Monitoring group deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Monitoring group deleted successfully"
},
"data": {
"type": "object",
"additionalProperties": false,
"example": {}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/integrations/": {
"get": {
"operationId": "get-integrations",
"summary": "List Integrations",
"tags": [
"External Integration"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved specific Integration details",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Success"
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 394
},
"name": {
"type": "string",
"example": "hf-integration-101616132121"
},
"integration_type": {
"type": "string",
"example": "hugging_face"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-10-16T10:43:48.686144Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-10-16T10:43:48.686190Z"
},
"project_id": {
"type": "integer",
"example": 124
},
"integration_details": {
"type": "object",
"additionalProperties": true,
"example": {}
}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"post": {
"operationId": "post-integrations",
"summary": "Create Integration",
"tags": [
"External Integration"
],
"parameters": [
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"integration_type",
"name",
"integration_details"
],
"properties": {
"integration_type": {
"type": "string",
"description": "The type of integration",
"enum": [
"hugging_face",
"github",
"weights_and_biases"
]
},
"name": {
"type": "string",
"description": "A label to identify this integration"
},
"integration_details": {
"type": "object",
"description": "Integration-specific credentials. The required fields vary by integration_type: - hugging_face: hugging_face_token - github: github_token - weights_and_biases: wandb_username, wandb_key, project_name\n",
"properties": {
"hugging_face_token": {
"type": "string",
"description": "Hugging Face user access token (required for hugging_face)"
},
"github_token": {
"type": "string",
"description": "GitHub personal access token (required for github)"
},
"wandb_username": {
"type": "string",
"description": "Weights & Biases account username (required for weights_and_biases)"
},
"wandb_key": {
"type": "string",
"description": "Weights & Biases API key (required for weights_and_biases)"
},
"project_name": {
"type": "string",
"description": "W&B project where runs will be logged (required for weights_and_biases)"
}
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successfully created a new integration",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 421
},
"name": {
"type": "string",
"example": "fakeff"
},
"integration_type": {
"type": "string",
"example": "hugging_face"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T07:20:43.119393Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T07:20:43.119459Z"
},
"project_id": {
"type": "integer",
"example": 124
},
"integration_details": {
"type": "object",
"additionalProperties": true,
"example": {}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
},
"/integrations/{Integration_id}/": {
"get": {
"operationId": "get-integrations-integration-id",
"summary": "Get Integration Details",
"tags": [
"External Integration"
],
"parameters": [
{
"name": "Integration_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"201": {
"description": "Successfully retrieved a new integration",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 201
},
"message": {
"type": "string",
"example": "Created Successfully"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 421
},
"name": {
"type": "string",
"example": "fakeff"
},
"integration_type": {
"type": "string",
"example": "hugging_face"
},
"created_by": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 3573
},
"name": {
"type": "string",
"example": "Nipun"
},
"email": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
},
"username": {
"type": "string",
"example": "nipun.arora@e2enetworks.com"
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T07:20:43.119393Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2024-11-14T07:20:43.119459Z"
},
"project_id": {
"type": "integer",
"example": 124
},
"integration_details": {
"type": "object",
"additionalProperties": true,
"example": {}
}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
},
"delete": {
"operationId": "delete-integrations-integration-id",
"summary": "Delete Integration",
"tags": [
"External Integration"
],
"parameters": [
{
"name": "Integration_id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "project_id",
"in": "query",
"required": true,
"description": "Project ID",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "active_iam",
"in": "query",
"required": false,
"description": "Active IAM ID **(To access contact person account)** [**Find your Active IAM ID here**](/paths/users-iam-accounts/get)",
"schema": {
"type": "integer",
"minimum": 0
}
},
{
"name": "location",
"in": "query",
"required": true,
"description": "Location",
"schema": {
"type": "string",
"enum": [
"Delhi",
"Chennai"
]
}
}
],
"responses": {
"200": {
"description": "Integration deleted successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 200
},
"message": {
"type": "string",
"example": "Integration deleted successfully"
},
"data": {
"type": "object",
"properties": {
"type": {
"type": "object"
},
"additionalProperties": {}
}
},
"errors": {
"type": "object",
"additionalProperties": false,
"example": {}
}
}
}
}
}
}
}
}
}
},
"x-tagGroups": [
{
"name": "Compute",
"tags": [
"Instance/VM"
]
},
{
"name": "Storage",
"tags": [
"Dataset",
"SFS",
"PFS",
"Container Registry",
"Vector Database"
]
},
{
"name": "Models & Inference",
"tags": [
"Model Repository",
"Model Endpoints",
"Playground API",
"Model Evaluation",
"GenAI API",
"Fine Tune Models"
]
},
{
"name": "Clusters",
"tags": [
"Training Cluster",
"Private Cluster"
]
},
{
"name": "Network",
"tags": [
"Reserve IP",
"Security Groups",
"Security",
"Gateway"
]
},
{
"name": "RAG",
"tags": [
"RAG (Knowledge Base)",
"RAG (Chat Assistant)"
]
},
{
"name": "Pipelines & Runs",
"tags": [
"Pipeline",
"Run",
"Schedule Run"
]
},
{
"name": "Other",
"tags": [
"IAM Users",
"Plans & Pricing",
"SKU",
"Data Syncer",
"AI Labs",
"Alerts Management",
"External Integration"
]
}
]
}