Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
108 changes: 105 additions & 3 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Unified API for QuantCDN Admin and QuantCloud Platform services

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 4.8.0
- API version: 4.9.0
- Package version: 1.0.0
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Expand Down Expand Up @@ -105,10 +105,16 @@ Class | Method | HTTP request | Description
*AICustomToolsApi* | [**create_custom_tool**](docs/AICustomToolsApi.md#create_custom_tool) | **POST** /api/v3/organizations/{organisation}/ai/custom-tools | Register Custom Edge Function Tool
*AICustomToolsApi* | [**delete_custom_tool**](docs/AICustomToolsApi.md#delete_custom_tool) | **DELETE** /api/v3/organizations/{organisation}/ai/custom-tools/{toolName} | Delete Custom Tool
*AICustomToolsApi* | [**list_custom_tools**](docs/AICustomToolsApi.md#list_custom_tools) | **GET** /api/v3/organizations/{organisation}/ai/custom-tools | List Custom Tools
*AIFileStorageApi* | [**delete_file**](docs/AIFileStorageApi.md#delete_file) | **DELETE** /api/v3/organizations/{organisation}/ai/files/{fileId} | Delete File
*AIFileStorageApi* | [**get_file**](docs/AIFileStorageApi.md#get_file) | **GET** /api/v3/organizations/{organisation}/ai/files/{fileId} | Get File
*AIFileStorageApi* | [**list_files**](docs/AIFileStorageApi.md#list_files) | **GET** /api/v3/organizations/{organisation}/ai/files | List Files
*AIFileStorageApi* | [**upload_file**](docs/AIFileStorageApi.md#upload_file) | **POST** /api/v3/organizations/{organisation}/ai/files | Upload File to S3
*AIInferenceApi* | [**chat_inference**](docs/AIInferenceApi.md#chat_inference) | **POST** /api/v3/organizations/{organisation}/ai/chat | Chat inference via API Gateway (buffered responses) with multimodal support
*AIInferenceApi* | [**chat_inference_stream**](docs/AIInferenceApi.md#chat_inference_stream) | **POST** /api/v3/organizations/{organisation}/ai/chat/stream | Chat inference via streaming endpoint (true HTTP streaming) with multimodal support
*AIInferenceApi* | [**embeddings**](docs/AIInferenceApi.md#embeddings) | **POST** /api/v3/organizations/{organisation}/ai/embeddings | Generate text embeddings for semantic search and RAG applications
*AIInferenceApi* | [**get_durable_execution_status**](docs/AIInferenceApi.md#get_durable_execution_status) | **GET** /api/v3/organizations/{organisation}/ai/chat/executions/{identifier} | Get Durable Execution Status
*AIInferenceApi* | [**image_generation**](docs/AIInferenceApi.md#image_generation) | **POST** /api/v3/organizations/{organisation}/ai/image-generation | Generate images with Amazon Nova Canvas
*AIInferenceApi* | [**submit_tool_callback**](docs/AIInferenceApi.md#submit_tool_callback) | **POST** /api/v3/organizations/{organisation}/ai/chat/callback | Submit Client Tool Results (Callback)
*AIModelsApi* | [**get_ai_model**](docs/AIModelsApi.md#get_ai_model) | **GET** /api/v3/organizations/{organisation}/ai/models/{modelId} | Get AI Model Details
*AIModelsApi* | [**list_ai_models**](docs/AIModelsApi.md#list_ai_models) | **GET** /api/v3/organizations/{organisation}/ai/models | List available AI models for an organization
*AIMonitoringApi* | [**get_ai_usage_stats**](docs/AIMonitoringApi.md#get_ai_usage_stats) | **GET** /api/v3/organizations/{organisation}/ai/usage | Get AI usage statistics
Expand All @@ -118,6 +124,13 @@ Class | Method | HTTP request | Description
*AISessionsApi* | [**get_ai_session**](docs/AISessionsApi.md#get_ai_session) | **GET** /api/v3/organizations/{organisation}/ai/sessions/{sessionId} | Get a specific chat session
*AISessionsApi* | [**list_ai_sessions**](docs/AISessionsApi.md#list_ai_sessions) | **GET** /api/v3/organizations/{organisation}/ai/sessions | List chat sessions with multi-tenant filtering
*AISessionsApi* | [**update_ai_session**](docs/AISessionsApi.md#update_ai_session) | **PUT** /api/v3/organizations/{organisation}/ai/sessions/{sessionId} | Update Session
*AITaskManagementApi* | [**create_task**](docs/AITaskManagementApi.md#create_task) | **POST** /api/v3/organizations/{organisation}/ai/tasks | Create a new task
*AITaskManagementApi* | [**delete_task**](docs/AITaskManagementApi.md#delete_task) | **DELETE** /api/v3/organizations/{organisation}/ai/tasks/{taskId} | Delete a task
*AITaskManagementApi* | [**get_dependency_graph**](docs/AITaskManagementApi.md#get_dependency_graph) | **GET** /api/v3/organizations/{organisation}/ai/tasks/{taskListId}/dependency-graph | Get dependency graph for a task list
*AITaskManagementApi* | [**get_task**](docs/AITaskManagementApi.md#get_task) | **GET** /api/v3/organizations/{organisation}/ai/tasks/{taskId} | Get task details
*AITaskManagementApi* | [**list_tasks**](docs/AITaskManagementApi.md#list_tasks) | **GET** /api/v3/organizations/{organisation}/ai/tasks | List tasks with optional filtering
*AITaskManagementApi* | [**update_task**](docs/AITaskManagementApi.md#update_task) | **PUT** /api/v3/organizations/{organisation}/ai/tasks/{taskId} | Update a task
*AIToolsApi* | [**get_ai_orchestration_status**](docs/AIToolsApi.md#get_ai_orchestration_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/orchestrations/{orchestrationId} | Get Orchestration Status
*AIToolsApi* | [**get_ai_tool_execution_status**](docs/AIToolsApi.md#get_ai_tool_execution_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/executions/{executionId} | Get async tool execution status and result
*AIToolsApi* | [**list_ai_tool_executions**](docs/AIToolsApi.md#list_ai_tool_executions) | **GET** /api/v3/organizations/{organisation}/ai/tools/executions | List tool executions for monitoring and debugging
*AIToolsApi* | [**list_ai_tool_names**](docs/AIToolsApi.md#list_ai_tool_names) | **GET** /api/v3/organizations/{organisation}/ai/tools/names | List tool names only (lightweight response)
Expand Down Expand Up @@ -192,6 +205,7 @@ Class | Method | HTTP request | Description
*KVApi* | [**k_v_items_update**](docs/KVApi.md#k_v_items_update) | **PUT** /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key} | Update an item in a kv store
*KVApi* | [**k_v_list**](docs/KVApi.md#k_v_list) | **GET** /api/v2/organizations/{organization}/projects/{project}/kv | List key-value stores
*KVApi* | [**k_v_show**](docs/KVApi.md#k_v_show) | **GET** /api/v2/organizations/{organization}/projects/{project}/kv/{store_id} | Get a kv store
*OrchestrationApi* | [**get_ai_orchestration_status**](docs/OrchestrationApi.md#get_ai_orchestration_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/orchestrations/{orchestrationId} | Get Orchestration Status
*OrganizationsApi* | [**organizations_list**](docs/OrganizationsApi.md#organizations_list) | **GET** /api/v2/organizations | Retrieve all organizations
*OrganizationsApi* | [**organizations_read**](docs/OrganizationsApi.md#organizations_read) | **GET** /api/v2/organizations/{organization} | Get details of a single organization
*ProjectsApi* | [**projects_create**](docs/ProjectsApi.md#projects_create) | **POST** /api/v2/organizations/{organization}/projects | Create a new project
Expand Down Expand Up @@ -276,6 +290,7 @@ Class | Method | HTTP request | Description
- [ChatInference200ResponseResponseToolUseOneOf1Inner](docs/ChatInference200ResponseResponseToolUseOneOf1Inner.md)
- [ChatInference200ResponseResponseToolUseOneOfResult](docs/ChatInference200ResponseResponseToolUseOneOfResult.md)
- [ChatInference200ResponseUsage](docs/ChatInference200ResponseUsage.md)
- [ChatInference202Response](docs/ChatInference202Response.md)
- [ChatInferenceRequest](docs/ChatInferenceRequest.md)
- [ChatInferenceRequestMessagesInner](docs/ChatInferenceRequestMessagesInner.md)
- [ChatInferenceRequestMessagesInnerContent](docs/ChatInferenceRequestMessagesInnerContent.md)
Expand All @@ -301,6 +316,7 @@ Class | Method | HTTP request | Description
- [ChatWithAIAgent200Response](docs/ChatWithAIAgent200Response.md)
- [ChatWithAIAgent200ResponseResponse](docs/ChatWithAIAgent200ResponseResponse.md)
- [ChatWithAIAgent200ResponseResponseUsage](docs/ChatWithAIAgent200ResponseResponseUsage.md)
- [ChatWithAIAgent202Response](docs/ChatWithAIAgent202Response.md)
- [ChatWithAIAgentRequest](docs/ChatWithAIAgentRequest.md)
- [Command](docs/Command.md)
- [Compose](docs/Compose.md)
Expand Down Expand Up @@ -333,6 +349,8 @@ Class | Method | HTTP request | Description
- [CreateEnvironment403Response](docs/CreateEnvironment403Response.md)
- [CreateEnvironmentRequest](docs/CreateEnvironmentRequest.md)
- [CreateEnvironmentRequestEnvironmentInner](docs/CreateEnvironmentRequestEnvironmentInner.md)
- [CreateTask201Response](docs/CreateTask201Response.md)
- [CreateTaskRequest](docs/CreateTaskRequest.md)
- [CreateVectorCollection201Response](docs/CreateVectorCollection201Response.md)
- [CreateVectorCollection201ResponseCollection](docs/CreateVectorCollection201ResponseCollection.md)
- [CreateVectorCollectionRequest](docs/CreateVectorCollectionRequest.md)
Expand All @@ -343,6 +361,9 @@ Class | Method | HTTP request | Description
- [DeleteAISession200Response](docs/DeleteAISession200Response.md)
- [DeleteBackup200Response](docs/DeleteBackup200Response.md)
- [DeleteCustomTool200Response](docs/DeleteCustomTool200Response.md)
- [DeleteFile200Response](docs/DeleteFile200Response.md)
- [DeleteTask200Response](docs/DeleteTask200Response.md)
- [DeleteTask409Response](docs/DeleteTask409Response.md)
- [DeleteVectorCollection200Response](docs/DeleteVectorCollection200Response.md)
- [DownloadBackup200Response](docs/DownloadBackup200Response.md)
- [Embeddings200Response](docs/Embeddings200Response.md)
Expand All @@ -361,17 +382,29 @@ Class | Method | HTTP request | Description
- [GetAIModel200ResponseCapabilities](docs/GetAIModel200ResponseCapabilities.md)
- [GetAIModel200ResponsePricing](docs/GetAIModel200ResponsePricing.md)
- [GetAIModel404Response](docs/GetAIModel404Response.md)
- [GetAIOrchestrationStatus200Response](docs/GetAIOrchestrationStatus200Response.md)
- [GetAIOrchestrationStatus200ResponseToolsInner](docs/GetAIOrchestrationStatus200ResponseToolsInner.md)
- [GetAIOrchestrationStatus404Response](docs/GetAIOrchestrationStatus404Response.md)
- [GetAISession200Response](docs/GetAISession200Response.md)
- [GetAIToolExecutionStatus200Response](docs/GetAIToolExecutionStatus200Response.md)
- [GetAIToolExecutionStatus200ResponseResult](docs/GetAIToolExecutionStatus200ResponseResult.md)
- [GetAIToolExecutionStatus404Response](docs/GetAIToolExecutionStatus404Response.md)
- [GetAIUsageStats200Response](docs/GetAIUsageStats200Response.md)
- [GetAIUsageStats200ResponseByModelValue](docs/GetAIUsageStats200ResponseByModelValue.md)
- [GetDependencyGraph200Response](docs/GetDependencyGraph200Response.md)
- [GetDurableExecutionStatus200Response](docs/GetDurableExecutionStatus200Response.md)
- [GetDurableExecutionStatus200ResponseError](docs/GetDurableExecutionStatus200ResponseError.md)
- [GetDurableExecutionStatus200ResponsePendingToolsInner](docs/GetDurableExecutionStatus200ResponsePendingToolsInner.md)
- [GetDurableExecutionStatus200ResponseResult](docs/GetDurableExecutionStatus200ResponseResult.md)
- [GetDurableExecutionStatus200ResponseResultResponse](docs/GetDurableExecutionStatus200ResponseResultResponse.md)
- [GetDurableExecutionStatus200ResponseResultUsage](docs/GetDurableExecutionStatus200ResponseResultUsage.md)
- [GetEcrLoginCredentials200Response](docs/GetEcrLoginCredentials200Response.md)
- [GetEnvironmentLogs200Response](docs/GetEnvironmentLogs200Response.md)
- [GetEnvironmentLogs200ResponseLogEventsInner](docs/GetEnvironmentLogs200ResponseLogEventsInner.md)
- [GetFile200Response](docs/GetFile200Response.md)
- [GetSshAccessCredentials200Response](docs/GetSshAccessCredentials200Response.md)
- [GetSshAccessCredentials200ResponseCredentials](docs/GetSshAccessCredentials200ResponseCredentials.md)
- [GetTask200Response](docs/GetTask200Response.md)
- [GetVectorCollection200Response](docs/GetVectorCollection200Response.md)
- [GetVectorCollection200ResponseCollection](docs/GetVectorCollection200ResponseCollection.md)
- [ImageGeneration200Response](docs/ImageGeneration200Response.md)
Expand Down Expand Up @@ -405,6 +438,10 @@ Class | Method | HTTP request | Description
- [ListBackups422Response](docs/ListBackups422Response.md)
- [ListCustomTools200Response](docs/ListCustomTools200Response.md)
- [ListCustomTools200ResponseToolsInner](docs/ListCustomTools200ResponseToolsInner.md)
- [ListFiles200Response](docs/ListFiles200Response.md)
- [ListFiles200ResponseFilesInner](docs/ListFiles200ResponseFilesInner.md)
- [ListTasks200Response](docs/ListTasks200Response.md)
- [ListTasks200ResponseTasksInner](docs/ListTasks200ResponseTasksInner.md)
- [ListVectorCollections200Response](docs/ListVectorCollections200Response.md)
- [ListVectorCollections200ResponseCollectionsInner](docs/ListVectorCollections200ResponseCollectionsInner.md)
- [OrganizationsList200ResponseInner](docs/OrganizationsList200ResponseInner.md)
Expand All @@ -415,11 +452,15 @@ Class | Method | HTTP request | Description
- [PatchEnvironmentComposeRequestSpotConfiguration](docs/PatchEnvironmentComposeRequestSpotConfiguration.md)
- [PurgeCreateRequest](docs/PurgeCreateRequest.md)
- [QueryVectorCollection200Response](docs/QueryVectorCollection200Response.md)
- [QueryVectorCollection200ResponsePagination](docs/QueryVectorCollection200ResponsePagination.md)
- [QueryVectorCollection200ResponseResultsInner](docs/QueryVectorCollection200ResponseResultsInner.md)
- [QueryVectorCollection200ResponseResultsInnerMetadata](docs/QueryVectorCollection200ResponseResultsInnerMetadata.md)
- [QueryVectorCollectionRequest](docs/QueryVectorCollectionRequest.md)
- [QueryVectorCollectionRequestFilter](docs/QueryVectorCollectionRequestFilter.md)
- [ScalingPolicy](docs/ScalingPolicy.md)
- [SpotConfiguration](docs/SpotConfiguration.md)
- [SubmitToolCallback200Response](docs/SubmitToolCallback200Response.md)
- [SubmitToolCallbackRequest](docs/SubmitToolCallbackRequest.md)
- [SubmitToolCallbackRequestToolResultsInner](docs/SubmitToolCallbackRequestToolResultsInner.md)
- [SyncOperation](docs/SyncOperation.md)
- [SyncToEnvironmentRequest](docs/SyncToEnvironmentRequest.md)
- [UpdateAIAgent200Response](docs/UpdateAIAgent200Response.md)
Expand All @@ -431,6 +472,10 @@ Class | Method | HTTP request | Description
- [UpdateEnvironmentRequest](docs/UpdateEnvironmentRequest.md)
- [UpdateEnvironmentStateRequest](docs/UpdateEnvironmentStateRequest.md)
- [UpdateEnvironmentVariableRequest](docs/UpdateEnvironmentVariableRequest.md)
- [UpdateTask200Response](docs/UpdateTask200Response.md)
- [UpdateTaskRequest](docs/UpdateTaskRequest.md)
- [UploadFile201Response](docs/UploadFile201Response.md)
- [UploadFileRequest](docs/UploadFileRequest.md)
- [UploadVectorDocuments200Response](docs/UploadVectorDocuments200Response.md)
- [UploadVectorDocumentsRequest](docs/UploadVectorDocumentsRequest.md)
- [UploadVectorDocumentsRequestDocumentsInner](docs/UploadVectorDocumentsRequestDocumentsInner.md)
Expand Down
19 changes: 17 additions & 2 deletions docs/AIAgentsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,27 @@ Initiates a chat session with a specific AI agent. The agent's configuration (sy
* - **Multi-turn Conversations**: Full conversation history maintained server-side
* - Agent's system prompt is prepended to conversation
* - Only agent's allowed tools are available
* - All tools are auto-executed (no client confirmation)
* - All tools are auto-executed on cloud (no client confirmation needed)
* - Temperature and model from agent config
* - Supports sync, streaming, and async modes
*
* **Execution Modes:**
* - **Sync Mode** (default): Standard JSON response, waits for completion
* - **Streaming Mode**: Set `stream: true` for SSE token-by-token responses
* - **Async Mode**: Set `async: true` for long-running tasks with polling
*
* **Async/Durable Mode (`async: true`):**
* - Returns immediately with `requestId` and `pollUrl` (HTTP 202)
* - Uses AWS Lambda Durable Functions for long-running agent tasks
* - All tools are auto-executed on cloud (no `waiting_callback` state)
* - Poll `/ai/chat/executions/{requestId}` for status
* - Ideal for agents with slow tools (image generation, web search, etc.)
*
* **Session Support:**
* - Omit `sessionId` to create a new session automatically
* - Include `sessionId` to continue an existing conversation
* - Sessions expire after 60 minutes of inactivity
* - Sessions work in all modes (sync, streaming, async)
* - Use `/sessions/{sessionId}` to retrieve full conversation history

### Example
Expand Down Expand Up @@ -105,7 +119,8 @@ Name | Type | Description | Notes

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Agent response generated successfully | - |
**200** | Agent response generated successfully (sync mode) | - |
**202** | Async execution started (when `async: true` in request) | - |
**400** | Invalid request parameters | - |
**403** | Access denied | - |
**404** | Agent not found | - |
Expand Down
Loading