### GET /marketplace/v1/Library/models Source: https://api.airia.ai/docs Fetches available AI models from the marketplace library. ```APIDOC ## GET /marketplace/v1/Library/models ### Description Retrieves a list of available AI models from the marketplace library. ### Method GET ### Endpoint /marketplace/v1/Library/models ### Parameters None ### Request Example GET /marketplace/v1/Library/models ### Response #### Success Response (200) - **models** (array) - List of available models #### Response Example { "models": [ { "id": "gpt-4", "provider": "openai" } ] } ``` -------------------------------- ### GET /v1/governance/workflows Source: https://api.airia.ai/docs Retrieves all active governance workflows. ```APIDOC ## GET /v1/governance/workflows ### Description Fetches a list of all governance workflows configured in the system. ### Method GET ### Endpoint /v1/governance/workflows ### Response #### Success Response (200) - **workflows** (array) - List of workflow definitions. #### Response Example { "workflows": [] } ``` -------------------------------- ### GET /v1/Experiences/{id} Source: https://api.airia.ai/docs Retrieves details for a specific AI experience instance. ```APIDOC ## GET /v1/Experiences/{id} ### Description Fetches the configuration and metadata for a specific experience by its ID. ### Method GET ### Endpoint /v1/Experiences/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the experience. ### Response #### Success Response (200) - **id** (string) - Experience ID - **name** (string) - Name of the experience #### Response Example { "id": "exp_001", "name": "Customer Support Bot" } ``` -------------------------------- ### GET /v1/governance/usecases Source: https://api.airia.ai/docs Retrieves a list of all defined use cases within the governance module. ```APIDOC ## GET /v1/governance/usecases ### Description Retrieves a collection of all use cases managed under the governance framework. ### Method GET ### Endpoint /v1/governance/usecases ### Parameters None ### Request Example GET /v1/governance/usecases ### Response #### Success Response (200) - **usecases** (array) - List of use case objects #### Response Example { "usecases": [ { "id": "uc-123", "name": "Customer Support Bot" } ] } ``` -------------------------------- ### GET /v1/GatewayUsage/project/{projectId} Source: https://api.airia.ai/docs Retrieves usage statistics for a specific project. ```APIDOC ## GET /v1/GatewayUsage/project/{projectId} ### Description Returns detailed gateway usage metrics for the specified project. ### Method GET ### Endpoint /v1/GatewayUsage/project/{projectId} ### Parameters #### Path Parameters - **projectId** (string) - Required - The ID of the project to query. ### Response #### Success Response (200) - **usage** (object) - Usage data metrics. #### Response Example { "projectId": "proj_99", "totalRequests": 1500 } ``` -------------------------------- ### GET /v1/AgentCard Source: https://api.airia.ai/docs Retrieves a paginated list of agent cards for the current tenant. ```APIDOC ## GET /v1/AgentCard ### Description Retrieves a paginated list of agent cards for the current tenant. ### Method GET ### Endpoint /v1/AgentCard ### Query Parameters - **PageNumber** (integer) - Optional - The page number to retrieve. - **PageSize** (integer) - Optional - The number of items per page. - **SortBy** (string) - Optional - The field to sort by. - **SortDirection** (string) - Optional - The direction of sorting (e.g., 'asc', 'desc'). - **Filter** (string) - Optional - Filters the results based on a query. - **projectId** (string) - Optional - The ID of the project to filter by. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **agentCards** (array) - A list of agent cards. - **id** (string) - The ID of the agent card. - **name** (string) - The name of the agent card. - **status** (string) - The status of the agent card. #### Response Example ```json { "agentCards": [ { "id": "agent-123", "name": "Example Agent", "status": "active" } ], "totalCount": 10 } ``` ``` -------------------------------- ### Retrieve Agent Card via C# HttpClient Source: https://api.airia.ai/docs Demonstrates how to fetch an agent card by its GUID using the C# HttpClient. This request requires the agentCardId path parameter and returns a paginated collection of agent card items. ```C# using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://api.airia.ai/v1/AgentCard/{agentCardId}"); using var response = await client.SendAsync(request); ``` -------------------------------- ### GET /v1/AiAssets Source: https://api.airia.ai/docs Retrieve a list of AI assets or specific assets by ID or internal identifier. ```APIDOC ## GET /v1/AiAssets ### Description Retrieves a collection of AI assets available in the system. ### Method GET ### Endpoint /v1/AiAssets ### Response #### Success Response (200) - **assets** (array) - List of AI asset objects #### Response Example { "assets": [] } ``` -------------------------------- ### ToolEfficiency API Source: https://api.airia.ai/docs Operations for retrieving tool efficiency data, including dashboard information and tool response examples. ```APIDOC ## ToolEfficiency Operations ### GET /v1/ToolEfficiency/dashboard **Description**: Retrieves the tool efficiency dashboard data. ### GET /v1/ToolEfficiency/tool-response-example/{toolName} **Description**: Retrieves an example response for a specific tool. ``` -------------------------------- ### Retrieve Paginated Agent Cards using C# HttpClient Source: https://api.airia.ai/docs Fetches a paginated list of agent cards from the Airia API. This request uses the GET method and returns a collection of agent card objects. ```C# using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://api.airia.ai/v1/AgentCard"); using var response = await client.SendAsync(request); ``` -------------------------------- ### GET /v1/AgentCard Source: https://api.airia.ai/docs Retrieves a paginated list of agent cards for the current tenant, with options for filtering and sorting. ```APIDOC ## GET /v1/AgentCard ### Description Retrieves a paginated list of agent cards for the current tenant. ### Method GET ### Endpoint https://api.airia.ai/v1/AgentCard ### Parameters #### Query Parameters - **PageNumber** (integer) - Optional - Gets or sets the page number to be fetched. - **PageSize** (integer) - Optional - Gets or sets the number of items per page. - **SortBy** (string) - Optional - Property to sort by. - **SortDirection** (string) - Optional - Direction of the sort (ASC/DESC). - **Filter** (string) - Optional - Search filter. - **projectId** (string) - Optional - The project identifier (GUID). ### Request Example ```csharp using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://api.airia.ai/v1/AgentCard"); using var response = await client.SendAsync(request); ``` ### Response #### Success Response (200) - **Array** (object[]) - A paginated collection of agent card list items. #### Response Example ```json [ { "projectId": "string", "name": "Recipe Agent.", "description": "Agent that helps users with recipes and cooking.", "agentCardId": "string" } ] ``` ``` -------------------------------- ### Tutorials API Source: https://api.airia.ai/docs Operations for retrieving metadata related to tutorials, specifically for Vimeo videos. ```APIDOC ## Tutorials Operations ### GET /v1/Tutorials/vimeo/{videoId}/metadata **Description**: Retrieves metadata for a Vimeo tutorial video. ### POST /v1/Tutorials/vimeo/metadata **Description**: Creates or updates metadata for a Vimeo tutorial video. ``` -------------------------------- ### POST /v1/EnterpriseSearchSeeding/start Source: https://api.airia.ai/docs Initiates the seeding process for enterprise search integration. ```APIDOC ## POST /v1/EnterpriseSearchSeeding/start ### Description Starts the enterprise search seeding operation to index data sources. ### Method POST ### Endpoint /v1/EnterpriseSearchSeeding/start ### Request Body - **config** (object) - Required - Configuration parameters for the seeding process. ### Request Example { "source_id": "data-source-123" } ### Response #### Success Response (200) - **jobId** (string) - The unique identifier for the started seeding job. #### Response Example { "jobId": "job_abc123" } ``` -------------------------------- ### Configurations API Source: https://api.airia.ai/docs Endpoints for retrieving various system configurations and supported types. ```APIDOC ## GET /v1/Configurations/AIGateway ### Description Retrieves the configuration for the AI Gateway. ### Method GET ### Endpoint /v1/Configurations/AIGateway ### Response #### Success Response (200) - **config** (object) - The AI Gateway configuration details. #### Response Example ```json { "config": { "endpoint": "https://ai.example.com/v1", "apiKey": "***" } } ``` ## GET /v1/Configurations/SupportedVectorDbTypes ### Description Retrieves a list of supported vector database types. ### Method GET ### Endpoint /v1/Configurations/SupportedVectorDbTypes ### Response #### Success Response (200) - **types** (array) - A list of supported vector database type names. #### Response Example ```json { "types": ["pinecone", "weaviate", "chroma"] } ``` ## GET /v1/Configurations/SupportedEmbeddingConfigurations ### Description Retrieves available embedding model configurations. ### Method GET ### Endpoint /v1/Configurations/SupportedEmbeddingConfigurations ### Response #### Success Response (200) - **configurations** (array) - A list of supported embedding configurations. #### Response Example ```json { "configurations": [ { "name": "text-embedding-ada-002", "dimensions": 1536 } ] } ``` ## GET /v1/Configurations/OAuthCallbackUrl ### Description Retrieves the configured OAuth callback URL. ### Method GET ### Endpoint /v1/Configurations/OAuthCallbackUrl ### Response #### Success Response (200) - **url** (string) - The OAuth callback URL. #### Response Example ```json { "url": "https://app.example.com/oauth/callback" } ``` ## GET /v1/Configurations/AWSConfiguration ### Description Retrieves the AWS integration configuration. ### Method GET ### Endpoint /v1/Configurations/AWSConfiguration ### Response #### Success Response (200) - **config** (object) - The AWS configuration details. #### Response Example ```json { "config": { "region": "us-east-1", "bucketName": "my-aws-bucket" } } ``` ## GET /v1/Configurations/SasExpiry ### Description Retrieves the SAS (Shared Access Signature) token expiry configuration. ### Method GET ### Endpoint /v1/Configurations/SasExpiry ### Response #### Success Response (200) - **expiryHours** (integer) - The default expiry time in hours for SAS tokens. #### Response Example ```json { "expiryHours": 24 } ``` ``` -------------------------------- ### GET /v1/AgentCard/{agentCardId} Source: https://api.airia.ai/docs Retrieves a specific agent card by its unique identifier. ```APIDOC ## GET /v1/AgentCard/{agentCardId} ### Description Retrieves an agent card by its identifier. Returns a paginated collection of agent card list items. ### Method GET ### Endpoint /v1/AgentCard/{agentCardId} ### Parameters #### Path Parameters - **agentCardId** (string/guid) - Required - The agent card identifier. ### Request Example ``` GET https://api.airia.ai/v1/AgentCard/{agentCardId} ``` ### Response #### Success Response (200) - **agentCard** (object) - The agent card details. #### Response Example { "projectId": "string", "name": "Recipe Agent.", "description": "Agent that helps users with recipes and cooking.", "version": "1.0.0" } ``` -------------------------------- ### POST /v1/ChatSpaces/CreateSpace Source: https://api.airia.ai/docs Create a new chat space for collaborative interactions. ```APIDOC ## POST /v1/ChatSpaces/CreateSpace ### Description Initializes a new chat space within the platform. ### Method POST ### Endpoint /v1/ChatSpaces/CreateSpace ### Request Body - **name** (string) - Required - Name of the chat space ### Response #### Success Response (200) - **id** (string) - The unique identifier of the created space #### Response Example { "id": "space-123" } ``` -------------------------------- ### GET /v1/governance/agents/{agentId}/assessments Source: https://api.airia.ai/docs Retrieves a list of assessments associated with a specific AI agent. ```APIDOC ## GET /v1/governance/agents/{agentId}/assessments ### Description Retrieves all assessment records for a given agent ID to monitor compliance and performance. ### Method GET ### Endpoint /v1/governance/agents/{agentId}/assessments ### Parameters #### Path Parameters - **agentId** (string) - Required - The unique identifier of the agent. ### Response #### Success Response (200) - **assessments** (array) - List of assessment objects. #### Response Example { "assessments": [] } ``` -------------------------------- ### UserPrompts API Source: https://api.airia.ai/docs Operations for managing user prompts, including retrieval, creation, update, and deletion. ```APIDOC ## UserPrompts Operations ### GET /v1/UserPrompts **Description**: Retrieves a list of user prompts. ### POST /v1/UserPrompts **Description**: Creates a new user prompt. ### PUT /v1/UserPrompts **Description**: Updates an existing user prompt. ### GET /v1/UserPrompts/{id} **Description**: Retrieves a specific user prompt by its ID. ### DELETE /v1/UserPrompts/{userPromptId} **Description**: Deletes a specific user prompt by its ID. ``` -------------------------------- ### StepExecution API Source: https://api.airia.ai/docs Operations related to step execution, including initiating execution for a step and retrieving execution contexts. ```APIDOC ## StepExecution Operations ### POST /v1/StepExecution/{stepId} **Description**: Initiates the execution of a specific step. ### GET /v1/StepExecution/contexts/{stepId} **Description**: Retrieves the execution contexts for a specific step. ``` -------------------------------- ### PromptVersion API Source: https://api.airia.ai/docs Operations for managing prompt versions, including creation and updating messages. ```APIDOC ## PromptVersion API ### Description Manages versions of prompts, allowing for the creation of new versions and updating messages within specific versions. ### Endpoints * **POST /v1/PromptVersion** * Description: Creates a new prompt version. * **PATCH /v1/PromptVersion/{promptId}/versions/{promptVersionId}/message** * Description: Updates the message for a specific prompt version. ``` -------------------------------- ### POST /v1/Store/UploadFile Source: https://api.airia.ai/docs Uploads a file to the storage system for processing or retrieval. ```APIDOC ## POST /v1/Store/UploadFile ### Description Uploads a new file to the storage connector. ### Method POST ### Endpoint /v1/Store/UploadFile ### Parameters #### Request Body - **file** (binary) - Required - The file to upload - **projectId** (string) - Required - The target project ID ### Request Example POST /v1/Store/UploadFile Content-Type: multipart/form-data ### Response #### Success Response (200) - **fileId** (string) - The unique identifier for the uploaded file #### Response Example { "fileId": "file-abc-789" } ``` -------------------------------- ### KeycloakWebhook API Source: https://api.airia.ai/docs Webhook for Keycloak events. ```APIDOC ## KeycloakWebhook Operations ### POST /v1/keycloak-webhook **Description**: Handles events from Keycloak. ``` -------------------------------- ### TenantMetrics API Source: https://api.airia.ai/docs Retrieves tenant-specific metrics. ```APIDOC ## TenantMetrics Operations ### GET /v1/TenantMetrics/{tenantId} **Description**: Retrieves metrics for a specific tenant. ``` -------------------------------- ### Prompts API Source: https://api.airia.ai/docs Operations for managing prompts, including retrieval, creation, update, deletion, and fetching references. ```APIDOC ## Prompts API ### Description Provides endpoints for managing prompts, including CRUD operations and retrieving associated references. ### Endpoints * **GET /v1/Prompts** * Description: Retrieves a list of prompts. * **POST /v1/Prompts** * Description: Creates a new prompt. * **GET /v1/Prompts/{id}** * Description: Retrieves a specific prompt by its ID. * **PUT /v1/Prompts/{id}** * Description: Updates a specific prompt by its ID. * **DELETE /v1/Prompts/{id}** * Description: Deletes a specific prompt by its ID. * **GET /v1/Prompts/{id}/references** * Description: Retrieves references for a specific prompt by its ID. ``` -------------------------------- ### POST /v1/AgentCard Source: https://api.airia.ai/docs Creates new agent cards within the platform. ```APIDOC ## POST /v1/AgentCard ### Description Creates new agent cards based on the provided model. ### Method POST ### Endpoint https://api.airia.ai/v1/AgentCard ### Parameters #### Request Body - **AgentCardModel[]** (array) - Required - The agent cards to be created. ### Request Example ```csharp using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://api.airia.ai/v1/AgentCard"); request.Content = new StringContent("[{\"name\": \"Recipe Agent\"}]", System.Text.Encoding.UTF8, "application/json"); using var response = await client.SendAsync(request); ``` ### Response #### Success Response (200) - **Array** (object[]) - A list of creation responses indicating success or failure for each agent card. #### Response Example ```json [ { "success": true, "requestedName": "string", "createdId": "string" } ] ``` ``` -------------------------------- ### Recommendations API Source: https://api.airia.ai/docs Operations for retrieving recommendations and dismissing them. ```APIDOC ## Recommendations API ### Description Manages recommendations, allowing retrieval of recommendations and dismissing specific ones. ### Endpoints * **GET /v1/Recommendations** * Description: Retrieves a list of recommendations. * **POST /v1/Recommendations/{id}/dismiss** * Description: Dismisses a specific recommendation by its ID. ``` -------------------------------- ### Project Operations Source: https://api.airia.ai/docs Endpoints for managing projects. ```APIDOC ## Project Operations ### POST /v1/Project **Description**: Creates a new project. ### GET /v1/Project **Description**: Retrieves a list of projects. ### GET /v1/Project/paginated **Description**: Retrieves a paginated list of projects. ### GET /v1/Project/pinned **Description**: Retrieves a list of pinned projects. ### GET /v1/Project/{id} **Description**: Retrieves a specific project by ID. ### DELETE /v1/Project/{id} **Description**: Deletes a specific project by ID. ### PUT /v1/Project/{id} **Description**: Updates a specific project by ID. ### GET /v1/Project/by-name/{name} **Description**: Retrieves a project by its name. ### GET /v1/Project/bulk **Description**: Retrieves projects in bulk. ### DELETE /v1/Project/{id}/contents **Description**: Deletes the contents of a specific project. ### PUT /v1/Project/resume/{id} **Description**: Resumes a specific project. ### POST /v1/Project/pin/{id} **Description**: Pins a specific project. ### POST /v1/Project/unpin/{id} **Description**: Unpins a specific project. ### GET /v1/Project/{projectId}/admins **Description**: Retrieves the administrators of a specific project. ### GET /v1/Project/exists-by-name **Description**: Checks if a project with a given name exists. ``` -------------------------------- ### Profile Operations Source: https://api.airia.ai/docs Endpoints for managing user profiles. ```APIDOC ## Profile Operations ### GET /v1/Profile **Description**: Retrieves the current user's profile. ### PUT /v1/Profile/{userId} **Description**: Updates a user's profile. ### PATCH /v1/Profile/settings **Description**: Partially updates user profile settings. ``` -------------------------------- ### POST /v1/upload Source: https://api.airia.ai/docs Upload file attachments to the platform for processing. ```APIDOC ## POST /v1/upload ### Description Uploads a file attachment to be associated with system operations. ### Method POST ### Endpoint /v1/upload ### Request Body - **file** (binary) - Required - The file to upload ### Response #### Success Response (200) - **fileId** (string) - Unique identifier for the uploaded file #### Response Example { "fileId": "file-abc-789" } ``` -------------------------------- ### POST /v1/risk-registry Source: https://api.airia.ai/docs Creates a new entry in the risk registry. ```APIDOC ## POST /v1/risk-registry ### Description Registers a new risk entry into the system for tracking and mitigation. ### Method POST ### Endpoint /v1/risk-registry ### Request Body - **riskName** (string) - Required - Name of the risk. - **description** (string) - Optional - Detailed description of the risk. ### Response #### Success Response (200) - **id** (string) - The ID of the created risk entry. #### Response Example { "id": "risk-123" } ``` -------------------------------- ### Pipeline Version Operations Source: https://api.airia.ai/docs Endpoints for managing pipeline versions. ```APIDOC ## PipelineVersion Operations ### POST /v1/PipelineVersion **Description**: Creates a new pipeline version. ### GET /v1/PipelineVersion/{pipelineId}/{versionNumber} **Description**: Retrieves a specific pipeline version. ### PUT /v1/PipelineVersion/{id} **Description**: Updates a specific pipeline version. ### DELETE /v1/PipelineVersion/{id} **Description**: Deletes a specific pipeline version. ### POST /v1/PipelineVersion/{pipelineId}/steps/{stepId}/prompt-segments/agent-specific **Description**: Creates agent-specific prompt segments for a pipeline version step. ### POST /v1/PipelineVersion/{pipelineId}/steps/{stepId}/prompt-segments/{segmentId}/unlink **Description**: Unlinks a prompt segment from a pipeline version step. ``` -------------------------------- ### McpDeployments Operations Source: https://api.airia.ai/docs Endpoints for managing MCP Deployments. ```APIDOC ## McpDeployments Operations ### GET /v1/McpDeployments Retrieves a list of MCP Deployments. ### POST /v1/McpDeployments Creates a new MCP Deployment. ### GET /v1/McpDeployments/{id} Retrieves a specific MCP Deployment by its ID. ### PUT /v1/McpDeployments/{id} Updates a specific MCP Deployment by its ID. ### DELETE /v1/McpDeployments/{id} Deletes a specific MCP Deployment by its ID. ### GET /v1/McpDeployments/{deploymentId}/tools Retrieves tools associated with a specific MCP Deployment. ``` -------------------------------- ### PythonExecution API Source: https://api.airia.ai/docs Endpoints for executing Python scripts and structured Python code. ```APIDOC ## PythonExecution API ### Description Provides endpoints for executing Python code, either as a script or as structured data. ### Endpoints * **POST /python/script/exec** * Description: Executes a Python script. * **POST /python/structured/exec** * Description: Executes structured Python code. ``` -------------------------------- ### Pipeline Import Operations Source: https://api.airia.ai/docs Endpoints for importing pipeline components and definitions. ```APIDOC ## PipelineImport Operations ### POST /v1/PipelineImport **Description**: Imports a pipeline. ### POST /v1/PipelineImport/library **Description**: Imports a pipeline library. ### POST /v1/PipelineImport/definition **Description**: Imports a pipeline definition. ### POST /v1/PipelineImport/definition/preview **Description**: Previews a pipeline definition import. ### PUT /v1/PipelineImport/definition/{agentId} **Description**: Updates a pipeline definition. ### PATCH /v1/PipelineImport/library/{importedAgentId}/step/{stepId}/datasource/{datasourceId} **Description**: Partially updates a datasource within a pipeline library step. ``` -------------------------------- ### WebhookConfiguration API Source: https://api.airia.ai/docs Operations for managing webhook configurations, including retrieval, creation, updates, and deletion. ```APIDOC ## WebhookConfiguration Operations ### GET /v1/WebhookConfiguration/{id} **Description**: Retrieves a specific webhook configuration by its ID. ### PUT /v1/WebhookConfiguration/{id} **Description**: Updates an existing webhook configuration. ### DELETE /v1/WebhookConfiguration/{id} **Description**: Deletes a specific webhook configuration. ### GET /v1/WebhookConfiguration **Description**: Retrieves a list of webhook configurations. ### POST /v1/WebhookConfiguration **Description**: Creates a new webhook configuration. ### GET /v1/WebhookConfiguration/secret **Description**: Retrieves the secret for webhook configurations. ``` -------------------------------- ### Tools Operations Source: https://api.airia.ai/docs Endpoints for managing general tools within the platform. ```APIDOC ## Tools Operations ### POST /v1/Tools Creates a new tool. ### GET /v1/Tools Retrieves a list of tools. ### DELETE /v1/Tools/{id} Deletes a tool by its ID. ### PUT /v1/Tools/{id} Updates a tool by its ID. ### GET /v1/Tools/{toolId} Retrieves a specific tool by its ID. ### GET /v1/Tools/{toolId}/references Retrieves references for a specific tool. ### GET /v1/Tools/limit Retrieves the tool limit. ### GET /v1/Tools/summary Retrieves a summary of tools. ### POST /v1/Tools/testConnection Tests a tool connection. ### GET /v1/Tools/ai-gateway-tools Retrieves AI gateway tools. ``` -------------------------------- ### UserAlertSettings API Source: https://api.airia.ai/docs Operations for managing user alert settings, including retrieval and updates. ```APIDOC ## UserAlertSettings Operations ### GET /v1/UserAlertSettings **Description**: Retrieves user alert settings. ### PUT /v1/UserAlertSettings **Description**: Updates user alert settings. ``` -------------------------------- ### RedTeamingToolAnalysis API Source: https://api.airia.ai/docs Endpoints for analyzing tools used within Red Teaming pipelines. ```APIDOC ## RedTeamingToolAnalysis API ### Description Provides endpoints for analyzing tools within a Red Teaming pipeline, checking for the presence of tools and retrieving attack objectives. ### Endpoints * **GET /v1/RedTeamingToolAnalysis/{pipelineId}/has-tools** * Description: Checks if a pipeline has tools. * **GET /v1/RedTeamingToolAnalysis/{pipelineId}/attack-objectives** * Description: Retrieves attack objectives for a pipeline. ``` -------------------------------- ### TenantImages API Source: https://api.airia.ai/docs Operations for managing tenant images, including uploading, retrieving, and deleting images of different types. ```APIDOC ## TenantImages Operations ### POST /v1/images/{type} **Description**: Uploads a new tenant image of a specified type. ### GET /v1/images/{type}/{id} **Description**: Retrieves a tenant image by its type and ID. ### DELETE /v1/images/{type}/{id} **Description**: Deletes a tenant image by its type and ID. ### GET /v1/images/{id} **Description**: Retrieves a tenant image by its ID. ``` -------------------------------- ### McpServers Operations Source: https://api.airia.ai/docs Endpoints for managing MCP Servers. ```APIDOC ## McpServers Operations ### POST /v1/McpServers/getServerInfo Retrieves server information for MCP Servers. ### DELETE /v1/McpServers/{toolDefinitionId}/headers/{headerKey} Deletes a header for a specific MCP Server tool definition. ``` -------------------------------- ### TextToSpeech API Source: https://api.airia.ai/docs Operations for text-to-speech conversion, including standard conversion and streaming. ```APIDOC ## TextToSpeech Operations ### POST /v1/TextToSpeech **Description**: Converts text to speech. ### POST /v1/TextToSpeech/Stream **Description**: Converts text to speech and streams the audio output. ``` -------------------------------- ### Users API Source: https://api.airia.ai/docs Comprehensive operations for managing users, including retrieval, creation, updates, permissions, roles, and identity management. ```APIDOC ## Users Operations ### GET /v1/Users/{userId}/effective-permissions **Description**: Retrieves the effective permissions for a specific user. ### GET /v1/Users/batch-names **Description**: Retrieves a batch of user names. ### GET /v1/Users/{userId}/conversations **Description**: Retrieves conversations for a specific user. ### DELETE /v1/Users/{userId}/conversations **Description**: Deletes conversations for a specific user. ### POST /v1/Users **Description**: Creates a new user. ### GET /v1/Users **Description**: Retrieves a list of users. ### PUT /v1/Users/{userId} **Description**: Updates a specific user. ### GET /v1/Users/{userId} **Description**: Retrieves a specific user by their ID. ### DELETE /v1/Users/{userId} **Description**: Deletes a specific user. ### POST /v1/Users/{userId}/reinvite **Description**: Reinvites a specific user. ### GET /v1/Users/{userid}/credentials **Description**: Retrieves credentials for a specific user. ### GET /v1/Users/{userid}/federatedIdentities **Description**: Retrieves federated identities for a specific user. ### POST /v1/Users/{userid}/reset-password **Description**: Resets the password for a specific user. ### POST /v1/Users/trigger-password-reset-email **Description**: Triggers a password reset email for users. ### POST /v1/Users/{userId}/groups **Description**: Adds a user to a group. ### DELETE /v1/Users/{userId}/organizations/{organizationId} **Description**: Removes a user from an organization. ### POST /v1/Users/{userId}/roles **Description**: Assigns roles to a user. ### POST /v1/Users/batch **Description**: Performs batch operations on users. ### GET /v1/Users/{userId}/projects **Description**: Retrieves projects associated with a specific user. ### POST /v1/Users/resolve-duplicates **Description**: Resolves duplicate users. ### GET /v1/Users/{userId}/external-identities **Description**: Retrieves external identities for a specific user. ### POST /v1/Users/{userId}/external-identities **Description**: Adds an external identity to a user. ### DELETE /v1/Users/{userId}/external-identities/{identityId} **Description**: Deletes an external identity for a user. ### GET /v2/Users/{userId}/conversations **Description**: Retrieves conversations for a specific user (v2). ``` -------------------------------- ### RedTeamingAttackLibrary API Source: https://api.airia.ai/docs Operations for managing the Red Teaming Attack Library, including retrieval, deletion, and import/validation of libraries and test cases. ```APIDOC ## RedTeamingAttackLibrary API ### Description Manages the Red Teaming Attack Library, providing endpoints for retrieving library details, deleting entries, importing new libraries, validating libraries, and accessing test cases. ### Endpoints * **GET /v1/RedTeamingAttackLibrary** * Description: Retrieves the Red Teaming Attack Library. * **GET /v1/RedTeamingAttackLibrary/{id}** * Description: Retrieves a specific item from the Red Teaming Attack Library by its ID. * **DELETE /v1/RedTeamingAttackLibrary/{id}** * Description: Deletes a specific item from the Red Teaming Attack Library by its ID. * **GET /v1/RedTeamingAttackLibrary/{id}/test-cases** * Description: Retrieves test cases associated with a specific Red Teaming Attack Library item. * **POST /v1/RedTeamingAttackLibrary/import** * Description: Imports a new Red Teaming Attack Library. * **POST /v1/RedTeamingAttackLibrary/validate-libraries** * Description: Validates Red Teaming Attack Libraries. ``` -------------------------------- ### Pipelines Config Operations Source: https://api.airia.ai/docs Endpoints for managing pipeline configurations. ```APIDOC ## PipelinesConfig Operations ### GET /v1/PipelinesConfig **Description**: Retrieves a list of pipeline configurations. ### POST /v1/PipelinesConfig **Description**: Creates a new pipeline configuration. ### GET /v1/PipelinesConfig/batch-names **Description**: Retrieves batch names for pipeline configurations. ### GET /v1/PipelinesConfig/withSchedule **Description**: Retrieves pipeline configurations with schedules. ### GET /v1/PipelinesConfig/summary **Description**: Retrieves a summary of pipeline configurations. ### GET /v1/PipelinesConfig/{id} **Description**: Retrieves a specific pipeline configuration by ID. ### PUT /v1/PipelinesConfig/{id} **Description**: Updates a specific pipeline configuration by ID. ### DELETE /v1/PipelinesConfig/{id} **Description**: Deletes a specific pipeline configuration by ID. ### GET /v1/PipelinesConfig/{pipelineVersionId}/report **Description**: Retrieves a report for a specific pipeline version. ### GET /v1/PipelinesConfig/{id}/integrations **Description**: Retrieves integrations for a specific pipeline configuration. ### GET /v1/PipelinesConfig/{pipelineVersionId}/has-image-support **Description**: Checks if a pipeline version has image support. ### POST /v1/PipelinesConfig/{id}/duplicate **Description**: Duplicates a pipeline configuration. ### POST /v1/PipelinesConfig/validate **Description**: Validates pipeline configurations. ### GET /v1/PipelinesConfig/export/{id} **Description**: Exports a specific pipeline configuration. ### GET /v1/PipelinesConfig/pipeline-limit **Description**: Retrieves the pipeline limit. ### GET /v1/PipelinesConfig/generateForwardingEmail **Description**: Generates a forwarding email for pipeline configurations. ### GET /v1/PipelinesConfig/tags **Description**: Retrieves tags for pipeline configurations. ``` -------------------------------- ### Create New Agent Cards using C# HttpClient Source: https://api.airia.ai/docs Submits a request to create new agent cards by sending a JSON array of AgentCardModel objects via a POST request. ```C# using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://api.airia.ai/v1/AgentCard"); request.Content = new StringContent( """ [ { "projectId": "", "name": "Recipe Agent.", "description": "Agent that helps users with recipes and cooking.", "supportedInterfaces": [], "provider": null, "version": "\"1.0.0\".", "documentationUrl": null, "iconUrl": null, "capabilities": null, "securitySchemes": null, "securityRequirements": [], "signatures": [], "defaultInputModes": [ "" ], "defaultOutputModes": [ "" ], "skills": [] } ] """, System.Text.Encoding.UTF8, "application/json"); using var response = await client.SendAsync(request); ``` -------------------------------- ### ShadowAI Operations Source: https://api.airia.ai/docs Endpoints for managing ShadowAI policies and configurations. ```APIDOC ## ShadowAI Operations ### GET /v1/ShadowAi Retrieves a list of ShadowAI configurations. ### POST /v1/ShadowAi Creates a new ShadowAI configuration. ### DELETE /v1/ShadowAi Deletes a ShadowAI configuration. ### GET /v1/ShadowAi/policy Retrieves the ShadowAI policy. ### GET /v1/ShadowAi/configurations Retrieves a list of ShadowAI configurations. ### POST /v1/ShadowAi/configurations Creates a new ShadowAI configuration. ### GET /v1/ShadowAi/configurations/{id} Retrieves a specific ShadowAI configuration by its ID. ### PUT /v1/ShadowAi/configurations/{id} Updates a specific ShadowAI configuration by its ID. ### DELETE /v1/ShadowAi/configurations/{id} Deletes a specific ShadowAI configuration by its ID. ``` -------------------------------- ### Pipeline Execution Operations Source: https://api.airia.ai/docs Endpoints for managing and monitoring pipeline executions. ```APIDOC ## PipelineExecution Operations ### GET /v1/PipelineExecution/{executionId} **Description**: Retrieves details of a specific pipeline execution. ### GET /v1/PipelineExecution **Description**: Retrieves a list of pipeline executions. ### GET /v1/PipelineExecution/{executionId}/python-inputs **Description**: Retrieves Python inputs for a specific pipeline execution. ### POST /v1/PipelineExecution/{pipelineId} **Description**: Executes a pipeline. ### POST /v2/PipelineExecution/{pipelineId} **Description**: Executes a pipeline with version 2. ### POST /v1/PipelineExecution/Multipart/{pipelineIdentifier} **Description**: Executes a pipeline using multipart upload. ### POST /v2/PipelineExecution/Multipart/{pipelineIdentifier} **Description**: Executes a pipeline using multipart upload with version 2. ### POST /v1/PipelineExecution/batch **Description**: Executes multiple pipelines in a batch. ### POST /v1/PipelineExecution/TemporaryPipeline **Description**: Creates and executes a temporary pipeline. ### POST /v2/PipelineExecution/TemporaryPipeline **Description**: Creates and executes a temporary pipeline with version 2. ### POST /v1/PipelineExecution/TemporaryAssistant **Description**: Creates and executes a temporary assistant pipeline. ### POST /v2/PipelineExecution/TemporaryAssistant **Description**: Creates and executes a temporary assistant pipeline with version 2. ### POST /v2/PipelineExecution/StopStream **Description**: Stops streaming for a pipeline execution. ### POST /v2/PipelineExecution/StopExecution **Description**: Stops a pipeline execution. ### GET /v2/PipelineExecution/ResumeStream/{executionId} **Description**: Resumes streaming for a specific pipeline execution. ``` -------------------------------- ### CommunitySubmission API Source: https://api.airia.ai/docs Endpoints for submitting and reviewing content within the community. ```APIDOC ## POST /v1/CommunitySubmission/submit-to-community ### Description Submits content to the community for sharing. ### Method POST ### Endpoint /v1/CommunitySubmission/submit-to-community ### Parameters #### Request Body - **contentId** (string) - Required - The identifier of the content to submit. - **description** (string) - Optional - A description for the submission. ### Response #### Success Response (200) - **submissionId** (string) - The unique identifier for the submission. - **status** (string) - The status of the submission. #### Response Example ```json { "submissionId": "sub-xyz", "status": "pending_review" } ``` ## POST /v1/CommunitySubmission/submit-to-community-api ### Description Submits content to the community via the API. ### Method POST ### Endpoint /v1/CommunitySubmission/submit-to-community-api ### Parameters #### Request Body - **contentData** (object) - Required - The data of the content to submit. - **metadata** (object) - Optional - Metadata associated with the content. ### Response #### Success Response (200) - **submissionId** (string) - The unique identifier for the submission. - **message** (string) - Confirmation message. #### Response Example ```json { "submissionId": "sub-api-123", "message": "Content submitted successfully for API integration." } ``` ## POST /v1/CommunitySubmission/review-agent ### Description Initiates a review process for an agent within the community submission system. ### Method POST ### Endpoint /v1/CommunitySubmission/review-agent ### Parameters #### Request Body - **agentId** (string) - Required - The identifier of the agent to review. - **reviewDetails** (object) - Optional - Details of the review. ### Response #### Success Response (200) - **reviewId** (string) - The unique identifier for the review. - **status** (string) - The status of the review initiation. #### Response Example ```json { "reviewId": "rev-agent-789", "status": "initiated" } ``` ## POST /v1/CommunitySubmission/review-agent/stream ### Description Initiates a streaming review process for an agent. ### Method POST ### Endpoint /v1/CommunitySubmission/review-agent/stream ### Parameters #### Request Body - **agentId** (string) - Required - The identifier of the agent to review. - **streamConfig** (object) - Optional - Configuration for the streaming review. ### Response #### Success Response (200) - **streamId** (string) - The unique identifier for the streaming review. - **status** (string) - The status of the streaming review initiation. #### Response Example ```json { "streamId": "stream-rev-agent-101", "status": "streaming_initiated" } ``` ``` -------------------------------- ### SqlDocuments API Source: https://api.airia.ai/docs Operations for interacting with SQL documents, including retrieving documents based on data store and connector IDs, and querying documents. ```APIDOC ## SqlDocuments Operations ### GET /v1/SqlDocuments/{dataStoreId}/{dataStoreConnectorId} **Description**: Retrieves SQL documents for a given data store and connector. ### GET /v1/SqlDocuments/{dataStoreId}/{dataStoreConnectorId}/{tableName} **Description**: Retrieves SQL documents for a specific table within a data store and connector. ### POST /v1/SqlDocuments/{dataStoreId}/{dataStoreConnectorId}/query **Description**: Executes a query against SQL documents. ``` -------------------------------- ### Project Graph Operations Source: https://api.airia.ai/docs Endpoints for managing project graphs and their relationships. ```APIDOC ## ProjectGraph Operations ### POST /v1/ProjectGraph **Description**: Creates a new project graph. ### GET /v1/ProjectGraph **Description**: Retrieves a list of project graphs. ### GET /v1/ProjectGraph/{id} **Description**: Retrieves a specific project graph by ID. ### DELETE /v1/ProjectGraph/{id} **Description**: Deletes a specific project graph by ID. ### PUT /v1/ProjectGraph/{id} **Description**: Updates a specific project graph by ID. ### GET /v1/ProjectGraph/{id}/relationships/count **Description**: Retrieves the count of relationships in a project graph. ### GET /v1/ProjectGraph/{id}/nodes/count **Description**: Retrieves the count of nodes in a project graph. ### POST /v1/ProjectGraph/{id}/cypher **Description**: Executes a Cypher query on a project graph. ``` -------------------------------- ### RedTeamingCostEstimation API Source: https://api.airia.ai/docs Endpoints for estimating costs associated with Red Teaming activities. ```APIDOC ## RedTeamingCostEstimation API ### Description Provides endpoints for estimating the costs associated with targeted and goal-based Red Teaming activities. ### Endpoints * **POST /v1/red-teaming/cost-estimation/targeted** * Description: Estimates the cost for a targeted Red Teaming activity. * **POST /v1/red-teaming/cost-estimation/goal-based** * Description: Estimates the cost for a goal-based Red Teaming activity. ``` -------------------------------- ### Tenants API Source: https://api.airia.ai/docs Operations for managing tenants, including retrieval, updates, user roles, and locking/unlocking tenants. ```APIDOC ## Tenants Operations ### GET /v1/Tenants **Description**: Retrieves a list of tenants. ### PUT /v1/Tenants **Description**: Updates tenant information. ### GET /v1/Tenants/{tenantId}/organizations/{organizationId}/UserRoles **Description**: Retrieves user roles for a specific tenant and organization. ### POST /v1/Tenants/lock **Description**: Locks a tenant. ### POST /v1/Tenants/unlock **Description**: Unlocks a tenant. ``` -------------------------------- ### RecallWebhook API Source: https://api.airia.ai/docs Endpoint for handling recall webhooks. ```APIDOC ## RecallWebhook API ### Description Handles incoming recall webhooks. ### Endpoints * **POST /v1/RecallWebhook** * Description: Receives and processes recall webhook events. ``` -------------------------------- ### SecurityCenter API Source: https://api.airia.ai/docs Endpoint for retrieving a summary of the Security Center. ```APIDOC ## SecurityCenter API ### Description Retrieves a summary of the Security Center. ### Endpoints * **GET /v1/SecurityCenter/summary** * Description: Gets the Security Center summary. ``` -------------------------------- ### ServiceDiscovery API Source: https://api.airia.ai/docs Endpoint for retrieving service configuration information. ```APIDOC ## ServiceDiscovery API ### Description Provides an endpoint for discovering service configuration. ### Endpoints * **GET /.well-known/service-configuration** * Description: Retrieves the service configuration. ``` -------------------------------- ### SmartScanTemplate API Source: https://api.airia.ai/docs Operations for managing SmartScan templates and their groups, including retrieval, creation, update, and deletion. ```APIDOC ## SmartScanTemplate Operations ### GET /v1/smart-scan/templates **Description**: Retrieves a list of SmartScan templates. ### POST /v1/smart-scan/templates **Description**: Creates a new SmartScan template. ### GET /v1/smart-scan/templates/{id} **Description**: Retrieves a specific SmartScan template by its ID. ### PUT /v1/smart-scan/templates/{id} **Description**: Updates an existing SmartScan template. ### DELETE /v1/smart-scan/templates/{id} **Description**: Deletes a specific SmartScan template. ### GET /v1/smart-scan/templates/groups **Description**: Retrieves a list of SmartScan template groups. ### POST /v1/smart-scan/templates/groups **Description**: Creates a new SmartScan template group. ### DELETE /v1/smart-scan/templates/groups/{id} **Description**: Deletes a specific SmartScan template group. ```