{ "openapi": "3.1.0", "info": { "title": "Boomi Agent Garden \u2014 Design API", "description": "The Boomi Agent Garden Design API lets you build, configure, and manage AI agents and their tools programmatically. Use it to create agents, attach tools (API, MCP, Hub, Prompt, Integration), manage packages and deployments, and query available runtime environments and data sources.\n\n**Authentication:** every request requires either a Boomi Platform JWT (Bearer token) or a Boomi Platform API Key (HTTP Basic \u2014 username `BOOMI_TOKEN.`, password = token value). See the security schemes below.\n", "contact": { "name": "Customer Support", "url": "https://community.boomi.com/s/support", "email": "support@boomi.com" }, "version": "1.0.0" }, "paths": { "/agents": { "get": { "tags": [ "Agents" ], "summary": "List All Agents", "description": "List all agents with pagination and filtering options.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "list_agents", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "last_updated_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order (default: desc)", "default": "desc", "title": "Sort Order" }, "description": "Sort order (default: desc)" }, { "name": "agent_status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentStatus" }, "description": "Filter by agent status", "title": "Agent Status" }, "description": "Filter by agent status" }, { "name": "favorite", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter by favorite status", "default": false, "title": "Favorite" }, "description": "Filter by favorite status" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in name or objective", "title": "Search Term" }, "description": "Filter by a substring match in name or objective" }, { "name": "has_active_deployments", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter to return only agents with active deployments", "default": false, "title": "Has Active Deployments" }, "description": "Filter to return only agents with active deployments" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_Union_PaginationResponse_AgentSummaryResponse___PaginationResponse_AgentFavoriteResponse___" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Agents" }, "example": { "success": true, "message": "Agents retrieved successfully", "data": { "total_items": 1, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "id": "ddccf1ad-c01f-4d13-b8f2-98730cc204a2", "created_on": "2026-05-22T11:29:55.843727Z", "last_updated_on": "2026-05-22T11:29:55.843727Z", "installed_on": null, "objective": "Order to customer agent", "name": "Enterprise O2C Agent", "profile_picture": null, "is_favorite": false, "tools": [ { "tool_id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "tool_type": "Integration" }, { "tool_id": "ff659ceb-30e7-4ab2-9405-f7ee9b8866e0", "tool_type": "Application" }, { "tool_id": "cb655a19-3b10-4538-894d-789074d4f5d6", "tool_type": "OpenAPI" }, { "tool_id": "46561b17-b801-47f5-8752-c8e43bd881c3", "tool_type": "OpenAPI" }, { "tool_id": "408c1475-db13-4d0a-adab-0c8fcbd22014", "tool_type": "Hub" }, { "tool_id": "1ec0e30d-cf66-4dbf-8c32-7c3b98c2b3a0", "tool_type": "MCP" }, { "tool_id": "54e59137-ecf1-4643-ae45-ee8da3bc0122", "tool_type": "MCP" }, { "tool_id": "51b6bb37-051b-44a8-a0c8-70a59bb5aa50", "tool_type": "OpenAPI" }, { "tool_id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "tool_type": "MCP" }, { "tool_id": "6f27a28c-e7c0-4bc6-8759-02427b2b3604", "tool_type": "MCP" }, { "tool_id": "50a09cb6-e6ba-4e93-b397-0e09c96dfde1", "tool_type": "MCP" } ], "agent_mode": "conversational", "deployment_count": 1, "active_deployment_count": 1, "packages_count": 2 } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Agents" ], "summary": "Create A New Agent", "description": "Create a new agent based on the provided data.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_CREATE`.", "operationId": "create_agent", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentBase-Input" }, "example": { "name": "Enterprise O2C Agent", "objective": "Order to customer agent", "agent_mode": "conversational", "personality_traits": { "voice_tone": "Friendly", "creativity": 50, "decisiveness": 50, "clarity": 50, "confidence": 50, "engagement": 50 }, "tasks": [ { "name": "Create Order", "objective": "Help customers order the desired products.", "instructions": [ "1. Parse shipping_address as JSON with street, city, state, zip, country fields.", "2. Parse items as an array of { product_sku, quantity } objects.", "3. Pass all parameters to the Create_Sales_Order_Process tool.", "4. Return the final result." ], "tools": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "type": "Integration", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Notify Customer", "objective": "For any customer activity send notification to customer.", "instructions": [ "1. Use customer_id as recipient_id.", "2. Extract notification_type: ORDER_CONFIRMATION | ORDER_SHIPPED | ORDER_DELIVERED | PAYMENT_RECEIVED | PAYMENT_FAILED | CREDIT_APPROVED | CREDIT_DENIED | GENERAL", "3. Send an email using the Send Email tool." ], "tools": [ { "id": "ff659ceb-30e7-4ab2-9405-f7ee9b8866e0", "type": "Application", "requires_approval": true, "response_passthrough": false } ] }, { "name": "Customer Details", "objective": "Use this task to check customer identity and details.", "instructions": [ "Use customer_id to fetch details for the Hub tool. Use filters for the API tools." ], "tools": [ { "id": "cb655a19-3b10-4538-894d-789074d4f5d6", "type": "OpenAPI", "requires_approval": false, "response_passthrough": false }, { "id": "46561b17-b801-47f5-8752-c8e43bd881c3", "type": "OpenAPI", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Customer Credit history check", "objective": "Given a customer_id, check customer information and find tax_id, then check credit history.", "instructions": [ "Fetch details from Customer Details task using customer_id.", "Use tax_id to search for customer credit history.", "Return the provided information." ], "tools": [ { "id": "408c1475-db13-4d0a-adab-0c8fcbd22014", "type": "Hub", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Product & Inventory Check", "objective": "Get product information and real-time inventory availability.", "instructions": [], "tools": [ { "id": "1ec0e30d-cf66-4dbf-8c32-7c3b98c2b3a0", "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "54e59137-ecf1-4643-ae45-ee8da3bc0122", "type": "MCP", "requires_approval": false, "response_passthrough": false } ] }, { "name": "External Credit Check", "objective": "Check credit score for customer for big orders.", "instructions": [ "Get bureau details for customer_id, requested_amount, and check_type (FULL | SOFT | QUICK)." ], "tools": [ { "id": "51b6bb37-051b-44a8-a0c8-70a59bb5aa50", "type": "OpenAPI", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Payment Processing", "objective": "Process payments and update finance status.", "instructions": [], "tools": [ { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "6f27a28c-e7c0-4bc6-8759-02427b2b3604", "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "50a09cb6-e6ba-4e93-b397-0e09c96dfde1", "type": "MCP", "requires_approval": false, "response_passthrough": false } ] } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_AgentDetailedResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Agent" }, "example": { "success": true, "message": "Agent created successfully", "data": { "id": "458de744-858e-4d79-ac7e-cd9a2ae9457b", "created_on": "2026-06-01T12:39:18.268682Z", "last_updated_on": "2026-06-01T12:39:18.268682Z", "installed_on": null, "objective": "Order to customer agent", "name": "Enterprise O2C Agent", "personality_traits": { "voice_tone": "Friendly", "creativity": 50, "decisiveness": 50, "clarity": 50, "confidence": 50, "engagement": 50 }, "profile_picture": null, "conversation_starters": [], "tasks": [ { "name": "Create Order", "objective": "Help customers order the desired products.", "instructions": [ "1. Parse shipping_address as JSON with street, city, state, zip, country fields.\n2. Parse items as an array of { product_sku, quantity } objects.\n3. Pass all parameters to the Create_Sales_Order_Process tool.\n4. Return the final result." ], "tools": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "name": null, "type": "Integration", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Notify Customer", "objective": "For any customer activity send notification to customer.", "instructions": [ "1. Use customer_id as recipient_id.\n2. Extract notification_type: ORDER_CONFIRMATION | ORDER_SHIPPED | ORDER_DELIVERED | PAYMENT_RECEIVED | PAYMENT_FAILED | CREDIT_APPROVED | CREDIT_DENIED | GENERAL\n3. Send an email using the Send Email tool." ], "tools": [ { "id": "ff659ceb-30e7-4ab2-9405-f7ee9b8866e0", "name": null, "type": "Application", "requires_approval": true, "response_passthrough": false } ] }, { "name": "Customer Details", "objective": "Use this task to check customer identity and details.", "instructions": [ "Use customer_id to fetch details for the Hub tool. Use filters for the API tools." ], "tools": [ { "id": "cb655a19-3b10-4538-894d-789074d4f5d6", "name": null, "type": "OpenAPI", "requires_approval": false, "response_passthrough": false }, { "id": "46561b17-b801-47f5-8752-c8e43bd881c3", "name": null, "type": "OpenAPI", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Customer Credit history check", "objective": "Given a customer_id, check customer information and find tax_id, then check credit history.", "instructions": [ "Fetch details from Customer Details task using customer_id.\nUse tax_id to search for customer credit history.\nReturn the provided information." ], "tools": [ { "id": "408c1475-db13-4d0a-adab-0c8fcbd22014", "name": null, "type": "Hub", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Product & Inventory Check", "objective": "Get product information and real-time inventory availability.", "instructions": [], "tools": [ { "id": "1ec0e30d-cf66-4dbf-8c32-7c3b98c2b3a0", "name": null, "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "54e59137-ecf1-4643-ae45-ee8da3bc0122", "name": null, "type": "MCP", "requires_approval": false, "response_passthrough": false } ] }, { "name": "External Credit Check", "objective": "Check credit score for customer for big orders.", "instructions": [ "Get bureau details for customer_id, requested_amount, and check_type (FULL | SOFT | QUICK)." ], "tools": [ { "id": "51b6bb37-051b-44a8-a0c8-70a59bb5aa50", "name": null, "type": "OpenAPI", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Payment Processing", "objective": "Process payments and update finance status.", "instructions": [], "tools": [ { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "name": null, "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "6f27a28c-e7c0-4bc6-8759-02427b2b3604", "name": null, "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "50a09cb6-e6ba-4e93-b397-0e09c96dfde1", "name": null, "type": "MCP", "requires_approval": false, "response_passthrough": false } ] } ], "guardrails": null, "agent_mode": "conversational", "inference_configuration": { "performance_config": { "processing_mode": "standard", "rationale": true } }, "is_favorite": false, "deployments": null, "packages_count": 0 } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/agents/{agent_id}": { "get": { "tags": [ "Agents" ], "summary": "Get A Specific Agent By Id", "description": "Retrieve a specific agent by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_agent", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_AgentDetailedResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get Agent" }, "example": { "success": true, "message": "Agent retrieved successfully", "data": { "id": "458de744-858e-4d79-ac7e-cd9a2ae9457b", "created_on": "2026-06-01T12:39:18.268682Z", "last_updated_on": "2026-06-01T12:39:18.268682Z", "installed_on": null, "objective": "Order to customer agent", "name": "Enterprise O2C Agent", "personality_traits": { "voice_tone": "Friendly", "creativity": 50, "decisiveness": 50, "clarity": 50, "confidence": 50, "engagement": 50 }, "profile_picture": null, "conversation_starters": [], "tasks": [ { "name": "Create Order", "objective": "Help customers order the desired products.", "instructions": [ "1. Parse shipping_address as JSON with street, city, state, zip, country fields.\n2. Parse items as an array of { product_sku, quantity } objects.\n3. Pass all parameters to the Create_Sales_Order_Process tool.\n4. Return the final result." ], "tools": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "name": null, "type": "Integration", "requires_approval": false, "response_passthrough": false } ] } ], "guardrails": null, "agent_mode": "conversational", "inference_configuration": { "performance_config": { "processing_mode": "standard", "rationale": true } }, "is_favorite": false, "deployments": [ { "deployment_id": "e54b1f0b-aaaa-bbbb-cccc-ddddeeee0003", "environment_id": "e5f6a7b8-aaaa-bbbb-cccc-ddddeeee0004", "deployment_status": "ACTIVE", "deployed_on": "2026-06-01T13:00:00.000000Z" } ], "packages_count": 1 } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Agents" ], "summary": "Update An Existing Agent", "description": "Update an existing agent with the provided data.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_EDIT`.", "operationId": "update_agent", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentUpdate" }, "example": { "name": "Enterprise O2C Agent", "objective": "Order to customer agent", "agent_mode": "conversational", "personality_traits": { "voice_tone": "Friendly", "creativity": 50, "decisiveness": 50, "clarity": 50, "confidence": 50, "engagement": 50 }, "tasks": [ { "name": "Create Order", "objective": "Help customers order the desired products.", "instructions": [ "1. Parse shipping_address as JSON with street, city, state, zip, country fields.", "2. Parse items as an array of { product_sku, quantity } objects.", "3. Pass all parameters to the Create_Sales_Order_Process tool.", "4. Return the final result." ], "tools": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "type": "Integration", "requires_approval": false, "response_passthrough": false } ] } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_AgentDetailedResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update Agent" }, "example": { "success": true, "message": "Agent updated successfully", "data": { "id": "8ff7eb8c-4b35-476c-b8f4-6c4f27878dc3", "created_on": "2026-06-01T09:13:08.008179Z", "last_updated_on": "2026-06-01T12:39:06.942173Z", "installed_on": null, "objective": "Order to customer agent", "name": "Enterprise O2C Agent", "personality_traits": { "voice_tone": "Friendly", "creativity": 50, "decisiveness": 50, "clarity": 50, "confidence": 50, "engagement": 50 }, "profile_picture": null, "conversation_starters": [], "tasks": [ { "name": "Create Order", "objective": "Help customers order the desired products.", "instructions": [ "1. Parse shipping_address as JSON with street, city, state, zip, country fields.\n2. Parse items as an array of { product_sku, quantity } objects.\n3. Pass all parameters to the Create_Sales_Order_Process tool.\n4. Return the final result." ], "tools": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "name": null, "type": "Integration", "requires_approval": false, "response_passthrough": false } ] } ], "agent_mode": "conversational", "inference_configuration": { "performance_config": { "processing_mode": "standard", "rationale": true } }, "is_favorite": false, "deployments": null, "packages_count": 0 } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Agents" ], "summary": "Delete An Existing Agent", "description": "Perform a soft delete on an agent by updating its status to DELETED.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_agent", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_Agent_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Agent" }, "example": { "success": true, "message": "Agent deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/agents/{agent_id}/packages": { "get": { "tags": [ "Agents" ], "summary": "List Packages For An Agent", "description": "Retrieve all the packages for a given agent ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "list_agent_packages", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "has_active_deployments", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter to return only packages with active deployments", "default": false, "title": "Has Active Deployments" }, "description": "Filter to return only packages with active deployments" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "created_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order (default: desc)", "default": "desc", "title": "Sort Order" }, "description": "Sort order (default: desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_PackageSummaryResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Agent Packages" }, "example": { "success": true, "message": "Packages for Agent retrieved successfully", "data": { "total_items": 1, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "package_id": "ec504e2b-aaaa-bbbb-cccc-ddddeeee0006", "name": "Enterprise O2C Agent", "version": "1.0", "agent_id": "458de744-858e-4d79-ac7e-cd9a2ae9457b", "deployment_count": 1, "created_on": "2026-06-01T13:00:00.000000Z", "last_updated_on": "2026-06-01T13:00:00.000000Z" } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Agents" ], "summary": "Create An Agent Package", "description": "Create an Agent package given the agent ID. Optionally, the request body may include an environment ID to deploy the package to.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`, `AGENT_CREATE`.", "operationId": "create_agent_package", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageDeployBody" }, "example": { "deploy_to_environment_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_Union_PackageResponse__DeploymentResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Agent Package" }, "example": { "success": true, "message": "Package created successfully", "data": { "package_id": "ec504e2b-dda2-4c6a-902f-78a72d3ab056", "agent_id": "8ff7eb8c-4b35-476c-b8f4-6c4f27878dc3", "version": "1.0", "name": "Enterprise O2C Agent", "snapshot": { "objective": "Order to customer agent", "name": "Enterprise O2C Agent", "personality_traits": { "voice_tone": "Friendly", "creativity": 50, "decisiveness": 50, "clarity": 50, "confidence": 50, "engagement": 50 }, "profile_picture": null, "conversation_starters": [], "tasks": [ { "name": "Create Order", "objective": "Help customers order the desired products.", "instructions": [ "1. Parse shipping_address as JSON with street, city, state, zip, country fields.\n2. Parse items as an array of { product_sku, quantity } objects.\n3. Pass all parameters to the Create_Sales_Order_Process tool.\n4. Return the final result." ], "tools": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "name": "Create_Sales_Order_Process", "type": "Integration", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Notify Customer", "objective": "For any customer activity send notification to customer customer@example.com", "instructions": [ "1. Use customer_id as recipient_id.\n2. Extract notification_type: ORDER_CONFIRMATION | ORDER_SHIPPED | ORDER_DELIVERED | PAYMENT_RECEIVED | PAYMENT_FAILED | CREDIT_APPROVED | CREDIT_DENIED | GENERAL\n3. Send an email to customer@example.com using the Send Email tool." ], "tools": [ { "id": "ff659ceb-30e7-4ab2-9405-f7ee9b8866e0", "name": "Send Email", "type": "Application", "requires_approval": true, "response_passthrough": false } ] }, { "name": "Customer Details", "objective": "Use this task to check customer identity and details.", "instructions": [ "Use customer_id to fetch details for the Hub tool. Use filters for the API tools." ], "tools": [ { "id": "cb655a19-3b10-4538-894d-789074d4f5d6", "name": "O2C Customer filter", "type": "OpenAPI", "requires_approval": false, "response_passthrough": false }, { "id": "46561b17-b801-47f5-8752-c8e43bd881c3", "name": "O2C Customer Search", "type": "OpenAPI", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Customer Credit history check", "objective": "Given a customer_id, check customer information and find tax_id, then check credit history.", "instructions": [ "Fetch details from Customer Details task using customer_id.\nUse tax_id to search for customer credit history.\nReturn the provided information." ], "tools": [ { "id": "408c1475-db13-4d0a-adab-0c8fcbd22014", "name": "Query_Customer_Credit_History", "type": "Hub", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Product & Inventory Check", "objective": "Get product information and real-time inventory availability.", "instructions": [], "tools": [ { "id": "1ec0e30d-cf66-4dbf-8c32-7c3b98c2b3a0", "name": "o2c-mock-server-api-qa--api_getProduct", "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "54e59137-ecf1-4643-ae45-ee8da3bc0122", "name": "o2c-mock-server-api-qa--api_checkProductAvailability", "type": "MCP", "requires_approval": false, "response_passthrough": false } ] }, { "name": "External Credit Check", "objective": "Check credit score for customer for big orders.", "instructions": [ "Get bureau details for customer_id, requested_amount, and check_type (FULL | SOFT | QUICK)." ], "tools": [ { "id": "51b6bb37-051b-44a8-a0c8-70a59bb5aa50", "name": "Perform Credit Check", "type": "OpenAPI", "requires_approval": false, "response_passthrough": false } ] }, { "name": "Payment Processing", "objective": "Process payments and update finance status.", "instructions": [], "tools": [ { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "name": "o2c-mock-server-api-qa--api_processPayment", "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "6f27a28c-e7c0-4bc6-8759-02427b2b3604", "name": "o2c-mock-server-api-qa--api_getPayment", "type": "MCP", "requires_approval": false, "response_passthrough": false }, { "id": "50a09cb6-e6ba-4e93-b397-0e09c96dfde1", "name": "o2c-mock-server-api-qa--api_refundPayment", "type": "MCP", "requires_approval": false, "response_passthrough": false } ] } ], "guardrails": null, "agent_mode": "conversational", "input_schema_id": null, "input_schema_type": null, "input_schema": null, "output_schema_id": null, "output_schema_type": null, "output_schema": null, "inference_configuration": { "performance_config": { "processing_mode": "standard", "rationale": true } }, "tool_definitions": [ { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "created_on": "2026-05-21T11:22:55.107734Z", "last_updated_on": "2026-05-21T12:50:12.824517Z", "installed_on": "2026-05-21T12:50:12.819966Z", "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "environment_id": "", "environment_name": "Environment", "atom_id": "1234", "atom_name": "Atom", "process_id": "1234", "process_name": "Process", "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } }, "tool_status": "ACTIVE", "type": "Integration" }, { "id": "ff659ceb-30e7-4ab2-9405-f7ee9b8866e0", "created_on": "2026-04-28T08:37:24.684234Z", "last_updated_on": "2026-04-28T08:37:24.684234Z", "installed_on": "2026-04-28T08:37:24.684234Z", "name": "gmailsendemail", "description": "Send an email via Gmail", "input_parameters": [ { "name": "to", "description": "The email addresses of who the email is being sent to.", "required": true, "type": "string", "server_default": null, "title": "To", "user_default": null }, { "name": "subject", "description": "", "required": true, "type": "string", "server_default": null, "title": "Subject", "user_default": null }, { "name": "body", "description": "The main content of the email.", "required": true, "type": "string", "server_default": null, "title": "Body", "user_default": null } ], "server_id": "26c6f3d8-8d0f-4af0-8f73-ab0bf8594b92", "fabric_tool_id": "gmail_gmailsendemail_invoke", "tool_function": "invoke", "title": "Send Email", "input_schema": { "type": "object", "required": [ "to", "subject", "body" ], "properties": { "to": { "type": "array", "items": { "type": "string" }, "description": "The email addresses of who the email is being sent to.", "x-fabric-type": "multistring" }, "body": { "type": "string", "default": null, "description": "The main content of the email.", "x-fabric-type": "stringmultiline" }, "subject": { "type": "string", "default": null, "x-fabric-type": "string" } } }, "auth_type": "oauth", "type": "Application" }, { "id": "cb655a19-3b10-4538-894d-789074d4f5d6", "created_on": "2026-05-21T09:25:52.268675Z", "last_updated_on": "2026-05-21T10:55:45.913230Z", "installed_on": "2026-05-21T10:55:45.912061Z", "name": "O2C Customer filter", "description": "Search customers", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "path_parameters": null, "headers": "", "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "ACTIVE", "type": "OpenAPI" }, { "id": "46561b17-b801-47f5-8752-c8e43bd881c3", "created_on": "2026-05-21T09:27:30.577285Z", "last_updated_on": "2026-05-21T10:52:32.670128Z", "installed_on": "2026-05-21T10:52:32.669545Z", "name": "O2C Customer Search", "description": "Search customer based on customer_id", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/{customer_id}", "method": "GET", "query_parameters": null, "path_parameters": [ { "name": "customer_id", "input_parameter_name": "customer_id", "static_value": null } ], "headers": "", "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "ACTIVE", "type": "OpenAPI" }, { "id": "408c1475-db13-4d0a-adab-0c8fcbd22014", "created_on": "2026-05-21T12:45:59.439387Z", "last_updated_on": "2026-05-21T12:52:13.145083Z", "installed_on": "2026-05-21T12:52:13.144106Z", "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ], "repository_id": "05c5ca1e-1d8e-4466-9cb5-c9138fc2b2cf", "repository_name": "Repository", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "universe_name": "Universe", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "unique_id": "TAX_ID", "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING", "repeatable": false } ], "limit": 200, "filter_operator": null, "filter_fields": [], "tool_status": "ACTIVE", "type": "Hub" }, { "id": "1ec0e30d-cf66-4dbf-8c32-7c3b98c2b3a0", "created_on": "2026-05-21T08:53:44.909965Z", "last_updated_on": "2026-05-21T08:53:44.909965Z", "installed_on": "2026-05-21T08:53:44.909965Z", "name": "o2c-mock-server-api-qa--api_getProduct", "description": "Get product by SKU\nRetrieve product details by SKU", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Get product by SKU", "input_schema": { "type": "object", "properties": { "parameters": { "required": [ "product_sku" ], "type": "object", "properties": { "product_sku": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, "description": "Additional parameters needed for this call", "exampleSetFlag": false, "types": [ "object" ] } }, "required": [ "parameters" ] }, "tool_status": "ACTIVE", "type": "MCP" }, { "id": "54e59137-ecf1-4643-ae45-ee8da3bc0122", "created_on": "2026-05-21T08:53:44.922581Z", "last_updated_on": "2026-05-21T08:53:44.922581Z", "installed_on": "2026-05-21T08:53:44.922581Z", "name": "o2c-mock-server-api-qa--api_checkProductAvailability", "description": "Check product availability\nCheck if requested quantity of a product is available in stock", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Check product availability", "input_schema": { "type": "object", "properties": { "content": { "required": [ "product_sku", "quantity" ], "type": "object", "properties": { "product_sku": { "type": "string", "description": "Product SKU to check (e.g. SKU-LAPTOP-001)", "exampleSetFlag": false, "types": [ "string" ] }, "quantity": { "minimum": 1, "type": "integer", "description": "Requested quantity", "exampleSetFlag": false, "types": [ "integer" ] }, "warehouse_region": { "type": "string", "description": "Preferred warehouse region for inventory check", "exampleSetFlag": false, "types": [ "string" ], "enum": [ "US-EAST", "US-WEST", "US-CENTRAL", "EU-WEST", "APAC" ] } }, "exampleSetFlag": false, "types": [ "object" ] } }, "required": [ "content" ] }, "tool_status": "ACTIVE", "type": "MCP" }, { "id": "51b6bb37-051b-44a8-a0c8-70a59bb5aa50", "created_on": "2026-05-21T09:34:44.826140Z", "last_updated_on": "2026-05-21T10:50:25.061912Z", "installed_on": "2026-05-21T10:50:25.060489Z", "name": "Perform Credit Check", "description": "Performs a credit check against an external credit bureau.", "input_parameters": [ { "name": "customer_id", "description": "Unique identifier for the customer undergoing the credit check", "required": false, "type": "string" }, { "name": "requested_amount", "description": "The credit amount being requested, in currency units", "required": false, "type": "integer" }, { "name": "check_type", "description": "FULL (90-day), SOFT (30-day), or QUICK (7-day)", "required": false, "type": "string" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com/qa", "path": "/credit-check", "method": "POST", "query_parameters": null, "path_parameters": null, "headers": "", "authentication": null, "request_body": "", "source_id": null, "source_name": null, "tool_status": "ACTIVE", "type": "OpenAPI" }, { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "created_on": "2026-05-21T08:53:44.925746Z", "last_updated_on": "2026-05-21T08:53:44.925746Z", "installed_on": "2026-05-21T08:53:44.925746Z", "name": "o2c-mock-server-api-qa--api_processPayment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "input_schema": { "type": "object", "properties": { "content": { "required": [ "amount", "order_id" ], "type": "object", "properties": { "order_id": { "type": "string", "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)", "exampleSetFlag": false, "types": [ "string" ] }, "amount": { "type": "number", "description": "Payment amount in USD (e.g. 2130.91)", "exampleSetFlag": false, "types": [ "number" ] }, "payment_method": { "type": "string", "description": "Payment method", "exampleSetFlag": false, "types": [ "string" ], "enum": [ "CREDIT_CARD", "DEBIT_CARD", "ACH", "WIRE", "INVOICE" ] }, "payment_details": { "type": "object", "properties": { "card_number": { "type": "string", "description": "Card number (e.g. 4111111111111234)", "exampleSetFlag": false, "types": [ "string" ] }, "expiry": { "type": "string", "description": "Expiry date MM/YY (e.g. 12/25)", "exampleSetFlag": false, "types": [ "string" ] }, "cvv": { "type": "string", "description": "CVV code (e.g. 123)", "exampleSetFlag": false, "types": [ "string" ] }, "cardholder_name": { "type": "string", "description": "Name on card (e.g. John Smith)", "exampleSetFlag": false, "types": [ "string" ] } }, "description": "Card or bank details", "exampleSetFlag": false, "types": [ "object" ] }, "is_partial": { "type": "boolean", "description": "Whether this is a partial payment", "exampleSetFlag": false, "types": [ "boolean" ] } }, "exampleSetFlag": false, "types": [ "object" ] } }, "required": [ "content" ] }, "tool_status": "ACTIVE", "type": "MCP" }, { "id": "6f27a28c-e7c0-4bc6-8759-02427b2b3604", "created_on": "2026-05-21T08:53:44.928121Z", "last_updated_on": "2026-05-21T08:53:44.928121Z", "installed_on": "2026-05-21T08:53:44.928121Z", "name": "o2c-mock-server-api-qa--api_getPayment", "description": "Get payment by ID\nRetrieve payment details by payment ID", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Get payment by ID", "input_schema": { "type": "object", "properties": { "parameters": { "required": [ "payment_id" ], "type": "object", "properties": { "payment_id": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, "description": "Additional parameters needed for this call", "exampleSetFlag": false, "types": [ "object" ] } }, "required": [ "parameters" ] }, "tool_status": "ACTIVE", "type": "MCP" }, { "id": "50a09cb6-e6ba-4e93-b397-0e09c96dfde1", "created_on": "2026-05-21T08:53:44.929778Z", "last_updated_on": "2026-05-21T08:53:44.929778Z", "installed_on": "2026-05-21T08:53:44.929778Z", "name": "o2c-mock-server-api-qa--api_refundPayment", "description": "Refund a payment\nProcess a full or partial refund for an existing payment", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Refund a payment", "input_schema": { "type": "object", "properties": { "content": { "required": [ "reason" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Refund amount (optional, defaults to full refund)", "exampleSetFlag": false, "types": [ "number" ] }, "reason": { "type": "string", "description": "Reason for refund", "exampleSetFlag": false, "types": [ "string" ], "enum": [ "CUSTOMER_REQUEST", "PRODUCT_DEFECT", "ORDER_CANCELLED", "DUPLICATE_PAYMENT", "OTHER" ] }, "notes": { "type": "string", "description": "Additional refund notes", "exampleSetFlag": false, "types": [ "string" ] } }, "exampleSetFlag": false, "types": [ "object" ] }, "parameters": { "required": [ "payment_id" ], "type": "object", "properties": { "payment_id": { "type": "string", "exampleSetFlag": false, "types": [ "string" ] } }, "description": "Additional parameters needed for this call", "exampleSetFlag": false, "types": [ "object" ] } }, "required": [ "content", "parameters" ] }, "tool_status": "ACTIVE", "type": "MCP" } ], "source_definitions": [ { "id": "26c6f3d8-8d0f-4af0-8f73-ab0bf8594b92", "created_on": "2026-04-28T08:37:24.682277Z", "last_updated_on": "2026-04-28T08:37:24.682277Z", "installed_on": null, "name": "Gmail", "description": "Google's email service", "url": null, "fabric_application_id": "gmail", "application_icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjUyIDQyIDg4IDY2Ij4NCjxwYXRoIGZpbGw9IiM0Mjg1ZjQiIGQ9Ik01OCAxMDhoMTRWNzRMNTIgNTl2NDNjMCAzLjMyIDIuNjkgNiA2IDYiLz4NCjxwYXRoIGZpbGw9IiMzNGE4NTMiIGQ9Ik0xMjAgMTA4aDE0YzMuMzIgMCA2LTIuNjkgNi02VjU5bC0yMCAxNSIvPg0KPHBhdGggZmlsbD0iI2ZiYmMwNCIgZD0iTTEyMCA0OHYyNmwyMC0xNXYtOGMwLTcuNDItOC40Ny0xMS42NS0xNC40LTcuMiIvPg0KPHBhdGggZmlsbD0iI2VhNDMzNSIgZD0iTTcyIDc0VjQ4bDI0IDE4IDI0LTE4djI2TDk2IDkyIi8+DQo8cGF0aCBmaWxsPSIjYzUyMjFmIiBkPSJNNTIgNTF2OGwyMCAxNVY0OGwtNS42LTQuMmMtNS45NC00LjQ1LTE0LjQtLjIyLTE0LjQgNy4yIi8+DQo8L3N2Zz4=", "status": "ACTIVE", "total_tools_count": 3 }, { "id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "created_on": "2026-05-21T08:53:42.285528Z", "last_updated_on": "2026-05-21T08:53:42.285528Z", "installed_on": "2026-05-21T08:53:44.885911Z", "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "title": null, "headers": "", "transport_type": "SSE", "authentication": null, "tools": [], "request_id": null, "status": "ACTIVE" } ] }, "created_on": "2026-06-01T09:19:30.235444Z" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/agents/{agent_id}/packages/{package_id}": { "delete": { "tags": [ "Agents" ], "summary": "Delete A Package By Agent Id And Package Id", "description": "Delete a package given an agent ID and package ID. A package cannot be deleted if it has existing deployments.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_agent_package", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "package_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Package Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PackageResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Agent Package" }, "example": { "success": true, "message": "Package deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/agents/{agent_id}/deployments": { "post": { "tags": [ "Agents" ], "summary": "Create An Agent Deployment", "description": "Create an Agent deployment given the agent ID and environment ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`, `AGENT_CREATE`, `AGENT_INSTALL`.", "operationId": "create_agent_deployment", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentBase" }, "example": { "package_id": "ec504e2b-aaaa-bbbb-cccc-ddddeeee0006", "environment_id": "e5f6a7b8-aaaa-bbbb-cccc-ddddeeee0004" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_DeploymentResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Agent Deployment" }, "example": { "success": true, "message": "Agent Package deployed successfully", "data": { "package_id": "ec504e2b-dda2-4c6a-902f-78a72d3ab056", "environment_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b", "deployment_id": "127c3eb2-24ef-482c-b7cc-8ac66727bc80", "agent_id": "8ff7eb8c-4b35-476c-b8f4-6c4f27878dc3", "deployment_status": "ACTIVE", "deployed_on": "2026-06-01T09:19:43.739975Z", "deployed_by": "", "last_updated_on": "2026-06-01T09:19:43.739975Z", "agent_name": "Enterprise O2C Agent", "agent_mode": "conversational", "origin": null, "is_favorite": false, "profile_picture": null, "package_version": "1.0", "package_name": "Enterprise O2C Agent", "environment_name": "Agent Garden Production", "runtimes": [ { "runtime_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "runtime_name": "USA East Agent Garden Cloud 01", "runtime_region": "US", "endpoint_url": "https://example.ai-agent-garden-runtime.boomi.com" } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/agents/{agent_id}/deployments/{deployment_id}": { "delete": { "tags": [ "Agents" ], "summary": "Delete A Deployment By Agent Id And Deployment Id", "description": "Delete a deployment given an agent ID and deployment ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_agent_deployment", "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Agent Id" } }, { "name": "deployment_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Deployment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_Deployment_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Agent Deployment" }, "example": { "success": true, "message": "Agent Deployment deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools": { "get": { "tags": [ "Tools" ], "summary": "List All Tools", "description": "Retrieve a paginated list of tools with optional filters and sorting.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`, `AGENT_CREATE`.", "operationId": "list_tools", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number", "default": 1, "title": "Page" }, "description": "Page number" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Page size", "default": 100, "title": "Page Size" }, "description": "Page size" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "last_updated_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order", "default": "desc", "title": "Sort Order" }, "description": "Sort order" }, { "name": "tool_type", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolType" }, "description": "Filter by tool type", "title": "Tool Type" }, "description": "Filter by tool type" }, { "name": "tool_status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ToolStatus" }, "description": "Filter by tool status", "title": "Tool Status" }, "description": "Filter by tool status" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in name or description", "title": "Search Term" }, "description": "Filter by a substring match in name or description" }, { "name": "source_id", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filter by source ID", "title": "Source Id" }, "description": "Filter by source ID" }, { "name": "application_name", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "Filter by application name", "title": "Application Name" }, "description": "Filter by application name" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_ToolSummaryResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Tools" }, "example": { "success": true, "message": "Tools retrieved successfully", "data": { "total_items": 59, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "id": "cc154225-1afc-4a99-8d3b-6648e1800650", "created_on": "2026-06-01T09:05:58.983756Z", "last_updated_on": "2026-06-01T09:07:09.130957Z", "installed_on": null, "name": "O2C Customer filter", "description": "Search customers", "type": "OpenAPI", "source_name": null, "tool_status": "DISABLED", "agents_equipped": 0, "application_name": null, "application_icon": null }, { "id": "d80c0d77-6558-4fb7-b821-4a45b051c915", "created_on": "2026-06-01T09:00:28.223236Z", "last_updated_on": "2026-06-01T09:01:24.538061Z", "installed_on": null, "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "type": "Hub", "source_name": null, "tool_status": "DISABLED", "agents_equipped": 0, "application_name": null, "application_icon": null }, { "id": "a62425b6-fa52-4a56-abff-474edd455e46", "created_on": "2026-06-01T08:55:40.217458Z", "last_updated_on": "2026-06-01T08:56:02.414469Z", "installed_on": null, "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "type": "Integration", "source_name": null, "tool_status": "DISABLED", "agents_equipped": 0, "application_name": null, "application_icon": null } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/integration": { "post": { "tags": [ "Tools" ], "summary": "Create A New Integration Tool", "description": "Create a new Integration tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_CREATE`.", "operationId": "create_integration_tool", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationToolBase" }, "example": { "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0", "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20", "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_IntegrationTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Integration Tool" }, "example": { "success": true, "message": "Integration tool created successfully", "data": { "id": "a62425b6-fa52-4a56-abff-474edd455e46", "created_on": "2026-06-01T08:55:40.217458Z", "last_updated_on": "2026-06-01T08:55:40.217458Z", "installed_on": null, "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0", "environment_name": "Environment", "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20", "atom_name": "Atom", "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873", "process_name": "Process", "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } }, "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/integration/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Get A Specific Integration Tool By Id", "description": "Retrieve a specific Integration tool by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_integration_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_IntegrationTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get Integration Tool" }, "example": { "success": true, "message": "Integration tool retrieved successfully", "data": { "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7", "created_on": "2026-05-21T11:22:55.107734Z", "last_updated_on": "2026-05-21T12:50:12.824517Z", "installed_on": "2026-05-21T12:50:12.819966Z", "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "environment_id": "", "environment_name": "Environment", "atom_id": "", "atom_name": "Atom", "process_id": "", "process_name": "Process", "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } }, "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Tools" ], "summary": "Update An Existing Integration Tool", "description": "Update an existing Integration tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_EDIT`.", "operationId": "update_integration_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationToolUpdate" }, "example": { "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0", "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20", "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_IntegrationTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update Integration Tool" }, "example": { "success": true, "message": "Integration tool updated successfully", "data": { "id": "a62425b6-fa52-4a56-abff-474edd455e46", "created_on": "2026-06-01T08:55:40.217458Z", "last_updated_on": "2026-06-01T10:35:30.866114Z", "installed_on": null, "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0", "environment_name": "Environment", "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20", "atom_name": "Atom", "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873", "process_name": "Process", "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } }, "tool_status": "DISABLED" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete An Existing Integration Tool", "description": "Soft delete an existing Integration tool by setting its is_deleted to true.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_integration_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_IntegrationTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Integration Tool" }, "example": { "success": true, "message": "Integration tool deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/integration/{tool_id}/install": { "post": { "tags": [ "Tools" ], "summary": "Install An Integration Tool", "description": "Install an Integration tool by setting its status to ACTIVE.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "install_integration_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_IntegrationTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Install Integration Tool" }, "example": { "success": true, "message": "Integration tool installed successfully", "data": { "id": "a62425b6-fa52-4a56-abff-474edd455e46", "created_on": "2026-06-01T08:55:40.217458Z", "last_updated_on": "2026-06-01T08:55:52.483889Z", "installed_on": "2026-06-01T08:55:52.482997Z", "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0", "environment_name": "Environment", "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20", "atom_name": "Atom", "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873", "process_name": "Process", "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } }, "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/integration/{tool_id}/uninstall": { "post": { "tags": [ "Tools" ], "summary": "Uninstall An Integration Tool", "description": "Uninstall an Integration tool by setting its status to DISABLED.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "uninstall_integration_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_IntegrationTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Uninstall Integration Tool" }, "example": { "success": true, "message": "Integration tool uninstalled successfully", "data": { "id": "a62425b6-fa52-4a56-abff-474edd455e46", "created_on": "2026-06-01T08:55:40.217458Z", "last_updated_on": "2026-06-01T09:10:00.000000Z", "installed_on": null, "name": "Create_Sales_Order_Process", "description": "Triggers Boomi Integration process to create sales order in ERP", "input_parameters": [ { "name": "customer_id", "description": "unique customer id", "required": true, "type": "string" }, { "name": "items", "description": "unique product id and quantity", "required": true, "type": "string" }, { "name": "shipping_address", "description": "address where order will be shipped", "required": true, "type": "string" } ], "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0", "environment_name": "Environment", "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20", "atom_name": "Atom", "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873", "process_name": "Process", "dynamic_process_properties": { "customer_id": { "static_value": null, "input_parameter_name": "customer_id" }, "dpp_order_source": { "static_value": "AI AGENT", "input_parameter_name": null }, "items": { "static_value": null, "input_parameter_name": "items" }, "shipping_address": { "static_value": null, "input_parameter_name": "shipping_address" } }, "tool_status": "DISABLED" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/hub": { "post": { "tags": [ "Tools" ], "summary": "Create A New Hub Tool", "description": "Create a new Hub tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_CREATE`.", "operationId": "create_hub_tool", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubToolBase" }, "example": { "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "unique_id": "TAX_ID", "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING" } ], "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_HubTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Hub Tool" }, "example": { "success": true, "message": "Hub tool created successfully", "data": { "id": "d80c0d77-6558-4fb7-b821-4a45b051c915", "created_on": "2026-06-01T09:00:28.223236Z", "last_updated_on": "2026-06-01T09:00:28.223236Z", "installed_on": null, "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ], "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "repository_name": "Repository", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "universe_name": "Universe", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING", "repeatable": false } ], "limit": 200, "filter_operator": null, "filter_fields": [], "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/hub/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Get A Specific Hub Tool By Id", "description": "Retrieve a specific Hub tool by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_hub_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_HubTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get Hub Tool" }, "example": { "success": true, "message": "Hub tool retrieved successfully", "data": { "id": "408c1475-db13-4d0a-adab-0c8fcbd22014", "created_on": "2026-06-01T09:00:28.223236Z", "last_updated_on": "2026-06-01T09:00:41.524679Z", "installed_on": "2026-06-01T09:00:41.523746Z", "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ], "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "repository_name": "Repository", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "universe_name": "Universe", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING", "repeatable": false } ], "limit": 200, "filter_operator": null, "filter_fields": [], "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Tools" ], "summary": "Update An Existing Hub Tool", "description": "Update an existing Hub tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`, `AGENT_CREATE`.", "operationId": "update_hub_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubToolUpdate" }, "example": { "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "unique_id": "TAX_ID", "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING" } ], "filter_fields": [], "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_HubTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update Hub Tool" }, "example": { "success": true, "message": "Hub tool updated successfully", "data": { "id": "d80c0d77-6558-4fb7-b821-4a45b051c915", "created_on": "2026-06-01T09:00:28.223236Z", "last_updated_on": "2026-06-01T10:00:00.000000Z", "installed_on": null, "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ], "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "repository_name": "Repository", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "universe_name": "Universe", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING", "repeatable": false } ], "limit": 200, "filter_operator": null, "filter_fields": [], "tool_status": "DISABLED" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete An Existing Hub Tool", "description": "Soft delete an existing Hub tool by setting its is_deleted to true.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_hub_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_HubTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Hub Tool" }, "example": { "success": true, "message": "Hub tool deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/hub/{tool_id}/install": { "post": { "tags": [ "Tools" ], "summary": "Install A Hub Tool", "description": "Install a Hub tool by setting its status to ACTIVE.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "install_hub_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_HubTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Install Hub Tool" }, "example": { "success": true, "message": "Hub tool installed successfully", "data": { "id": "d80c0d77-6558-4fb7-b821-4a45b051c915", "created_on": "2026-06-01T09:00:28.223236Z", "last_updated_on": "2026-06-01T09:00:41.524679Z", "installed_on": "2026-06-01T09:00:41.523746Z", "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ], "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "repository_name": "Repository", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "universe_name": "Universe", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING", "repeatable": false } ], "limit": 200, "filter_operator": null, "filter_fields": [], "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/hub/{tool_id}/uninstall": { "post": { "tags": [ "Tools" ], "summary": "Uninstall A Hub Tool", "description": "Uninstall a Hub tool by setting its status to DISABLED.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "uninstall_hub_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_HubTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Uninstall Hub Tool" }, "example": { "success": true, "message": "Hub tool uninstalled successfully", "data": { "id": "d80c0d77-6558-4fb7-b821-4a45b051c915", "created_on": "2026-06-01T09:00:28.223236Z", "last_updated_on": "2026-06-01T10:30:00.000000Z", "installed_on": null, "name": "Query_Customer_Credit_History", "description": "Check customer credit history", "input_parameters": [ { "name": "tax_id", "description": "unique tax id", "required": true, "type": "string" } ], "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0", "repository_name": "Repository", "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0", "universe_name": "Universe", "cloud_host": "your-hub.pipeline.boomi.com", "fields": [ { "pretty_name": "Tax ID", "path": "tax_id", "data_type": "STRING", "repeatable": false } ], "limit": 200, "filter_operator": null, "filter_fields": [], "tool_status": "DISABLED" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/openapi": { "post": { "tags": [ "Tools" ], "summary": "Create A New Api Tool", "description": "Create a new API tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_CREATE`.", "operationId": "create_openapi_tool", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAPIToolBase" }, "example": { "name": "O2C_Customer_filter", "description": "Search customers", "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "headers": [ { "name": "x-api-key", "static_value": "", "is_sensitive": true } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_OpenAPISecureTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Openapi Tool" }, "example": { "success": true, "message": "OpenAPI tool created successfully", "data": { "id": "6e7ca5c6-56ee-4e2c-a1a6-2aad5c138817", "created_on": "2026-06-01T12:28:58.670266Z", "last_updated_on": "2026-06-01T12:28:58.670266Z", "installed_on": null, "name": "O2C_Customer_filter", "description": "Search customers", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "path_parameters": null, "headers": [ { "name": "x-api-key", "is_sensitive": true } ], "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/openapi/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Get A Specific Api Tool By Id", "description": "Retrieve a specific API tool by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_openapi_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_OpenAPISecureTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get Openapi Tool" }, "example": { "success": true, "message": "OpenAPI tool retrieved successfully", "data": { "id": "cb655a19-3b10-4538-894d-789074d4f5d6", "created_on": "2026-05-21T09:25:52.268675Z", "last_updated_on": "2026-05-21T10:55:45.913230Z", "installed_on": "2026-05-21T10:55:45.912061Z", "name": "O2C_Customer_filter", "description": "Search customers", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "path_parameters": null, "headers": [ { "name": "x-api-key", "is_sensitive": true } ], "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Tools" ], "summary": "Update An Existing Api Tool", "description": "Update an existing API tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_EDIT`.", "operationId": "update_openapi_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenAPIToolUpdate" }, "example": { "name": "O2C_Customer_filter", "description": "Search customers", "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "headers": [ { "name": "x-api-key", "static_value": "", "is_sensitive": true } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_OpenAPISecureTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update Openapi Tool" }, "example": { "success": true, "message": "OpenAPI tool updated successfully", "data": { "id": "6e7ca5c6-56ee-4e2c-a1a6-2aad5c138817", "created_on": "2026-06-01T12:28:58.670266Z", "last_updated_on": "2026-06-01T13:00:00.000000Z", "installed_on": null, "name": "O2C_Customer_filter", "description": "Search customers", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "path_parameters": null, "headers": [ { "name": "x-api-key", "is_sensitive": true } ], "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete An Existing Api Tool", "description": "Soft delete an existing API tool by setting its is_deleted to true.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_openapi_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_OpenAPITool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Openapi Tool" }, "example": { "success": true, "message": "OpenAPI tool deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/openapi/{tool_id}/install": { "post": { "tags": [ "Tools" ], "summary": "Install An Api Tool", "description": "Install an API tool by setting its status to ACTIVE.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "install_openapi_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_OpenAPITool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Install Openapi Tool" }, "example": { "success": true, "message": "OpenAPI tool installed successfully", "data": { "id": "cc154225-1afc-4a99-8d3b-6648e1800650", "created_on": "2026-06-01T09:05:58.983756Z", "last_updated_on": "2026-06-01T09:06:14.768335Z", "installed_on": "2026-06-01T09:06:14.767457Z", "name": "O2C_Customer_filter", "description": "Search customers", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "path_parameters": null, "headers": [ { "name": "x-api-key", "is_sensitive": true } ], "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/openapi/{tool_id}/uninstall": { "post": { "tags": [ "Tools" ], "summary": "Uninstall An Api Tool", "description": "Uninstall an API tool by setting its status to DISABLED.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "uninstall_openapi_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_OpenAPITool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Uninstall Openapi Tool" }, "example": { "success": true, "message": "OpenAPI tool uninstalled successfully", "data": { "id": "cc154225-1afc-4a99-8d3b-6648e1800650", "created_on": "2026-06-01T09:05:58.983756Z", "last_updated_on": "2026-06-01T09:07:09.130957Z", "installed_on": null, "name": "O2C Customer filter", "description": "Search customers", "input_parameters": [ { "name": "filters", "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}", "required": false, "type": "string" }, { "name": "limit", "description": "no of records", "required": false, "type": "integer" }, { "name": "offset", "description": "offset value", "required": false, "type": "integer" } ], "base_url": "https://example.execute-api.us-east-1.amazonaws.com", "path": "/qa/customers/search", "method": "POST", "query_parameters": [ { "name": "filters", "input_parameter_name": "filters", "static_value": null }, { "name": "limit", "input_parameter_name": "limit", "static_value": null }, { "name": "offset", "input_parameter_name": "offset", "static_value": null } ], "path_parameters": null, "headers": "", "authentication": null, "request_body": null, "source_id": null, "source_name": null, "tool_status": "DISABLED" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/prompt": { "post": { "tags": [ "Tools" ], "summary": "Create A New Prompt Tool", "description": "Create a new Prompt tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_CREATE`.", "operationId": "create_prompt_tool", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptToolBase" }, "example": { "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer", "prompt": "Generate a friendly order summary for the following order:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems: {{items}}\nTotal Amount: {{total_amount}}\nShipping Address: {{shipping_address}}\n\nPlease provide a concise, professional summary that includes all key details.", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "items", "description": "List of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount", "required": true, "type": "float" }, { "name": "shipping_address", "description": "Delivery address", "required": true, "type": "string" } ], "examples": [ { "input": "Order ID: ORD-001, Customer: John Doe, Items: [Widget x2], Total: $49.99, Address: 123 Main St", "output": "Dear John Doe, your order ORD-001 for 2x Widget totaling $49.99 will be delivered to 123 Main St." } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PromptTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create Prompt Tool" }, "example": { "success": true, "message": "Prompt tool created successfully", "data": { "id": "f45a88b0-5be5-455c-b82b-f002b09e5033", "created_on": "2026-06-01T13:14:03.690830Z", "last_updated_on": "2026-06-01T13:14:03.690830Z", "installed_on": null, "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "order_items", "description": "Comma-separated list of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount including tax", "required": true, "type": "string" }, { "name": "delivery_date", "description": "Estimated delivery date for the order", "required": true, "type": "string" } ], "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.", "examples": [ { "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025", "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!" } ], "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/prompt/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Get A Specific Prompt Tool By Id", "description": "Retrieve a specific Prompt tool by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_prompt_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PromptTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get Prompt Tool" }, "example": { "success": true, "message": "Prompt tool retrieved successfully", "data": { "id": "f45a88b0-aaaa-bbbb-cccc-ddddeeee9999", "created_on": "2026-05-18T10:00:00.000000Z", "last_updated_on": "2026-05-18T10:00:00.000000Z", "installed_on": null, "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer", "prompt": "Generate a friendly order summary for the following order:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems: {{items}}\nTotal Amount: {{total_amount}}\nShipping Address: {{shipping_address}}", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "items", "description": "List of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount", "required": true, "type": "float" }, { "name": "shipping_address", "description": "Delivery address", "required": true, "type": "string" } ], "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Tools" ], "summary": "Update An Existing Prompt Tool", "description": "Update an existing Prompt tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_EDIT`.", "operationId": "update_prompt_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptToolUpdate" }, "example": { "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer", "prompt": "Generate a friendly order summary for the following order:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems: {{items}}\nTotal Amount: {{total_amount}}\nShipping Address: {{shipping_address}}\n\nPlease provide a concise, professional summary that includes all key details.", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "items", "description": "List of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount", "required": true, "type": "float" }, { "name": "shipping_address", "description": "Delivery address", "required": true, "type": "string" } ], "examples": [ { "input": "Order ID: ORD-001, Customer: John Doe, Items: [Widget x2], Total: $49.99, Address: 123 Main St", "output": "Dear John Doe, your order ORD-001 for 2x Widget totaling $49.99 will be delivered to 123 Main St." } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PromptTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update Prompt Tool" }, "example": { "success": true, "message": "Prompt tool updated successfully", "data": { "id": "f45a88b0-5be5-455c-b82b-f002b09e5033", "created_on": "2026-06-01T13:14:03.690830Z", "last_updated_on": "2026-06-01T13:16:11.998100Z", "installed_on": null, "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "order_items", "description": "Comma-separated list of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount including tax", "required": true, "type": "string" }, { "name": "delivery_date", "description": "Estimated delivery date for the order", "required": true, "type": "string" } ], "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.", "examples": [ { "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025", "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!" } ], "tool_status": "DRAFT" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete An Existing Prompt Tool", "description": "Soft delete an existing Prompt tool by setting its is_deleted to true.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_prompt_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PromptTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete Prompt Tool" }, "example": { "success": true, "message": "Prompt tool deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/prompt/{tool_id}/install": { "post": { "tags": [ "Tools" ], "summary": "Install A Prompt Tool", "description": "Install a prompt tool by setting its status to ACTIVE.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "install_prompt_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PromptTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Install Prompt Tool" }, "example": { "success": true, "message": "Prompt tool installed successfully", "data": { "id": "7000a4b4-8b40-4599-9860-e6ed92370663", "created_on": "2026-06-01T10:40:10.510297Z", "last_updated_on": "2026-06-01T10:48:04.525794Z", "installed_on": "2026-06-01T10:48:04.524588Z", "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "order_items", "description": "Comma-separated list of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount including tax", "required": true, "type": "string" }, { "name": "delivery_date", "description": "Estimated delivery date for the order", "required": true, "type": "string" } ], "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.", "examples": [ { "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025", "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!" } ], "tool_status": "ACTIVE" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/prompt/{tool_id}/uninstall": { "post": { "tags": [ "Tools" ], "summary": "Uninstall A Prompt Tool", "description": "Uninstall a prompt tool by setting its status to DISABLED.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "uninstall_prompt_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PromptTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Uninstall Prompt Tool" }, "example": { "success": true, "message": "Prompt tool uninstalled successfully", "data": { "id": "7000a4b4-8b40-4599-9860-e6ed92370663", "created_on": "2026-06-01T10:40:10.510297Z", "last_updated_on": "2026-06-01T10:56:06.598143Z", "installed_on": null, "name": "Generate_Order_Summary", "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order", "required": true, "type": "string" }, { "name": "customer_name", "description": "Full name of the customer", "required": true, "type": "string" }, { "name": "order_items", "description": "Comma-separated list of items in the order", "required": true, "type": "string" }, { "name": "total_amount", "description": "Total order amount including tax", "required": true, "type": "string" }, { "name": "delivery_date", "description": "Estimated delivery date for the order", "required": true, "type": "string" } ], "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.", "examples": [ { "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025", "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!" } ], "tool_status": "DISABLED" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/mcp/{tool_id}": { "get": { "tags": [ "Tools" ], "summary": "Get A Specific MCP Tool By Id", "description": "Retrieve a specific MCP tool by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_mcp_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPToolResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get MCP Tool" }, "example": { "success": true, "message": "MCP tool retrieved successfully", "data": { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "created_on": "2026-05-21T08:53:44.925746Z", "last_updated_on": "2026-06-01T12:20:01.617016Z", "installed_on": "2026-05-21T08:53:44.925746Z", "name": "o2c-mock-server-api-qa--api_processPayment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "input_schema": { "type": "object", "properties": { "content": { "required": [ "amount", "order_id" ], "type": "object", "properties": { "order_id": { "type": "string", "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)" }, "amount": { "type": "number", "description": "Payment amount in USD (e.g. 2130.91)" }, "payment_method": { "type": "string", "description": "Payment method", "enum": [ "CREDIT_CARD", "DEBIT_CARD", "ACH", "WIRE", "INVOICE" ] }, "payment_details": { "type": "object", "description": "Card or bank details", "properties": { "card_number": { "type": "string", "description": "Card number (e.g. 4111111111111234)" }, "expiry": { "type": "string", "description": "Expiry date MM/YY (e.g. 12/25)" }, "cvv": { "type": "string", "description": "CVV code (e.g. 123)" }, "cardholder_name": { "type": "string", "description": "Name on card (e.g. John Smith)" } } }, "is_partial": { "type": "boolean", "description": "Whether this is a partial payment" } } } }, "required": [ "content" ] }, "tool_status": "ACTIVE", "source_details": { "id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "created_on": "2026-05-21T08:53:42.285528Z", "last_updated_on": "2026-05-21T08:53:42.285528Z", "installed_on": "2026-05-21T08:53:44.885911Z", "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "title": null, "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "transport_type": "SSE", "authentication": null, "tools": [], "status": "ACTIVE", "agents_equipped_count": 0, "tool_counts": { "imported": 0, "active": 0, "stale": 0, "not_available": 0, "available": 0 }, "imported_tools": [], "available_tools": [], "tool_changes": { "to_update": [], "to_remove": [] } } } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Tools" ], "summary": "Update An Existing MCP Tool", "description": "Update an existing MCP tool with the provided details.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_EDIT`.", "operationId": "update_mcp_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MCPToolUpdate" }, "example": { "name": "o2c-mock-server-api-qa--api_processPayment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "tool_status": "ACTIVE", "input_parameters": null, "input_schema": { "type": "object", "properties": { "content": { "required": [ "amount", "order_id" ], "type": "object", "properties": { "order_id": { "type": "string", "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)" }, "amount": { "type": "number", "description": "Payment amount in USD (e.g. 2130.91)" }, "payment_method": { "type": "string", "description": "Payment method", "enum": [ "CREDIT_CARD", "DEBIT_CARD", "ACH", "WIRE", "INVOICE" ] }, "payment_details": { "type": "object", "description": "Card or bank details", "properties": { "card_number": { "type": "string", "description": "Card number (e.g. 4111111111111234)" }, "expiry": { "type": "string", "description": "Expiry date MM/YY (e.g. 12/25)" }, "cvv": { "type": "string", "description": "CVV code (e.g. 123)" }, "cardholder_name": { "type": "string", "description": "Name on card (e.g. John Smith)" } } }, "is_partial": { "type": "boolean", "description": "Whether this is a partial payment" } } } }, "required": [ "content" ] } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPToolResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update MCP Tool" }, "example": { "success": true, "message": "MCP tool retrieved successfully", "data": { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "created_on": "2026-05-21T08:53:44.925746Z", "last_updated_on": "2026-06-01T12:20:01.617016Z", "installed_on": "2026-05-21T08:53:44.925746Z", "name": "o2c-mock-server-api-qa--api_processPayment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "input_parameters": null, "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "input_schema": { "type": "object", "properties": { "content": { "required": [ "amount", "order_id" ], "type": "object", "properties": { "order_id": { "type": "string", "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)" }, "amount": { "type": "number", "description": "Payment amount in USD (e.g. 2130.91)" }, "payment_method": { "type": "string", "description": "Payment method", "enum": [ "CREDIT_CARD", "DEBIT_CARD", "ACH", "WIRE", "INVOICE" ] }, "payment_details": { "type": "object", "description": "Card or bank details", "properties": { "card_number": { "type": "string", "description": "Card number (e.g. 4111111111111234)" }, "expiry": { "type": "string", "description": "Expiry date MM/YY (e.g. 12/25)" }, "cvv": { "type": "string", "description": "CVV code (e.g. 123)" }, "cardholder_name": { "type": "string", "description": "Name on card (e.g. John Smith)" } } }, "is_partial": { "type": "boolean", "description": "Whether this is a partial payment" } } } }, "required": [ "content" ] }, "tool_status": "ACTIVE", "source_details": { "id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "created_on": "2026-05-21T08:53:42.285528Z", "last_updated_on": "2026-05-21T08:53:42.285528Z", "installed_on": "2026-05-21T08:53:44.885911Z", "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "title": null, "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "transport_type": "SSE", "authentication": null, "tools": [], "status": "ACTIVE", "agents_equipped_count": 0, "tool_counts": { "imported": 0, "active": 0, "stale": 0, "not_available": 0, "available": 0 }, "imported_tools": [], "available_tools": [], "tool_changes": { "to_update": [], "to_remove": [] } } } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Tools" ], "summary": "Delete An Existing MCP Tool", "description": "Soft delete an existing MCP tool by setting its is_deleted to true.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_mcp_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPTool_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete MCP Tool" }, "example": { "success": true, "message": "MCP tool deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/mcp/{tool_id}/install": { "post": { "tags": [ "Tools" ], "summary": "Install An MCP Tool", "description": "Install an MCP tool by setting its status to ACTIVE.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "install_mcp_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_str_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Install MCP Tool" }, "example": { "success": true, "message": "MCP tool installed successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/tools/mcp/{tool_id}/uninstall": { "post": { "tags": [ "Tools" ], "summary": "Uninstall An MCP Tool", "description": "Uninstall an MCP tool by setting its status to DISABLED.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`.", "operationId": "uninstall_mcp_tool", "parameters": [ { "name": "tool_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Tool Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_str_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Uninstall MCP Tool" }, "example": { "success": true, "message": "MCP tool uninstalled successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/packages": { "get": { "tags": [ "Packages" ], "summary": "List All Packages", "description": "Retrieve list of packages for a given account ID and user ID across all agents.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "list_packages", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in name or objective", "title": "Search Term" }, "description": "Filter by a substring match in name or objective" }, { "name": "has_active_deployments", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter to return only packages with active deployments", "default": false, "title": "Has Active Deployments" }, "description": "Filter to return only packages with active deployments" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "created_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order", "default": "desc", "title": "Sort Order" }, "description": "Sort order" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_PackageSummaryResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Packages" }, "example": { "success": true, "message": "Packages retrieved successfully", "data": { "total_items": 1, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "package_id": "6b392a3c-9c6e-4f09-8b55-177d7667d7ec", "name": "Enterprise O2C Agent", "version": "1.0", "agent_id": "ddccf1ad-c01f-4d13-b8f2-98730cc204a2", "agent_name": "Enterprise O2C Agent", "agent_mode": "conversational", "profile_picture": null, "deployment_count": 1, "created_on": "2026-05-22T11:48:15.945378Z" } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/packages/{deployed_package_id}/deployments": { "get": { "tags": [ "Packages" ], "summary": "List Deployments By Package Id", "description": "Retrieve list of deployments for a given package ID, account ID and user ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "list_package_deployments", "parameters": [ { "name": "deployed_package_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The unique identifier of the deployed package to list deployments for", "title": "Deployed Package Id" }, "description": "The unique identifier of the deployed package to list deployments for" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "deployed_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order (default: desc)", "default": "desc", "title": "Sort Order" }, "description": "Sort order (default: desc)" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in name or agent/deployment ID", "title": "Search Term" }, "description": "Filter by a substring match in name or agent/deployment ID" }, { "name": "env_name_search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by substring match in environment_name", "title": "Env Name Search Term" }, "description": "Filter by substring match in environment_name" }, { "name": "agent_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Filter by agent ID", "title": "Agent Id" }, "description": "Filter by agent ID" }, { "name": "package_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Filter by package ID", "title": "Package Id" }, "description": "Filter by package ID" }, { "name": "runtime_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "description": "Filter by runtime ID", "title": "Runtime Id" }, "description": "Filter by runtime ID" }, { "name": "environment_id", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filter by environment ID", "title": "Environment Id" }, "description": "Filter by environment ID" }, { "name": "deployment_status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeploymentStatus" }, "description": "Filter by deployment status", "title": "Deployment Status" }, "description": "Filter by deployment status" }, { "name": "agent_mode", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AgentMode", "description": "Filter by agent mode" }, "description": "Filter by agent mode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_DeploymentResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Package Deployments" }, "example": { "success": true, "message": "Deployments for Package with ID 6b392a3c-9c6e-4f09-8b55-177d7667d7ec retrieved successfully", "data": { "total_items": 1, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "package_id": "6b392a3c-9c6e-4f09-8b55-177d7667d7ec", "environment_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b", "deployment_id": "e54b1f0b-4528-4782-ab7c-96c30c56e793", "agent_id": "ddccf1ad-c01f-4d13-b8f2-98730cc204a2", "deployment_status": "ACTIVE", "deployed_on": "2026-05-22T11:51:15.817200Z", "deployed_by": "", "last_updated_on": "2026-05-22T11:51:15.817200Z", "agent_name": "Enterprise O2C Agent", "agent_mode": "conversational", "origin": null, "is_favorite": false, "profile_picture": null, "package_version": "1.0", "package_name": "Enterprise O2C Agent", "environment_name": "Agent Garden Production", "runtimes": [ { "runtime_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "runtime_name": "USA East Agent Garden Cloud 01", "runtime_region": "US", "endpoint_url": "https://example.ai-agent-garden-runtime.boomi.com" } ] } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/environments": { "get": { "tags": [ "Environments" ], "summary": "List All Environments", "description": "Retrieve list of environments for a given account ID and user ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`, `AGENT_EDIT`, `AGENT_CREATE`.", "operationId": "list_environments", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "deployment_count", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order (default: desc)", "default": "desc", "title": "Sort Order" }, "description": "Sort order (default: desc)" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in env ID or name", "title": "Search Term" }, "description": "Filter by a substring match in env ID or name" }, { "name": "classification", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/EnvironmentClassification", "description": "Filter by a environment classification" }, "description": "Filter by a environment classification" }, { "name": "source", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/EnvironmentSource", "description": "Filter by a environment source" }, "description": "Filter by a environment source" }, { "name": "env_status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnvironmentStatus" }, "description": "Filter by a environment status", "title": "Env Status" }, "description": "Filter by a environment status" }, { "name": "runtime_id", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Filter by a runtime IDs", "title": "Runtime Id" }, "description": "Filter by a runtime IDs" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_Union_EnvironmentResponse__IntegrationEnvironmentResponse___" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Environments" }, "example": { "success": true, "message": "Environments retrieved successfully", "data": { "total_items": 2, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "integration_environment_id": null, "ag_environment_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b", "name": "Agent Garden Production", "classification": "PRODUCTION", "status": "ATTACHED", "source": "AGENT_GARDEN", "is_default": true, "created_on": "2026-04-28T08:37:09.967199Z", "last_updated_on": "2026-04-28T08:37:09.967199Z", "runtimes": [ { "runtime_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "runtime_name": "USA East Agent Garden Cloud 01", "runtime_region": "US", "endpoint_url": "https://example.ai-agent-garden-runtime.boomi.com" } ], "deployment_count": 1 }, { "integration_environment_id": null, "ag_environment_id": "f6a7b8c9-d0e1-4f2a-3b4c-5d6e7f8a9b0c", "name": "Agent Garden Test", "classification": "TEST", "status": "ATTACHED", "source": "AGENT_GARDEN", "is_default": true, "created_on": "2026-04-28T08:37:09.967199Z", "last_updated_on": "2026-04-28T08:37:09.967199Z", "runtimes": [ { "runtime_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "runtime_name": "USA East Agent Garden Cloud 01", "runtime_region": "US", "endpoint_url": "https://example.ai-agent-garden-runtime.boomi.com" } ], "deployment_count": 0 } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/sources/tools/mcp-servers": { "get": { "tags": [ "Sources" ], "summary": "List All MCP Servers", "description": "List all MCP servers with pagination and filtering options.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "list_mcp_servers", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MCPServerStatus" }, "description": "Filter by server status", "title": "Status" }, "description": "Filter by server status" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in name or description", "title": "Search Term" }, "description": "Filter by a substring match in name or description" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "last_updated_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order (default: desc)", "default": "desc", "title": "Sort Order" }, "description": "Sort order (default: desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_MCPServerSummaryResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List MCP Servers" }, "example": { "success": true, "message": "MCP servers retrieved successfully", "data": { "total_items": 1, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "transport_type": "SSE", "status": "ACTIVE", "agents_equipped_count": 0, "imported_tools_count": 5, "created_on": "2026-05-21T08:53:42.285528Z", "last_updated_on": "2026-05-21T08:53:42.285528Z" } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "post": { "tags": [ "Sources" ], "summary": "Create A New MCP Server", "description": "Create a new MCP server and retrieve its tools via MCP list_tools call.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_INSTALL`, `AGENT_CREATE`.", "operationId": "create_mcp_server", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MCPServerBase" }, "example": { "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "transport_type": "SSE", "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "tools": [ { "name": "o2c-mock-server-api-qa--api_getProduct" }, { "name": "o2c-mock-server-api-qa--api_checkProductAvailability" }, { "name": "o2c-mock-server-api-qa--api_processPayment" }, { "name": "o2c-mock-server-api-qa--api_getPayment" }, { "name": "o2c-mock-server-api-qa--api_refundPayment" } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPServer_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Create MCP Server" }, "example": { "success": true, "message": "5 tools for o2c-mcp-source-1 successfully imported.", "data": { "id": "f5e55d6e-31a3-4d98-945d-817f497193e4", "created_on": "2026-06-01T12:21:19.036858Z", "last_updated_on": "2026-06-01T12:21:19.036858Z", "installed_on": "2026-06-01T12:21:20.920221Z", "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "title": null, "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "transport_type": "SSE", "authentication": null, "tools": [], "status": "ACTIVE", "agents_equipped_count": 0, "tool_counts": { "imported": 5, "active": 5, "stale": 0, "not_available": 0, "available": 28 }, "imported_tools": [ { "id": "994dc325-fcce-4e4c-be5a-1cba1066b267", "created_on": "2026-06-01T12:21:20.945618Z", "last_updated_on": "2026-06-01T12:21:20.945618Z", "installed_on": "2026-06-01T12:21:20.945618Z", "name": "o2c-mock-server-api-qa--api_getProduct", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Get product by SKU", "description": "Get product by SKU\nRetrieve product details by SKU", "input_parameters": null }, "new_schema": null }, { "id": "2a3b3d12-59e7-49ce-b538-ad08ee5b09ff", "created_on": "2026-06-01T12:21:20.955342Z", "last_updated_on": "2026-06-01T12:21:20.955342Z", "installed_on": "2026-06-01T12:21:20.955342Z", "name": "o2c-mock-server-api-qa--api_checkProductAvailability", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Check product availability", "description": "Check product availability\nCheck if requested quantity of a product is available in stock", "input_parameters": null }, "new_schema": null }, { "id": "720d28e5-935c-4b6f-8215-21270bb389c7", "created_on": "2026-06-01T12:21:20.957674Z", "last_updated_on": "2026-06-01T12:21:20.957674Z", "installed_on": "2026-06-01T12:21:20.957674Z", "name": "o2c-mock-server-api-qa--api_processPayment", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "input_parameters": null }, "new_schema": null }, { "id": "8e4d62fe-3ae1-4398-a157-1d691405df3b", "created_on": "2026-06-01T12:21:20.959827Z", "last_updated_on": "2026-06-01T12:21:20.959827Z", "installed_on": "2026-06-01T12:21:20.959827Z", "name": "o2c-mock-server-api-qa--api_getPayment", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Get payment by ID", "description": "Get payment by ID\nRetrieve payment details by payment ID", "input_parameters": null }, "new_schema": null }, { "id": "7d834ef5-becf-4a04-a769-c965debe4cfa", "created_on": "2026-06-01T12:21:20.961823Z", "last_updated_on": "2026-06-01T12:21:20.961823Z", "installed_on": "2026-06-01T12:21:20.961823Z", "name": "o2c-mock-server-api-qa--api_refundPayment", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Refund a payment", "description": "Refund a payment\nProcess a full or partial refund for an existing payment", "input_parameters": null }, "new_schema": null } ], "available_tools": [ { "name": "o2c-mock-server-api-qa--api_healthCheck", "new_schema": { "title": "o2c-mock-server-api-qa (1.0) - Health check", "description": "Health check\nCheck API health status", "input_parameters": [] } }, { "name": "o2c-mock-server-api-qa--api_OPTIONS--health", "new_schema": { "title": "o2c-mock-server-api-qa (1.0)", "description": "", "input_parameters": [] } } ], "tool_changes": { "to_update": [], "to_remove": [] } } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Could not connect to the MCP server, or its credentials are missing or invalid. When OAuth authorization is required, the response includes an `authorization_url` to complete the flow.", "content": { "application/json": { "example": { "success": false, "error": "Authentication failed. Please complete the OAuth flow.", "authorization_url": "https://platform.boomi.com/oauth/authorize?...", "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/sources/tools/mcp-servers/{server_id}": { "get": { "tags": [ "Sources" ], "summary": "Get A Specific MCP Server By Id", "description": "Retrieve a specific MCP server by its ID.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_mcp_server", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Server Id" } }, { "name": "include_tools", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Include associated tools in response", "default": true, "title": "Include Tools" }, "description": "Include associated tools in response" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPServer_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get MCP Server" }, "example": { "success": true, "message": "MCP server retrieved successfully", "data": { "id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "created_on": "2026-05-21T08:53:42.285528Z", "last_updated_on": "2026-05-21T08:53:42.285528Z", "installed_on": "2026-05-21T08:53:44.885911Z", "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "title": null, "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "transport_type": "SSE", "authentication": null, "tools": [], "status": "ACTIVE", "agents_equipped_count": 0, "tool_counts": { "imported": 5, "active": 5, "stale": 0, "not_available": 0, "available": 0 }, "imported_tools": [ { "id": "54e59137-ecf1-4643-ae45-ee8da3bc0122", "name": "o2c-mock-server-api-qa--api_checkProductAvailability", "old_status": "ACTIVE", "new_status": "", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Check product availability", "description": "Check product availability\nCheck if requested quantity of a product is available in stock", "input_parameters": null }, "new_schema": null }, { "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2", "name": "o2c-mock-server-api-qa--api_processPayment", "old_status": "ACTIVE", "new_status": "", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "input_parameters": null }, "new_schema": null }, { "id": "50a09cb6-e6ba-4e93-b397-0e09c96dfde1", "name": "o2c-mock-server-api-qa--api_refundPayment", "old_status": "ACTIVE", "new_status": "", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Refund a payment", "description": "Refund a payment\nProcess a full or partial refund for an existing payment", "input_parameters": null }, "new_schema": null } ], "available_tools": [], "tool_changes": { "to_update": [], "to_remove": [] } } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "Sources" ], "summary": "Update An Existing MCP Server", "description": "Update an existing MCP server with the provided data.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_EDIT`.", "operationId": "update_mcp_server", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Server Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MCPServerUpdate" }, "example": { "name": "Order to Customer MCP Server", "description": "MCP server exposing order management tools - handles orders, customers, products, payments and notifications", "transport_type": "SSE", "status": "ACTIVE", "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "tools": [ { "name": "get_order", "description": "Retrieve details of a specific order by order ID", "title": "Get Order", "input_parameters": [ { "name": "order_id", "description": "Unique identifier for the order (e.g. ORD-12345)", "required": true, "type": "string", "title": "Order ID", "server_default": null, "user_default": null } ] }, { "name": "create_order", "description": "Create a new order for a customer with specified products", "title": "Create Order", "input_parameters": [ { "name": "customer_id", "description": "Unique identifier for the customer placing the order", "required": true, "type": "string", "title": "Customer ID", "server_default": null, "user_default": null }, { "name": "items", "description": "List of product SKUs and quantities to order", "required": true, "type": "string", "title": "Order Items", "server_default": null, "user_default": null } ] }, { "name": "list_products", "description": "List all available products with pricing and inventory", "title": "List Products", "input_parameters": null } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPServerSecure_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Update MCP Server" }, "example": { "success": true, "message": "MCP server Order to Customer MCP Server updated successfully", "data": { "id": "bcb51e3a-8cbc-474a-ab1b-1fda2a2bbdfa", "created_on": "2026-06-01T10:25:01.751837Z", "last_updated_on": "2026-06-01T10:26:23.629436Z", "installed_on": "2026-06-01T10:25:04.248505Z", "name": "Order to Customer MCP Server", "description": "MCP server exposing order management tools - handles orders, customers, products, payments and notifications", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "title": null, "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ], "transport_type": "SSE", "authentication": null, "tools": [], "status": "ACTIVE", "agents_equipped_count": 0, "tool_counts": { "imported": 5, "active": 5, "stale": 0, "not_available": 0, "available": 0 }, "imported_tools": [ { "id": "d5814d6c-c5e3-4c96-b97c-6a516d117306", "created_on": "2026-06-01T10:25:04.277730Z", "last_updated_on": "2026-06-01T10:25:04.277730Z", "installed_on": "2026-06-01T10:25:04.277730Z", "name": "o2c-mock-server-api-qa--api_getProduct", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Get product by SKU", "description": "Get product by SKU\nRetrieve product details by SKU", "input_parameters": null }, "new_schema": null }, { "id": "910bface-68be-4b59-b2d3-efae1cd44f86", "created_on": "2026-06-01T10:25:04.289429Z", "last_updated_on": "2026-06-01T10:25:04.289429Z", "installed_on": "2026-06-01T10:25:04.289429Z", "name": "o2c-mock-server-api-qa--api_checkProductAvailability", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Check product availability", "description": "Check product availability\nCheck if requested quantity of a product is available in stock", "input_parameters": null }, "new_schema": null }, { "id": "2e86f80e-a44d-49c7-91a0-01b5178a69e0", "created_on": "2026-06-01T10:25:04.291934Z", "last_updated_on": "2026-06-01T10:25:04.291934Z", "installed_on": "2026-06-01T10:25:04.291934Z", "name": "o2c-mock-server-api-qa--api_processPayment", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "input_parameters": null }, "new_schema": null }, { "id": "30f0fcc5-42fa-4de1-9495-f83241dfe026", "created_on": "2026-06-01T10:25:04.296803Z", "last_updated_on": "2026-06-01T10:25:04.296803Z", "installed_on": "2026-06-01T10:25:04.296803Z", "name": "o2c-mock-server-api-qa--api_getPayment", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Get payment by ID", "description": "Get payment by ID\nRetrieve payment details by payment ID", "input_parameters": null }, "new_schema": null }, { "id": "2249b151-a6e7-426d-bf2a-cf855af6e2e2", "created_on": "2026-06-01T10:25:04.299378Z", "last_updated_on": "2026-06-01T10:25:04.299378Z", "installed_on": "2026-06-01T10:25:04.299378Z", "name": "o2c-mock-server-api-qa--api_refundPayment", "old_status": "", "new_status": "ACTIVE", "old_schema": { "title": "o2c-mock-server-api-qa (1.0) - Refund a payment", "description": "Refund a payment\nProcess a full or partial refund for an existing payment", "input_parameters": null }, "new_schema": null } ], "available_tools": [ { "name": "o2c-mock-server-api-qa--api_healthCheck", "new_schema": { "title": "o2c-mock-server-api-qa (1.0) - Health check", "description": "Health check\nCheck API health status", "input_parameters": [] } } ], "tool_changes": { "to_update": [], "to_remove": [] } } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Could not connect to the MCP server, or its credentials are missing or invalid. When OAuth authorization is required, the response includes an `authorization_url` to complete the flow.", "content": { "application/json": { "example": { "success": false, "error": "Authentication failed. Please complete the OAuth flow.", "authorization_url": "https://platform.boomi.com/oauth/authorize?...", "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "Sources" ], "summary": "Delete An Existing MCP Server", "description": "Perform a soft delete on an MCP server by updating its is_deleted flag to True.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_DELETE`.", "operationId": "delete_mcp_server", "parameters": [ { "name": "server_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Server Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_MCPServer_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Delete MCP Server" }, "example": { "success": true, "message": "MCP server deleted successfully", "data": null } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/sources/tools/mcp-servers/discover-tools": { "post": { "tags": [ "Sources" ], "summary": "Discover Tools From MCP Server", "description": "Connect to MCP server and discover available tools with their input parameters.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_CREATE`.", "operationId": "discover_mcp_server_tools", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MCPServerBase" }, "example": { "name": "o2c-mcp-source-1", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "description": "MCP server hosted inside boomi", "transport_type": "SSE", "headers": [ { "name": "x-agent-key", "static_value": "", "is_sensitive": false } ] } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_List_MCPToolDiscover__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Discover MCP Server Tools" }, "example": { "success": true, "message": "Discovered tools successfully updated.", "data": [ { "name": "o2c-mock-server-api-qa--api_healthCheck", "description": "Health check\nCheck API health status", "title": "o2c-mock-server-api-qa (1.0) - Health check", "input_parameters": [] }, { "name": "o2c-mock-server-api-qa--api_getProduct", "description": "Get product by SKU\nRetrieve product details by SKU", "title": "o2c-mock-server-api-qa (1.0) - Get product by SKU", "input_parameters": [] }, { "name": "o2c-mock-server-api-qa--api_checkProductAvailability", "description": "Check product availability\nCheck if requested quantity of a product is available in stock", "title": "o2c-mock-server-api-qa (1.0) - Check product availability", "input_parameters": [] }, { "name": "o2c-mock-server-api-qa--api_processPayment", "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.", "title": "o2c-mock-server-api-qa (1.0) - Process a payment", "input_parameters": [] }, { "name": "o2c-mock-server-api-qa--api_refundPayment", "description": "Refund a payment\nProcess a full or partial refund for an existing payment", "title": "o2c-mock-server-api-qa (1.0) - Refund a payment", "input_parameters": [] } ] } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Could not connect to the MCP server, or its credentials are missing or invalid. When OAuth authorization is required, the response includes an `authorization_url` to complete the flow.", "content": { "application/json": { "example": { "success": false, "error": "Authentication failed. Please complete the OAuth flow.", "authorization_url": "https://platform.boomi.com/oauth/authorize?...", "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/sources/tools": { "get": { "tags": [ "Sources" ], "summary": "List All Sources", "description": "Retrieve a paginated list of source_builders with optional filters and sorting.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`, `AGENT_CREATE`.", "operationId": "list_sources", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "Page number to retrieve", "default": 1, "title": "Page" }, "description": "Page number to retrieve" }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "description": "Number of records per page", "default": 100, "title": "Page Size" }, "description": "Number of records per page" }, { "name": "source_type", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceType" }, "description": "Filter by source type", "title": "Source Type" }, "description": "Filter by source type" }, { "name": "source_status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceStatus" }, "description": "Filter by source status", "title": "Source Status" }, "description": "Filter by source status" }, { "name": "search_term", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by a substring match in name or description", "title": "Search Term" }, "description": "Filter by a substring match in name or description" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "description": "Field to sort by", "default": "last_updated_on", "title": "Sort By" }, "description": "Field to sort by" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^(asc|desc)$", "description": "Sort order (default: desc)", "default": "desc", "title": "Sort Order" }, "description": "Sort order (default: desc)" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_PaginationResponse_SourceSummaryResponse__" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response List Sources" }, "example": { "success": true, "message": "Sources retrieved successfully", "data": { "total_items": 19, "total_pages": 1, "current_page": 1, "page_size": 100, "items": [ { "id": "853490e8-c574-41ac-8d9f-38e49f3860b0", "created_on": "2026-05-21T08:53:42.285528Z", "last_updated_on": "2026-06-01T12:51:36.846848Z", "installed_on": null, "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "type": "MCPServer", "status": "STALE", "agents_equipped": 2, "imported_tools_count": 5, "application_icon": null, "application_name": "o2c-mcp-source-1" }, { "id": "f5e55d6e-31a3-4d98-945d-817f497193e4", "created_on": "2026-06-01T12:21:19.036858Z", "last_updated_on": "2026-06-01T12:21:19.036858Z", "installed_on": null, "name": "o2c-mcp-source-1", "description": "o2c-mcp-source", "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=", "type": "MCPServer", "status": "ACTIVE", "agents_equipped": 0, "imported_tools_count": 4, "application_icon": null, "application_name": "o2c-mcp-source-1" } ] } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/sources/tools/application/{source_id}": { "get": { "tags": [ "Sources" ], "summary": "Get A Specific Application Source By Id", "description": "Retrieve detailed information about a specific Application/Fabric source.\n\nRequired privileges: `AGENT_GARDEN_ACCESS`, `AGENT_VIEW`.", "operationId": "get_application_source", "parameters": [ { "name": "source_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "description": "The unique identifier of the application source to retrieve", "title": "Source Id" }, "description": "The unique identifier of the application source to retrieve" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SuccessResponse_SystemFabricSourceDetailResponse_" }, { "$ref": "#/components/schemas/ErrorResponse" } ], "title": "Response Get Application Source" }, "example": { "success": true, "message": "Application source retrieved successfully", "data": { "id": "26c6f3d8-8d0f-4af0-8f73-ab0bf8594b92", "created_on": "2026-04-28T08:37:24.682277Z", "last_updated_on": "2026-04-28T08:37:24.682277Z", "installed_on": null, "name": "Gmail", "description": "Google's email service", "application_name": "gmail", "application_icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjUyIDQyIDg4IDY2Ij4NCjxwYXRoIGZpbGw9IiM0Mjg1ZjQiIGQ9Ik01OCAxMDhoMTRWNzRMNTIgNTl2NDNjMCAzLjMyIDIuNjkgNiA2IDYiLz4NCjxwYXRoIGZpbGw9IiMzNGE4NTMiIGQ9Ik0xMjAgMTA4aDE0YzMuMzIgMCA2LTIuNjkgNi02VjU5bC0yMCAxNSIvPg0KPHBhdGggZmlsbD0iI2ZiYmMwNCIgZD0iTTEyMCA0OHYyNmwyMC0xNXYtOGMwLTcuNDItOC40Ny0xMS42NS0xNC40LTcuMiIvPg0KPHBhdGggZmlsbD0iI2VhNDMzNSIgZD0iTTcyIDc0VjQ4bDI0IDE4IDI0LTE4djI2TDk2IDkyIi8+DQo8cGF0aCBmaWxsPSIjYzUyMjFmIiBkPSJNNTIgNTF2OGwyMCAxNVY0OGwtNS42LTQuMmMtNS45NC00LjQ1LTE0LjQtLjIyLTE0LjQgNy4yIi8+DQo8L3N2Zz4=", "status": "ACTIVE", "agents_equipped_count": 0, "tool_counts": { "imported": 3, "active": 3, "disabled": 0, "not_available": 0 }, "imported_tools": [ { "id": "62aa6279-6c8b-43dd-84ab-6d91bcceea0a", "created_on": "2026-04-28T08:37:24.684234Z", "last_updated_on": "2026-04-28T08:37:24.684234Z", "installed_on": "2026-04-28T08:37:24.684234Z", "name": "Create Label", "description": "Create a new label in Gmail", "tool_status": "ACTIVE" }, { "id": "1d89698e-5057-4cf3-82ec-6cf285062346", "created_on": "2026-04-28T08:37:24.684234Z", "last_updated_on": "2026-04-28T08:37:24.684234Z", "installed_on": "2026-04-28T08:37:24.684234Z", "name": "Create Task", "description": "Create a new task in Gmail", "tool_status": "ACTIVE" }, { "id": "ff659ceb-30e7-4ab2-9405-f7ee9b8866e0", "created_on": "2026-04-28T08:37:24.684234Z", "last_updated_on": "2026-04-28T08:37:24.684234Z", "installed_on": "2026-04-28T08:37:24.684234Z", "name": "Send Email", "description": "Send an email via Gmail", "tool_status": "ACTIVE" } ], "fabric_application_id": "gmail" } } } } }, "401": { "description": "Authentication failed \u2014 the credentials are missing, invalid, or expired.", "content": { "application/json": { "example": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error": "Invalid Authentication Token" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "Missing required privileges.", "content": { "application/json": { "example": { "success": false, "error": "You don't have the necessary permissions to perform this action. Please contact your administrator." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Request validation failed.", "content": { "application/json": { "example": { "success": false, "error": "The following fields are required: 'name'. Please make sure they are included and filled out in your request." }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "Agent": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "objective": { "type": "string", "title": "Objective", "description": "Objective of the agent.", "examples": [ "Provide first-line IT support, manage tickets, and escalate complex issues.", "Assists with employee onboarding and provides general HR support." ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the agent.", "default": "Untitled", "examples": [ "ITSupportBot", "HRBuddy" ] }, "personality_traits": { "anyOf": [ { "$ref": "#/components/schemas/PersonalityTraits" }, { "type": "null" } ], "description": "Traits defining the agent's personality." }, "profile_picture": { "anyOf": [ { "$ref": "#/components/schemas/ProfilePicture" }, { "type": "null" } ], "description": "Attributes of the agent's profile picture." }, "conversation_starters": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Conversation Starters", "description": "Suggested conversation openers.", "examples": [ [ "How can I assist you with your IT issue today?", "What kind of technical problem are you experiencing?" ] ] }, "tasks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Task-Output" }, "type": "array" }, { "type": "null" } ], "title": "Tasks", "description": "Tasks assigned to the agent." }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/GuardrailBase-Output" }, { "$ref": "#/components/schemas/Guardrail-Output" }, { "type": "null" } ], "title": "Guardrails", "description": "Safety, compliance, and behavior guidelines for the agent." }, "agent_mode": { "$ref": "#/components/schemas/AgentMode", "description": "Mode of the agent.", "default": "conversational", "examples": [ "conversational", "structured" ] }, "input_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Schema Id", "description": "Unique identifier for the input schema", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "input_schema_type": { "anyOf": [ { "$ref": "#/components/schemas/SchemaType" }, { "type": "null" } ], "description": "Format of input schema for structured agents.", "examples": [ "json", "xml" ] }, "input_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Schema", "description": "Schema that agent expects to receive.", "examples": [ { "additionalProperties": false, "properties": { "name": { "type": "string" }, "age": { "minimum": 0, "type": "integer" } }, "required": [ "name" ], "title": "Person", "type": "object" }, { "items": { "exclusiveMinimum": 0, "type": "number" }, "minItems": 1, "title": "PositiveNumberArray", "type": "array" } ] }, "output_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Schema Id", "description": "Unique identifier for the output schema", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "output_schema_type": { "anyOf": [ { "$ref": "#/components/schemas/SchemaType" }, { "type": "null" } ], "description": "Format of output schema for structured agents.", "examples": [ "json", "xml" ] }, "output_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Schema", "description": "Schema which agent response should adhere to.", "examples": [ { "enum": [ "small", "medium", "large" ], "title": "Size" }, { "additionalProperties": false, "properties": { "title": { "type": "string" }, "author": { "type": "string" }, "publishedAt": { "format": "date-time", "type": "string" } }, "required": [ "title", "author", "publishedAt" ], "title": "BlogPost", "type": "object" } ] }, "inference_configuration": { "anyOf": [ { "$ref": "#/components/schemas/InferenceConfiguration-Output" }, { "type": "null" } ], "description": "Inference settings for Agent LLM." }, "unique_name": { "type": "string", "title": "Unique Name" }, "is_favorite": { "type": "boolean", "title": "Is Favorite", "default": false }, "deployments": { "anyOf": [ { "items": { "$ref": "#/components/schemas/DeploymentDetailed" }, "type": "array" }, { "type": "null" } ], "title": "Deployments", "description": "Deployments associated with the agent." }, "packages_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Packages Count", "description": "Number of packages associated with the agent.", "default": 0 } }, "type": "object", "required": [ "objective" ], "title": "Agent" }, "AgentBase-Input": { "properties": { "objective": { "type": "string", "title": "Objective", "description": "Objective of the agent.", "examples": [ "Provide first-line IT support, manage tickets, and escalate complex issues.", "Assists with employee onboarding and provides general HR support." ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the agent.", "default": "Untitled", "examples": [ "ITSupportBot", "HRBuddy" ] }, "personality_traits": { "anyOf": [ { "$ref": "#/components/schemas/PersonalityTraits" }, { "type": "null" } ], "description": "Traits defining the agent's personality." }, "profile_picture": { "anyOf": [ { "$ref": "#/components/schemas/ProfilePicture" }, { "type": "null" } ], "description": "Attributes of the agent's profile picture." }, "conversation_starters": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Conversation Starters", "description": "Suggested conversation openers.", "examples": [ [ "How can I assist you with your IT issue today?", "What kind of technical problem are you experiencing?" ] ] }, "tasks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Task-Input" }, "type": "array" }, { "type": "null" } ], "title": "Tasks", "description": "Tasks assigned to the agent." }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/GuardrailBase-Input" }, { "$ref": "#/components/schemas/Guardrail-Input" }, { "type": "null" } ], "title": "Guardrails", "description": "Safety, compliance, and behavior guidelines for the agent." }, "agent_mode": { "$ref": "#/components/schemas/AgentMode", "description": "Mode of the agent.", "default": "conversational", "examples": [ "conversational", "structured" ] }, "input_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Schema Id", "description": "Unique identifier for the input schema", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "input_schema_type": { "anyOf": [ { "$ref": "#/components/schemas/SchemaType" }, { "type": "null" } ], "description": "Format of input schema for structured agents.", "examples": [ "json", "xml" ] }, "input_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Schema", "description": "Schema that agent expects to receive.", "examples": [ { "additionalProperties": false, "properties": { "name": { "type": "string" }, "age": { "minimum": 0, "type": "integer" } }, "required": [ "name" ], "title": "Person", "type": "object" }, { "items": { "exclusiveMinimum": 0, "type": "number" }, "minItems": 1, "title": "PositiveNumberArray", "type": "array" } ] }, "output_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Schema Id", "description": "Unique identifier for the output schema", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "output_schema_type": { "anyOf": [ { "$ref": "#/components/schemas/SchemaType" }, { "type": "null" } ], "description": "Format of output schema for structured agents.", "examples": [ "json", "xml" ] }, "output_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Schema", "description": "Schema which agent response should adhere to.", "examples": [ { "enum": [ "small", "medium", "large" ], "title": "Size" }, { "additionalProperties": false, "properties": { "title": { "type": "string" }, "author": { "type": "string" }, "publishedAt": { "format": "date-time", "type": "string" } }, "required": [ "title", "author", "publishedAt" ], "title": "BlogPost", "type": "object" } ] }, "inference_configuration": { "anyOf": [ { "$ref": "#/components/schemas/InferenceConfiguration-Input" }, { "type": "null" } ], "description": "Inference settings for Agent LLM." } }, "type": "object", "required": [ "objective" ], "title": "AgentBase" }, "AgentDetailedResponse": { "additionalProperties": true, "type": "object" }, "AgentFavoriteResponse": { "additionalProperties": true, "type": "object" }, "AgentMode": { "type": "string", "enum": [ "conversational", "structured" ], "title": "AgentMode" }, "AgentOrigin": { "type": "string", "enum": [ "template", "recommendation", "unknown" ], "title": "AgentOrigin", "description": "Enum for agent origin types." }, "AgentSnapshotResponse": { "additionalProperties": true, "type": "object" }, "AgentStatus": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DISABLED" ], "title": "AgentStatus" }, "AgentSummaryResponse": { "additionalProperties": true, "type": "object" }, "AgentUpdate": { "properties": { "objective": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Objective", "description": "Objective of the agent.", "examples": [ "Provide first-line IT support, manage tickets, and escalate complex issues.", "Assists with employee onboarding and provides general HR support." ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the agent.", "default": "Untitled", "examples": [ "ITSupportBot", "HRBuddy" ] }, "personality_traits": { "anyOf": [ { "$ref": "#/components/schemas/PersonalityTraits" }, { "type": "null" } ], "description": "Traits defining the agent's personality." }, "profile_picture": { "anyOf": [ { "$ref": "#/components/schemas/ProfilePicture" }, { "type": "null" } ], "description": "Attributes of the agent's profile picture." }, "conversation_starters": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Conversation Starters", "description": "Suggested conversation openers.", "examples": [ [ "How can I assist you with your IT issue today?", "What kind of technical problem are you experiencing?" ] ] }, "tasks": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Task-Input" }, "type": "array" }, { "type": "null" } ], "title": "Tasks", "description": "Tasks assigned to the agent." }, "guardrails": { "anyOf": [ { "$ref": "#/components/schemas/GuardrailBase-Input" }, { "$ref": "#/components/schemas/Guardrail-Input" }, { "type": "null" } ], "title": "Guardrails", "description": "Safety, compliance, and behavior guidelines for the agent." }, "agent_mode": { "$ref": "#/components/schemas/AgentMode", "description": "Mode of the agent.", "default": "conversational", "examples": [ "conversational", "structured" ] }, "input_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Schema Id", "description": "Unique identifier for the input schema", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "input_schema_type": { "anyOf": [ { "$ref": "#/components/schemas/SchemaType" }, { "type": "null" } ], "description": "Format of input schema for structured agents.", "examples": [ "json", "xml" ] }, "input_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Schema", "description": "Schema that agent expects to receive.", "examples": [ { "additionalProperties": false, "properties": { "name": { "type": "string" }, "age": { "minimum": 0, "type": "integer" } }, "required": [ "name" ], "title": "Person", "type": "object" }, { "items": { "exclusiveMinimum": 0, "type": "number" }, "minItems": 1, "title": "PositiveNumberArray", "type": "array" } ] }, "output_schema_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Schema Id", "description": "Unique identifier for the output schema", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "output_schema_type": { "anyOf": [ { "$ref": "#/components/schemas/SchemaType" }, { "type": "null" } ], "description": "Format of output schema for structured agents.", "examples": [ "json", "xml" ] }, "output_schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output Schema", "description": "Schema which agent response should adhere to.", "examples": [ { "enum": [ "small", "medium", "large" ], "title": "Size" }, { "additionalProperties": false, "properties": { "title": { "type": "string" }, "author": { "type": "string" }, "publishedAt": { "format": "date-time", "type": "string" } }, "required": [ "title", "author", "publishedAt" ], "title": "BlogPost", "type": "object" } ] }, "inference_configuration": { "anyOf": [ { "$ref": "#/components/schemas/InferenceConfiguration-Input" }, { "type": "null" } ], "description": "Inference settings for Agent LLM." } }, "type": "object", "title": "AgentUpdate" }, "DPPValue": { "properties": { "static_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Static Value", "description": "A static string value provided by the user.", "examples": [ "sample_value", "12345" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "The name of the input parameter to be used.", "examples": [ "data_source", "query" ] } }, "type": "object", "title": "DPPValue" }, "DeniedTopicConfiguration": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the denied topic policy.", "examples": [ "Prevent the disclosure of sensitive company or personal information.", "Ensure confidentiality of employee information." ] }, "sample_phrases": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Sample Phrases", "description": "Sample phrases that trigger the denied topic policy.", "default": [], "examples": [ "What's the password for the admin account?", "Can you give me access to another user's email?", "What's the company's confidential project codename?" ] } }, "type": "object", "title": "DeniedTopicConfiguration" }, "Deployment": { "properties": { "package_id": { "type": "string", "title": "Package Id", "description": "The Package ID related to the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The ID of the environment that the package is deployed to.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "deployment_id": { "type": "string", "title": "Deployment Id", "description": "The unique identifier for the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "agent_id": { "type": "string", "title": "Agent Id", "description": "The ID of the agent related to the package that is deployed.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "deployment_status": { "$ref": "#/components/schemas/DeploymentStatus", "description": "Status of the deployment.", "default": "ACTIVE", "examples": [ "active", "disabled" ] }, "deployed_on": { "type": "string", "format": "date-time", "title": "Deployed On", "description": "Timestamp when the package was deployed.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "deployed_by": { "type": "string", "title": "Deployed By", "description": "User who created the deployed the Agent Package.", "default": "system", "examples": [ "admin_user" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:00:00+00:00" ] } }, "type": "object", "required": [ "package_id", "environment_id" ], "title": "Deployment", "description": "Schema for storing deployment data in database" }, "DeploymentBase": { "properties": { "package_id": { "type": "string", "title": "Package Id", "description": "The Package ID related to the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The ID of the environment that the package is deployed to.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] } }, "type": "object", "required": [ "package_id", "environment_id" ], "title": "DeploymentBase", "description": "Base information required to create an agent deployment. " }, "DeploymentDetailed": { "properties": { "package_id": { "type": "string", "title": "Package Id", "description": "The Package ID related to the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The ID of the environment that the package is deployed to.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "deployment_id": { "type": "string", "title": "Deployment Id", "description": "The unique identifier for the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "agent_id": { "type": "string", "title": "Agent Id", "description": "The ID of the agent related to the package that is deployed.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "deployment_status": { "$ref": "#/components/schemas/DeploymentStatus", "description": "Status of the deployment.", "default": "ACTIVE", "examples": [ "active", "disabled" ] }, "deployed_on": { "type": "string", "format": "date-time", "title": "Deployed On", "description": "Timestamp when the package was deployed.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "deployed_by": { "type": "string", "title": "Deployed By", "description": "User who created the deployed the Agent Package.", "default": "system", "examples": [ "admin_user" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "agent_name": { "type": "string", "title": "Agent Name", "description": "Name of the agent." }, "agent_mode": { "$ref": "#/components/schemas/AgentMode", "description": "Mode of the agent." }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/AgentOrigin" }, { "type": "null" } ], "description": "Origin of the agent: 'template', 'recommendation', 'unknown', or None", "examples": [ "template", "recommendation", "unknown", null ] }, "is_favorite": { "type": "boolean", "title": "Is Favorite", "description": "Whether the agent associated with the deployment is marked as favorite.", "default": false }, "profile_picture": { "anyOf": [ { "$ref": "#/components/schemas/ProfilePicture" }, { "type": "null" } ], "description": "Attributes of the agent's profile picture." }, "package_version": { "type": "string", "title": "Package Version", "description": "Version of the package" }, "package_name": { "type": "string", "title": "Package Name", "description": "Name of the package" }, "environment_name": { "type": "string", "title": "Environment Name", "description": "Name of the environment" }, "runtimes": { "items": { "$ref": "#/components/schemas/RuntimeInfo" }, "type": "array", "title": "Runtimes", "description": "List of runtimes associated with the environment that the agent package is deployed to." } }, "type": "object", "required": [ "package_id", "environment_id", "agent_name", "agent_mode", "package_version", "package_name", "environment_name", "runtimes" ], "title": "DeploymentDetailed" }, "DeploymentResponse": { "properties": { "package_id": { "type": "string", "title": "Package Id", "description": "The Package ID related to the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The ID of the environment that the package is deployed to.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "deployment_id": { "type": "string", "title": "Deployment Id", "description": "The unique identifier for the deployment.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "agent_id": { "type": "string", "title": "Agent Id", "description": "The ID of the agent related to the package that is deployed.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "deployment_status": { "$ref": "#/components/schemas/DeploymentStatus", "description": "Status of the deployment.", "default": "ACTIVE", "examples": [ "active", "disabled" ] }, "deployed_on": { "type": "string", "format": "date-time", "title": "Deployed On", "description": "Timestamp when the package was deployed.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "deployed_by": { "type": "string", "title": "Deployed By", "description": "User who created the deployed the Agent Package.", "default": "system", "examples": [ "admin_user" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "agent_name": { "type": "string", "title": "Agent Name", "description": "Name of the agent." }, "agent_mode": { "$ref": "#/components/schemas/AgentMode", "description": "Mode of the agent." }, "origin": { "anyOf": [ { "$ref": "#/components/schemas/AgentOrigin" }, { "type": "null" } ], "description": "Origin of the agent: 'template', 'recommendation', 'unknown', or None", "examples": [ "template", "recommendation", "unknown", null ] }, "is_favorite": { "type": "boolean", "title": "Is Favorite", "description": "Whether the agent associated with the deployment is marked as favorite.", "default": false }, "profile_picture": { "anyOf": [ { "$ref": "#/components/schemas/ProfilePicture" }, { "type": "null" } ], "description": "Attributes of the agent's profile picture." }, "package_version": { "type": "string", "title": "Package Version", "description": "Version of the package" }, "package_name": { "type": "string", "title": "Package Name", "description": "Name of the package" }, "environment_name": { "type": "string", "title": "Environment Name", "description": "Name of the environment" }, "runtimes": { "items": { "$ref": "#/components/schemas/RuntimeInfo" }, "type": "array", "title": "Runtimes", "description": "List of runtimes associated with the environment that the agent package is deployed to." } }, "type": "object", "required": [ "package_id", "environment_id", "agent_name", "agent_mode", "package_version", "package_name", "environment_name", "runtimes" ], "title": "DeploymentResponse", "description": "Response for retrieving agent deployment through list endpoints" }, "DeploymentStatus": { "type": "string", "enum": [ "ACTIVE", "DISABLED" ], "title": "DeploymentStatus" }, "EnvironmentClassification": { "type": "string", "enum": [ "PRODUCTION", "TEST" ], "title": "EnvironmentClassification" }, "EnvironmentResponse": { "properties": { "integration_environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integration Environment Id", "description": "The unique identifier for the Environment from Integration", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "ag_environment_id": { "type": "string", "title": "Ag Environment Id", "description": "The unique identifier for the Environment in Agent Garden.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the environment." }, "classification": { "$ref": "#/components/schemas/EnvironmentClassification", "description": "Classification of the environment", "examples": [ "production", "test" ] }, "status": { "$ref": "#/components/schemas/EnvironmentStatus", "description": "Status of the environment", "default": "ATTACHED", "examples": [ "ATTACHED", "DETACHED", "DELETED" ] }, "source": { "$ref": "#/components/schemas/EnvironmentSource", "description": "Source of the environment", "default": "INTEGRATION", "examples": [ "integration", "agent_garden" ] }, "is_default": { "type": "boolean", "title": "Is Default", "description": "Indicates default environment for agent deployments", "default": false, "examples": [ false, true ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the Agent Garden environment was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the environment was last updated.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "runtimes": { "items": { "$ref": "#/components/schemas/RuntimeInfo" }, "type": "array", "title": "Runtimes", "description": "List of runtimes associated with the environment.", "default": [], "examples": [ [ { "runtime_id": "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" } ] ] }, "deployment_count": { "type": "integer", "title": "Deployment Count", "description": "Number of agent deployments associated with the environment.", "default": 0, "examples": [ 5 ] } }, "type": "object", "required": [ "classification" ], "title": "EnvironmentResponse" }, "EnvironmentSource": { "type": "string", "enum": [ "INTEGRATION", "AGENT_GARDEN" ], "title": "EnvironmentSource" }, "EnvironmentStatus": { "type": "string", "enum": [ "ATTACHED", "DETACHED" ], "title": "EnvironmentStatus" }, "ErrorResponse": { "additionalProperties": true, "type": "object" }, "FilterField": { "properties": { "field_id": { "type": "string", "title": "Field Id", "description": "Unique ID of the Hub field to be filtered against", "examples": [ "ACCOUNT_ID", "FIRST_NAME", "ZIP_CODE" ] }, "operator": { "type": "string", "title": "Operator", "description": "Type of operator that determines how to filter the field id based on a given value", "examples": [ "STARTS_WITH", "EQUALS", "IS_NOT_NULL" ] }, "values": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FilterValue" }, "type": "array" }, { "type": "null" } ], "title": "Values", "description": "List of values used to filter field_id using the provided operator.Multiple values can be provided if the operator is BETWEEN or if the data type of the field to be filtered is enumeration.This is optional since some operators do not take any values such as IS_NULL", "examples": [ [ { "static_value": "boomi_" } ], [ { "input_parameter_name": "account_id" } ], [ { "static_value": "12345" }, { "input_parameter_name": "query" } ] ] } }, "type": "object", "required": [ "field_id", "operator" ], "title": "FilterField" }, "FilterValue": { "properties": { "static_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Static Value", "description": "A static string value provided by the user.", "examples": [ "sample_value", "12345" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "The name of the input parameter to be used.", "examples": [ "data_source", "query" ] } }, "type": "object", "title": "FilterValue" }, "Guardrail-Input": { "properties": { "blocked_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Blocked Message", "description": "Message shown when a blocked action is attempted.", "examples": [ "I'm not able to disclose that information for privacy", "I'm sorry, but I can't disclose confidential employee information." ] }, "system": { "type": "boolean", "title": "System", "description": "If it is the system guardrail", "default": false }, "policies": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Policy" }, "type": "array" }, { "type": "null" } ], "title": "Policies", "description": "List of policies enforced by this guardrail.", "default": [], "examples": [ [ { "configuration": { "description": "Prevent the disclosure of sensitive company or personal information.", "sample_phrases": [ "What's the password for the admin account?", "Can you give me access to another user's email?", "What's the company's confidential project codename?" ] }, "name": "Data Privacy Compliance", "type": "denied_topic" }, { "configuration": { "words": [ "prohibited", "banned", "restricted" ] }, "name": "Prohibited Terms Policy", "type": "word_filter" }, { "configuration": { "pattern": "\\b\\w{8,}\\b" }, "name": "Regex Pattern Validation", "type": "regex_pattern" } ] ] }, "id": { "type": "string", "title": "Id", "description": "Unique identifier for the guardrail.", "examples": [ "123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001" ] } }, "type": "object", "title": "Guardrail" }, "Guardrail-Output": { "properties": { "blocked_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Blocked Message", "description": "Message shown when a blocked action is attempted.", "examples": [ "I'm not able to disclose that information for privacy", "I'm sorry, but I can't disclose confidential employee information." ] }, "system": { "type": "boolean", "title": "System", "description": "If it is the system guardrail", "default": false }, "policies": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Policy" }, "type": "array" }, { "type": "null" } ], "title": "Policies", "description": "List of policies enforced by this guardrail.", "default": [], "examples": [ [ { "configuration": { "description": "Prevent the disclosure of sensitive company or personal information.", "sample_phrases": [ "What's the password for the admin account?", "Can you give me access to another user's email?", "What's the company's confidential project codename?" ] }, "name": "Data Privacy Compliance", "type": "denied_topic" }, { "configuration": { "words": [ "prohibited", "banned", "restricted" ] }, "name": "Prohibited Terms Policy", "type": "word_filter" }, { "configuration": { "pattern": "\\b\\w{8,}\\b" }, "name": "Regex Pattern Validation", "type": "regex_pattern" } ] ] }, "id": { "type": "string", "title": "Id", "description": "Unique identifier for the guardrail.", "examples": [ "123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001" ] } }, "type": "object", "title": "Guardrail" }, "GuardrailBase-Input": { "properties": { "blocked_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Blocked Message", "description": "Message shown when a blocked action is attempted.", "examples": [ "I'm not able to disclose that information for privacy", "I'm sorry, but I can't disclose confidential employee information." ] }, "system": { "type": "boolean", "title": "System", "description": "If it is the system guardrail", "default": false }, "policies": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Policy" }, "type": "array" }, { "type": "null" } ], "title": "Policies", "description": "List of policies enforced by this guardrail.", "default": [], "examples": [ [ { "configuration": { "description": "Prevent the disclosure of sensitive company or personal information.", "sample_phrases": [ "What's the password for the admin account?", "Can you give me access to another user's email?", "What's the company's confidential project codename?" ] }, "name": "Data Privacy Compliance", "type": "denied_topic" }, { "configuration": { "words": [ "prohibited", "banned", "restricted" ] }, "name": "Prohibited Terms Policy", "type": "word_filter" }, { "configuration": { "pattern": "\\b\\w{8,}\\b" }, "name": "Regex Pattern Validation", "type": "regex_pattern" } ] ] } }, "type": "object", "title": "GuardrailBase" }, "GuardrailBase-Output": { "properties": { "blocked_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Blocked Message", "description": "Message shown when a blocked action is attempted.", "examples": [ "I'm not able to disclose that information for privacy", "I'm sorry, but I can't disclose confidential employee information." ] }, "system": { "type": "boolean", "title": "System", "description": "If it is the system guardrail", "default": false }, "policies": { "anyOf": [ { "items": { "$ref": "#/components/schemas/Policy" }, "type": "array" }, { "type": "null" } ], "title": "Policies", "description": "List of policies enforced by this guardrail.", "default": [], "examples": [ [ { "configuration": { "description": "Prevent the disclosure of sensitive company or personal information.", "sample_phrases": [ "What's the password for the admin account?", "Can you give me access to another user's email?", "What's the company's confidential project codename?" ] }, "name": "Data Privacy Compliance", "type": "denied_topic" }, { "configuration": { "words": [ "prohibited", "banned", "restricted" ] }, "name": "Prohibited Terms Policy", "type": "word_filter" }, { "configuration": { "pattern": "\\b\\w{8,}\\b" }, "name": "Regex Pattern Validation", "type": "regex_pattern" } ] ] } }, "type": "object", "title": "GuardrailBase" }, "HTTPMethod": { "type": "string", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "" ], "title": "HTTPMethod" }, "HubTool": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "repository_id": { "type": "string", "title": "Repository Id", "description": "The unique identifier of the repository within the Hub system.", "default": "", "examples": [ "dbe797ff-6d6f-44e9-acd9-d77494a44b15", "3093b444-0632-4bdc-98b6-27845860a40c" ] }, "repository_name": { "type": "string", "title": "Repository Name", "description": "The human-readable name of the repository within the Hub system.", "default": "Repository", "examples": [ "Demo Repository" ] }, "universe_id": { "type": "string", "title": "Universe Id", "description": "The unique identifier of the Hub universe that the repository belongs to.", "default": "", "examples": [ "04ea04cc-9df8-4004-bc00-a21b7dede1bb", "1d969a54-49e5-4f75-974a-85869280873d" ] }, "universe_name": { "type": "string", "title": "Universe Name", "description": "The human-readable name of the Hub universe that the repository belongs to.", "default": "Universe", "examples": [ "Contacts" ] }, "cloud_host": { "type": "string", "title": "Cloud Host", "description": "URL of the host attached to the repository where the universe is stored.", "default": "", "examples": [ "https://c01-usa-east.integrate.boomi.com" ] }, "fields": { "items": { "$ref": "#/components/schemas/UniverseField" }, "type": "array", "title": "Fields", "description": "A list of fields with their corresponding names and paths within the repository.", "examples": [ [ { "data_type": "STRING", "path": "/accounts/account_name", "pretty_name": "Account Name", "repeatable": "true", "unique_id": "ACCOUNT_NAME" }, { "data_type": "STRING", "path": "/accounts/address/zip_code", "pretty_name": "zipcode", "repeatable": "true", "unique_id": "ZIP_CODE" } ] ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Number of records that the query should return", "default": 200, "examples": [ 1, 100 ] }, "filter_operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Operator", "description": "Operator to determine how to query with multiple filters. AND will query data where records conform to all filters given. OR will query data where records conform to at least 1 filter.", "examples": [ "AND", "OR" ] }, "filter_fields": { "items": { "$ref": "#/components/schemas/FilterField" }, "type": "array", "title": "Filter Fields", "description": "A set of filter criteria to narrow down the query results. Filters can include various types of conditions such as date ranges, string matches, or numerical limits.", "examples": [ [ { "field_id": "ACCOUNT_NAME", "operator": "STARTS_WITH", "values": [ { "static_value": "boomi_" } ] }, { "field_id": "TOTAL", "operator": "GREATER_THAN", "values": [ { "input_parameter_name": "total_value" } ] } ], [ { "field_id": "LAST_MODIFIED_DATE", "operator": "BETWEEN", "values": [ { "static_value": "2023-01-01" }, { "input_parameter_name": "end_date" } ] }, { "field_id": "SUCCESS", "operator": "EQUALS", "values": [ { "static_value": "true" } ] } ] ] }, "unique_name": { "type": "string", "title": "Unique Name" }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the agent.", "default": "DRAFT", "examples": [ "DRAFT", "ACTIVE", "DISABLED" ] } }, "type": "object", "required": [ "name" ], "title": "HubTool" }, "HubToolBase": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "repository_id": { "type": "string", "title": "Repository Id", "description": "The unique identifier of the repository within the Hub system.", "default": "", "examples": [ "dbe797ff-6d6f-44e9-acd9-d77494a44b15", "3093b444-0632-4bdc-98b6-27845860a40c" ] }, "repository_name": { "type": "string", "title": "Repository Name", "description": "The human-readable name of the repository within the Hub system.", "default": "Repository", "examples": [ "Demo Repository" ] }, "universe_id": { "type": "string", "title": "Universe Id", "description": "The unique identifier of the Hub universe that the repository belongs to.", "default": "", "examples": [ "04ea04cc-9df8-4004-bc00-a21b7dede1bb", "1d969a54-49e5-4f75-974a-85869280873d" ] }, "universe_name": { "type": "string", "title": "Universe Name", "description": "The human-readable name of the Hub universe that the repository belongs to.", "default": "Universe", "examples": [ "Contacts" ] }, "cloud_host": { "type": "string", "title": "Cloud Host", "description": "URL of the host attached to the repository where the universe is stored.", "default": "", "examples": [ "https://c01-usa-east.integrate.boomi.com" ] }, "fields": { "items": { "$ref": "#/components/schemas/UniverseField" }, "type": "array", "title": "Fields", "description": "A list of fields with their corresponding names and paths within the repository.", "examples": [ [ { "data_type": "STRING", "path": "/accounts/account_name", "pretty_name": "Account Name", "repeatable": "true", "unique_id": "ACCOUNT_NAME" }, { "data_type": "STRING", "path": "/accounts/address/zip_code", "pretty_name": "zipcode", "repeatable": "true", "unique_id": "ZIP_CODE" } ] ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Number of records that the query should return", "default": 200, "examples": [ 1, 100 ] }, "filter_operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Operator", "description": "Operator to determine how to query with multiple filters. AND will query data where records conform to all filters given. OR will query data where records conform to at least 1 filter.", "examples": [ "AND", "OR" ] }, "filter_fields": { "items": { "$ref": "#/components/schemas/FilterField" }, "type": "array", "title": "Filter Fields", "description": "A set of filter criteria to narrow down the query results. Filters can include various types of conditions such as date ranges, string matches, or numerical limits.", "examples": [ [ { "field_id": "ACCOUNT_NAME", "operator": "STARTS_WITH", "values": [ { "static_value": "boomi_" } ] }, { "field_id": "TOTAL", "operator": "GREATER_THAN", "values": [ { "input_parameter_name": "total_value" } ] } ], [ { "field_id": "LAST_MODIFIED_DATE", "operator": "BETWEEN", "values": [ { "static_value": "2023-01-01" }, { "input_parameter_name": "end_date" } ] }, { "field_id": "SUCCESS", "operator": "EQUALS", "values": [ { "static_value": "true" } ] } ] ] } }, "type": "object", "required": [ "name" ], "title": "HubToolBase" }, "HubToolUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool.", "examples": [ "Query_Customer_Data" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "examples": [ "Query data from Customer Hub universe" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "repository_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Repository Id", "description": "The unique identifier of the repository within the Hub system.", "examples": [ "dbe797ff-6d6f-44e9-acd9-d77494a44b15", "3093b444-0632-4bdc-98b6-27845860a40c" ] }, "repository_name": { "type": "string", "title": "Repository Name", "description": "The human-readable name of the repository within the Hub system.", "default": "Repository", "examples": [ "Demo Repository" ] }, "universe_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Universe Id", "description": "The unique identifier of the Hub universe that the repository belongs to.", "examples": [ "04ea04cc-9df8-4004-bc00-a21b7dede1bb", "1d969a54-49e5-4f75-974a-85869280873d" ] }, "universe_name": { "type": "string", "title": "Universe Name", "description": "The human-readable name of the Hub universe that the repository belongs to.", "default": "Universe", "examples": [ "Contacts" ] }, "cloud_host": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cloud Host", "description": "URL of the host attached to the repository where the universe is stored.", "examples": [ "https://c01-usa-east.integrate.boomi.com" ] }, "fields": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UniverseField" }, "type": "array" }, { "type": "null" } ], "title": "Fields", "description": "A list of fields with their corresponding names and paths within the repository.", "examples": [ [ { "data_type": "STRING", "path": "/accounts/account_name", "pretty_name": "Account Name", "repeatable": "true", "unique_id": "ACCOUNT_NAME" }, { "data_type": "STRING", "path": "/accounts/address/zip_code", "pretty_name": "zipcode", "repeatable": "true", "unique_id": "ZIP_CODE" } ] ] }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit", "description": "Number of records that the query should return", "default": 200, "examples": [ 1, 100 ] }, "filter_operator": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Operator", "description": "Operator to determine how to query with multiple filters. AND will query data where records conform to all filters given. OR will query data where records conform to at least 1 filter.", "examples": [ "AND", "OR" ] }, "filter_fields": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FilterField" }, "type": "array" }, { "type": "null" } ], "title": "Filter Fields", "description": "A set of filter criteria to narrow down the query results. Filters can include various types of conditions such as date ranges, string matches, or numerical limits.", "examples": [ [ { "field_id": "ACCOUNT_NAME", "operator": "STARTS_WITH", "values": [ { "static_value": "boomi_" } ] }, { "field_id": "TOTAL", "operator": "GREATER_THAN", "values": [ { "input_parameter_name": "total_value" } ] } ], [ { "field_id": "LAST_MODIFIED_DATE", "operator": "BETWEEN", "values": [ { "static_value": "2023-01-01" }, { "input_parameter_name": "end_date" } ] }, { "field_id": "SUCCESS", "operator": "EQUALS", "values": [ { "static_value": "true" } ] } ] ] } }, "type": "object", "title": "HubToolUpdate" }, "InferenceConfiguration-Input": { "properties": { "performance_config": { "$ref": "#/components/schemas/PerformanceConfig" } }, "type": "object", "title": "InferenceConfiguration", "description": "Configuration model for inference settings.\n\n:param performance_config: Performance configuration settings\n\n:type performance_config: Optional[PerformanceConfig]" }, "InferenceConfiguration-Output": { "properties": { "performance_config": { "$ref": "#/components/schemas/PerformanceConfig" } }, "type": "object", "title": "InferenceConfiguration", "description": "Configuration model for inference settings.\n\n:param performance_config: Performance configuration settings\n\n:type performance_config: Optional[PerformanceConfig]" }, "IntegrationEnvironmentResponse": { "properties": { "integration_environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integration Environment Id", "description": "The unique identifier for the Environment from Integration", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "ag_environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ag Environment Id", "description": "The unique identifier for the Environment in Agent Garden." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the environment." }, "classification": { "$ref": "#/components/schemas/EnvironmentClassification", "description": "Classification of the environment", "examples": [ "production", "test" ] }, "status": { "$ref": "#/components/schemas/EnvironmentStatus", "description": "Status of the environment", "default": "DETACHED" }, "source": { "$ref": "#/components/schemas/EnvironmentSource", "description": "Source of the environment", "default": "INTEGRATION" }, "is_default": { "type": "boolean", "title": "Is Default", "description": "Indicates default environment for agent deployments", "default": false, "examples": [ false, true ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the Agent Garden environment was created." }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the Agent Garden environment was updated." }, "runtimes": { "items": { "$ref": "#/components/schemas/RuntimeInfo" }, "type": "array", "title": "Runtimes", "description": "List of runtimes associated with the environment.", "default": [], "examples": [ [ { "runtime_id": "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" } ] ] }, "deployment_count": { "type": "integer", "title": "Deployment Count", "description": "Number of agent deployments associated with the environment.", "default": 0, "examples": [ 5 ] } }, "type": "object", "required": [ "classification" ], "title": "IntegrationEnvironmentResponse", "description": "Response object for Detached Integration Environments to display in the AG environments page.\nTimestamps for created_on and last_updated_on are set to None since no AG environment has been created yet." }, "IntegrationTool": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The unique identifier for the environment in which the integration is deployed.", "default": "", "examples": [ "c763db7e-578a-4061-b76e-18cea938cede" ] }, "environment_name": { "type": "string", "title": "Environment Name", "description": "The human-readable name of the environment in which the integration is deployed.", "default": "Environment", "examples": [ "Production" ] }, "atom_id": { "type": "string", "title": "Atom Id", "description": "The unique identifier for the atom responsible for running the integration process.", "default": "", "examples": [ "90a00892-6656-4162-9672-f3da314ad2d9" ] }, "atom_name": { "type": "string", "title": "Atom Name", "description": "The human-readable name of the atom responsible for running the integration process.", "default": "Atom", "examples": [ "Demo" ] }, "process_id": { "type": "string", "title": "Process Id", "description": "The unique identifier for the specific process to be executed.", "default": "", "examples": [ "c1bff7c6-b0af-4531-b39c-2b3204445508" ] }, "process_name": { "type": "string", "title": "Process Name", "description": "The human-readable name of the specific process to be executed.", "default": "Process", "examples": [ "Order Processing" ] }, "dynamic_process_properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/DPPValue" }, "type": "object" }, { "type": "null" } ], "title": "Dynamic Process Properties", "description": "A set of dynamic process properties represented as key-value pairs. Keys are strings representing the property names, and values are instances of DPPValue, allowing for either static values or references to input parameters.", "examples": [ { "dpp_data_source": { "static_value": "data_source_value" }, "dpp_query": { "input_parameter_name": "query" } } ] }, "unique_name": { "type": "string", "title": "Unique Name" }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the agent.", "default": "DRAFT", "examples": [ "DRAFT", "ACTIVE", "DISABLED" ] } }, "type": "object", "required": [ "name" ], "title": "IntegrationTool" }, "IntegrationToolBase": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The unique identifier for the environment in which the integration is deployed.", "default": "", "examples": [ "c763db7e-578a-4061-b76e-18cea938cede" ] }, "environment_name": { "type": "string", "title": "Environment Name", "description": "The human-readable name of the environment in which the integration is deployed.", "default": "Environment", "examples": [ "Production" ] }, "atom_id": { "type": "string", "title": "Atom Id", "description": "The unique identifier for the atom responsible for running the integration process.", "default": "", "examples": [ "90a00892-6656-4162-9672-f3da314ad2d9" ] }, "atom_name": { "type": "string", "title": "Atom Name", "description": "The human-readable name of the atom responsible for running the integration process.", "default": "Atom", "examples": [ "Demo" ] }, "process_id": { "type": "string", "title": "Process Id", "description": "The unique identifier for the specific process to be executed.", "default": "", "examples": [ "c1bff7c6-b0af-4531-b39c-2b3204445508" ] }, "process_name": { "type": "string", "title": "Process Name", "description": "The human-readable name of the specific process to be executed.", "default": "Process", "examples": [ "Order Processing" ] }, "dynamic_process_properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/DPPValue" }, "type": "object" }, { "type": "null" } ], "title": "Dynamic Process Properties", "description": "A set of dynamic process properties represented as key-value pairs. Keys are strings representing the property names, and values are instances of DPPValue, allowing for either static values or references to input parameters.", "examples": [ { "dpp_data_source": { "static_value": "data_source_value" }, "dpp_query": { "input_parameter_name": "query" } } ] } }, "type": "object", "required": [ "name" ], "title": "IntegrationToolBase" }, "IntegrationToolUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool.", "examples": [ "Update_Salesforce_Opportunity" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "examples": [ "Updates Salesforce opportunity" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id", "description": "The unique identifier for the environment in which the integration is deployed.", "examples": [ "c763db7e-578a-4061-b76e-18cea938cede" ] }, "environment_name": { "type": "string", "title": "Environment Name", "description": "The human-readable name of the environment in which the integration is deployed.", "default": "Environment", "examples": [ "Production" ] }, "atom_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Atom Id", "description": "The unique identifier for the atom responsible for running the integration process.", "examples": [ "90a00892-6656-4162-9672-f3da314ad2d9" ] }, "atom_name": { "type": "string", "title": "Atom Name", "description": "The human-readable name of the atom responsible for running the integration process.", "default": "Atom", "examples": [ "Demo" ] }, "process_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Process Id", "description": "The unique identifier for the specific process to be executed.", "examples": [ "c1bff7c6-b0af-4531-b39c-2b3204445508" ] }, "process_name": { "type": "string", "title": "Process Name", "description": "The human-readable name of the specific process to be executed.", "default": "Process", "examples": [ "Order Processing" ] }, "dynamic_process_properties": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/DPPValue" }, "type": "object" }, { "type": "null" } ], "title": "Dynamic Process Properties", "description": "A set of dynamic process properties represented as key-value pairs. Keys are strings representing the property names, and values are instances of DPPValue, allowing for either static values or references to input parameters.", "examples": [ { "dpp_data_source": { "static_value": "data_source_value" }, "dpp_query": { "input_parameter_name": "query" } } ] } }, "type": "object", "title": "IntegrationToolUpdate" }, "MCPInputParameters": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the input parameter.", "examples": [ "data_source", "query", "user_id" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the input parameter.", "examples": [ "The source of the data to be analyzed", "The user's question or request", "Unique identifier for the user" ] }, "required": { "type": "boolean", "title": "Required", "description": "Whether the input parameter is required.", "examples": [ true, false ] }, "type": { "$ref": "#/components/schemas/SourceParamType", "description": "Type of the input parameter.", "examples": [ "string", "integer", "float", "number", "array", "object", "null" ] }, "server_default": { "anyOf": [ {}, { "type": "null" } ], "title": "Server Default", "description": "Default MCP server default value", "examples": [ "table", null ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Data Source", "examples": [ "Get table schema", "Object Type" ] }, "user_default": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Default", "description": "Default MCP user default value", "examples": [ "table", null ] } }, "type": "object", "required": [ "name", "description", "required", "type" ], "title": "MCPInputParameters", "description": "Input parameter schema for MCP server tools with server defaults, user defaults, and display titles." }, "MCPServer": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Human-readable name which is defined from UI.", "examples": [ "Document Processing Server", "Data Analytics MCP" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional server description.", "examples": [ "A server for processing various document formats" ] }, "url": { "type": "string", "title": "Url", "description": "Base connection URL (NOT NULL for SSE/HTTP).", "examples": [ "https://api.example.com/mcp", "sse://server.example.com:8080" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "UI Intended server title.", "examples": [ "Document Processing Service" ] }, "headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerHeaders" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Headers", "description": "Optional Server Headers.", "examples": [ { "name": "Authorization", "static_value": "Bearer token" }, { "name": "Content-Type", "static_value": "application/json" } ] }, "transport_type": { "$ref": "#/components/schemas/MCPServerTransportType", "description": "How the server communicates.", "examples": [ "HTTP" ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerAuthentication-Output" }, { "type": "string" }, { "type": "null" } ], "title": "Authentication", "description": "Authentication configuration for the API endpoint.", "examples": [ { "config": { "password": "", "username": "" }, "type": "basic_auth" }, { "config": { "key": "", "name": "X-API-Key" }, "type": "token_auth" } ] }, "tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "List of tools names to include from the MCP server. If not specified, all tools will be included.", "default": [], "examples": [ [ "document_parser", "data_analyzer", "file_processor" ] ] }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "description": "Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.", "examples": [ { "is_latest": true, "provenance": { "sourceType": "external_registry" }, "registry_server_name": "ai.adadvisor/mcp-server", "registry_version": "1.0.1", "source_id": "019d8c94-b4c4-73e3-90b8-57716878c8db", "source_name": "Boomi Connect" } ] }, "status": { "$ref": "#/components/schemas/MCPServerStatus", "description": "Server lifecycle status.", "default": "ACTIVE", "examples": [ "ACTIVE" ] }, "unique_name": { "type": "string", "title": "Unique Name", "description": "Unique name of the MCP Server." }, "agents_equipped_count": { "type": "integer", "title": "Agents Equipped Count", "description": "Count of agent equipped", "default": 0, "examples": [ 3 ] }, "tool_counts": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolCounts" }, { "type": "null" } ], "description": "Count of tools count" }, "imported_tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerImportedTool-Output" }, "type": "array" }, { "type": "null" } ], "title": "Imported Tools", "description": "List of tools names to include from the MCP server.", "default": [] }, "available_tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerAvailableTools-Output" }, "type": "array" }, { "type": "null" } ], "title": "Available Tools", "description": "Available tools for MCP", "default": [] }, "tool_changes": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerToolChanges" }, { "type": "null" } ], "description": "Dictionary of tools changes" } }, "type": "object", "required": [ "name", "url", "transport_type" ], "title": "MCPServer", "description": "Complete schema for MCP server representation in API responses." }, "MCPServerAuthentication-Input": { "properties": { "type": { "$ref": "#/components/schemas/MCPServerAuthenticationType" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerBasicAuthConfig" }, { "$ref": "#/components/schemas/MCPServerTokenAuth" }, { "$ref": "#/components/schemas/MCPServerOAuth" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "required": [ "type" ], "title": "MCPServerAuthentication", "description": "Schema for MCP server authentication configuration." }, "MCPServerAuthentication-Output": { "properties": { "type": { "$ref": "#/components/schemas/MCPServerAuthenticationType" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerBasicAuthConfig" }, { "$ref": "#/components/schemas/MCPServerTokenAuth" }, { "$ref": "#/components/schemas/MCPServerOAuth" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "required": [ "type" ], "title": "MCPServerAuthentication", "description": "Schema for MCP server authentication configuration." }, "MCPServerAuthenticationType": { "type": "string", "enum": [ "token_auth", "basic_auth", "platform_jwt", "oauth" ], "title": "MCPServerAuthenticationType", "description": "Enumeration of supported authentication methods for MCP servers." }, "MCPServerAvailableTools-Input": { "properties": { "name": { "type": "string", "title": "Name", "description": "Available Tool name.", "default": "" }, "new_schema": { "$ref": "#/components/schemas/ToolSchema-Input", "description": "Tool new schema." } }, "type": "object", "title": "MCPServerAvailableTools", "description": "Schema representing tools available on an MCP server but not yet imported." }, "MCPServerAvailableTools-Output": { "properties": { "name": { "type": "string", "title": "Name", "description": "Available Tool name.", "default": "" }, "new_schema": { "$ref": "#/components/schemas/ToolSchema-Output", "description": "Tool new schema." } }, "type": "object", "title": "MCPServerAvailableTools", "description": "Schema representing tools available on an MCP server but not yet imported." }, "MCPServerBase": { "properties": { "name": { "type": "string", "title": "Name", "description": "Human-readable name which is defined from UI.", "examples": [ "Document Processing Server", "Data Analytics MCP" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional server description.", "examples": [ "A server for processing various document formats" ] }, "url": { "type": "string", "title": "Url", "description": "Base connection URL (NOT NULL for SSE/HTTP).", "examples": [ "https://api.example.com/mcp", "sse://server.example.com:8080" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "UI Intended server title.", "examples": [ "Document Processing Service" ] }, "headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerHeaders" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Headers", "description": "Optional Server Headers.", "examples": [ { "name": "Authorization", "static_value": "Bearer token" }, { "name": "Content-Type", "static_value": "application/json" } ] }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities", "description": "Server capabilities as JSON.", "examples": [ { "prompts": false, "resources": true, "tools": true } ] }, "instructions": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Instructions", "description": "Server instructions.", "examples": [ { "setup": "Initialize with API key", "usage": "Call tools directly" } ] }, "transport_type": { "$ref": "#/components/schemas/MCPServerTransportType", "description": "How the server communicates.", "examples": [ "HTTP" ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerAuthentication-Input" }, { "type": "string" }, { "type": "null" } ], "title": "Authentication", "description": "Authentication configuration for the API endpoint.", "examples": [ { "config": { "password": "", "username": "" }, "type": "basic_auth" }, { "config": { "key": "", "name": "X-API-Key" }, "type": "token_auth" } ] }, "tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "List of tools names to include from the MCP server. If not specified, all tools will be included.", "default": [], "examples": [ [ "document_parser", "data_analyzer", "file_processor" ] ] }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id", "description": "Unique request ID for Oauth." }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "description": "Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.", "examples": [ { "is_latest": true, "provenance": { "sourceType": "external_registry" }, "registry_server_name": "ai.adadvisor/mcp-server", "registry_version": "1.0.1", "source_id": "019d8c94-b4c4-73e3-90b8-57716878c8db", "source_name": "Boomi Connect" } ] } }, "type": "object", "required": [ "name", "url", "transport_type" ], "title": "MCPServerBase", "description": "Base schema for MCP (Model Context Protocol) servers." }, "MCPServerBasicAuthConfig": { "properties": { "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "username", "password" ], "title": "MCPServerBasicAuthConfig", "description": "Configuration schema for HTTP Basic Authentication with MCP servers." }, "MCPServerExposedRequestParameterFields": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Whether the parameter contains sensitive information.", "default": false, "examples": [ false ] } }, "type": "object", "required": [ "name" ], "title": "MCPServerExposedRequestParameterFields", "description": "Exposed variant of request parameter fields for non-sensitive headers." }, "MCPServerHeaders": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Whether the parameter contains sensitive information.", "default": false, "examples": [ true, false ] } }, "type": "object", "required": [ "name" ], "title": "MCPServerHeaders", "description": "Schema for HTTP headers to be included in MCP server requests." }, "MCPServerImportedTool-Input": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Imported Tool name.", "default": "" }, "old_status": { "type": "string", "title": "Old Status", "description": "Tool old status.", "default": "" }, "new_status": { "type": "string", "title": "New Status", "description": "Tool new status.", "default": "" }, "old_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolSchema-Input" }, { "type": "null" } ], "description": "Tool old schema." }, "new_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolSchema-Input" }, { "type": "null" } ], "description": "Tool new schema." } }, "type": "object", "title": "MCPServerImportedTool", "description": "Schema representing imported tools and their status changes." }, "MCPServerImportedTool-Output": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Imported Tool name.", "default": "" }, "old_status": { "type": "string", "title": "Old Status", "description": "Tool old status.", "default": "" }, "new_status": { "type": "string", "title": "New Status", "description": "Tool new status.", "default": "" }, "old_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolSchema-Output" }, { "type": "null" } ], "description": "Tool old schema." }, "new_schema": { "anyOf": [ { "$ref": "#/components/schemas/ToolSchema-Output" }, { "type": "null" } ], "description": "Tool new schema." } }, "type": "object", "title": "MCPServerImportedTool", "description": "Schema representing imported tools and their status changes." }, "MCPServerOAuth": { "properties": { "grant_type": { "$ref": "#/components/schemas/SupportedGrantTypes", "description": "OAuth 2.0 grant type", "examples": [ "authorization_code", "client_credentials" ] }, "authorization_server_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Server Url", "description": "URL of the authorization server", "examples": [ "https://auth.example.com/oauth/authorize" ] }, "authorization_server_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Authorization Server Request Params", "description": "Additional parameters to include in authorization server requests", "examples": [ [ { "is_sensitive": false, "name": "response_type", "value": "code" } ] ] }, "access_token_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Access Token Url", "description": "URL to obtain access tokens", "examples": [ "https://auth.example.com/oauth/token" ] }, "access_token_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Access Token Request Params", "description": "Additional parameters to include in access token requests", "examples": [ [ { "is_sensitive": false, "name": "grant_type", "value": "authorization_code" } ] ] }, "client_id": { "type": "string", "title": "Client Id", "description": "OAuth client identifier", "examples": [ "my_client_id" ] }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret", "description": "OAuth client secret", "examples": [ "my_client_secret" ] }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopes", "description": "OAuth scopes (space-separated)", "examples": [ "read write", "admin" ] } }, "type": "object", "required": [ "grant_type", "authorization_server_url", "access_token_url", "client_id" ], "title": "MCPServerOAuth" }, "MCPServerRequestParameterFields": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Whether the parameter contains sensitive information.", "default": false, "examples": [ true, false ] } }, "type": "object", "required": [ "name" ], "title": "MCPServerRequestParameterFields", "description": "Base schema for request parameters used in MCP server communication." }, "MCPServerSecure": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Human-readable name which is defined from UI.", "examples": [ "Document Processing Server", "Data Analytics MCP" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional server description.", "examples": [ "A server for processing various document formats" ] }, "url": { "type": "string", "title": "Url", "description": "Base connection URL (NOT NULL for SSE/HTTP).", "examples": [ "https://api.example.com/mcp", "sse://server.example.com:8080" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "UI Intended server title.", "examples": [ "Document Processing Service" ] }, "headers": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerRequestParameterFields" }, { "$ref": "#/components/schemas/MCPServerSecureRequestParameterFields" }, { "$ref": "#/components/schemas/MCPServerExposedRequestParameterFields" } ] }, "type": "array" }, { "type": "null" } ], "title": "Headers", "description": "List of headers for the API endpoint.", "examples": [ [ { "is_sensitive": false, "name": "user_id", "static_value": "123" }, { "is_sensitive": false, "name": "is_urgent", "static_value": "true" }, { "is_sensitive": true, "name": "api_key" } ] ] }, "transport_type": { "$ref": "#/components/schemas/MCPServerTransportType", "description": "How the server communicates.", "examples": [ "HTTP" ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerSecureAuthentication" }, { "$ref": "#/components/schemas/MCPServerSecureOAuthAuthentication-Output" }, { "type": "null" } ], "title": "Authentication", "description": "Secure authentication configuration for the API endpoint.", "examples": [ { "type": "basic_auth" }, { "type": "token_auth" }, { "type": "oauth" } ] }, "tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "List of tools names to include from the MCP server. If not specified, all tools will be included.", "default": [], "examples": [ [ "document_parser", "data_analyzer", "file_processor" ] ] }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "description": "Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.", "examples": [ { "is_latest": true, "provenance": { "sourceType": "external_registry" }, "registry_server_name": "ai.adadvisor/mcp-server", "registry_version": "1.0.1", "source_id": "019d8c94-b4c4-73e3-90b8-57716878c8db", "source_name": "Boomi Connect" } ] }, "status": { "$ref": "#/components/schemas/MCPServerStatus", "description": "Server lifecycle status.", "default": "ACTIVE", "examples": [ "ACTIVE" ] }, "unique_name": { "type": "string", "title": "Unique Name", "description": "Unique name of the MCP Server." }, "agents_equipped_count": { "type": "integer", "title": "Agents Equipped Count", "description": "Count of agent equipped", "default": 0, "examples": [ 3 ] }, "tool_counts": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolCounts" }, { "type": "null" } ], "description": "Count of tools count" }, "imported_tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerImportedTool-Output" }, "type": "array" }, { "type": "null" } ], "title": "Imported Tools", "description": "List of tools names to include from the MCP server.", "default": [] }, "available_tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerAvailableTools-Output" }, "type": "array" }, { "type": "null" } ], "title": "Available Tools", "description": "Available tools for MCP", "default": [] }, "tool_changes": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerToolChanges" }, { "type": "null" } ], "description": "Dictionary of tools changes" } }, "type": "object", "required": [ "name", "url", "transport_type" ], "title": "MCPServerSecure", "description": "Secure schema for MCP servers that excludes sensitive authentication data." }, "MCPServerSecureAuthentication": { "properties": { "type": { "$ref": "#/components/schemas/MCPServerAuthenticationType" } }, "type": "object", "required": [ "type" ], "title": "MCPServerSecureAuthentication", "description": "Secure variant of MCP server authentication that excludes sensitive configuration." }, "MCPServerSecureOAuth-Input": { "properties": { "grant_type": { "$ref": "#/components/schemas/SupportedGrantTypes", "description": "OAuth 2.0 grant type", "examples": [ "authorization_code", "client_credentials" ] }, "authorization_server_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Server Url", "description": "URL of the authorization server", "examples": [ "https://auth.example.com/oauth/authorize" ] }, "authorization_server_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Authorization Server Request Params", "description": "Additional parameters to include in authorization server requests", "examples": [ [ { "is_sensitive": false, "name": "response_type", "value": "code" } ] ] }, "access_token_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Access Token Url", "description": "URL to obtain access tokens", "examples": [ "https://auth.example.com/oauth/token" ] }, "access_token_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Access Token Request Params", "description": "Additional parameters to include in access token requests", "examples": [ [ { "is_sensitive": false, "name": "grant_type", "value": "authorization_code" } ] ] }, "client_id": { "type": "string", "title": "Client Id", "description": "OAuth client identifier", "examples": [ "my_client_id" ] }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopes", "description": "OAuth scopes (space-separated)", "examples": [ "read write", "admin" ] } }, "type": "object", "required": [ "grant_type", "authorization_server_url", "access_token_url", "client_id" ], "title": "MCPServerSecureOAuth" }, "MCPServerSecureOAuth-Output": { "properties": { "grant_type": { "$ref": "#/components/schemas/SupportedGrantTypes", "description": "OAuth 2.0 grant type", "examples": [ "authorization_code", "client_credentials" ] }, "authorization_server_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Server Url", "description": "URL of the authorization server", "examples": [ "https://auth.example.com/oauth/authorize" ] }, "authorization_server_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Authorization Server Request Params", "description": "Additional parameters to include in authorization server requests", "examples": [ [ { "is_sensitive": false, "name": "response_type", "value": "code" } ] ] }, "access_token_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Access Token Url", "description": "URL to obtain access tokens", "examples": [ "https://auth.example.com/oauth/token" ] }, "access_token_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Access Token Request Params", "description": "Additional parameters to include in access token requests", "examples": [ [ { "is_sensitive": false, "name": "grant_type", "value": "authorization_code" } ] ] }, "client_id": { "type": "string", "title": "Client Id", "description": "OAuth client identifier", "examples": [ "my_client_id" ] }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopes", "description": "OAuth scopes (space-separated)", "examples": [ "read write", "admin" ] } }, "type": "object", "required": [ "grant_type", "authorization_server_url", "access_token_url", "client_id" ], "title": "MCPServerSecureOAuth" }, "MCPServerSecureOAuthAuthentication-Input": { "properties": { "type": { "$ref": "#/components/schemas/MCPServerAuthenticationType" }, "config": { "$ref": "#/components/schemas/MCPServerSecureOAuth-Input" } }, "type": "object", "required": [ "type", "config" ], "title": "MCPServerSecureOAuthAuthentication", "description": "Secure variant of MCP server OAuth authentication that includes OAuth-specific configuration." }, "MCPServerSecureOAuthAuthentication-Output": { "properties": { "type": { "$ref": "#/components/schemas/MCPServerAuthenticationType" }, "config": { "$ref": "#/components/schemas/MCPServerSecureOAuth-Output" } }, "type": "object", "required": [ "type", "config" ], "title": "MCPServerSecureOAuthAuthentication", "description": "Secure variant of MCP server OAuth authentication that includes OAuth-specific configuration." }, "MCPServerSecureRequestParameterFields": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Whether the parameter contains sensitive information.", "default": true, "examples": [ true ] } }, "type": "object", "required": [ "name" ], "title": "MCPServerSecureRequestParameterFields", "description": "Secure variant of request parameter fields that excludes sensitive values." }, "MCPServerStatus": { "type": "string", "enum": [ "ACTIVE", "STALE", "DISABLED" ], "title": "MCPServerStatus", "description": "Enumeration of possible MCP server operational states (ACTIVE, STALE, DISABLED)." }, "MCPServerSummaryResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tools.", "examples": [ "IntegrationTool", "HubTool" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tools.", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "URL of the MCP Server.", "examples": [ "https://www.example.com" ] }, "status": { "$ref": "#/components/schemas/MCPServerStatus", "description": "Status of the tools.", "default": "STALE" }, "agents_equipped": { "type": "integer", "title": "Agents Equipped", "description": "Count of agents using this tools.", "default": 0, "examples": [ 5 ] }, "imported_tools_count": { "type": "integer", "title": "Imported Tools Count", "description": "Counts of imported tools", "default": 0, "examples": [ 5 ] } }, "type": "object", "title": "MCPServerSummaryResponse", "description": "Summary schema for MCP server overview information." }, "MCPServerTokenAuth": { "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key", "description": "The name of the header", "default": "Authorization", "examples": [ "Authorization", "X-API-Key" ] }, "value": { "type": "string", "title": "Value", "description": "The value of the header", "examples": [ "Bearer {token}", "{api_key}" ] } }, "type": "object", "required": [ "value" ], "title": "MCPServerTokenAuth", "description": "Configuration schema for token-based authentication with MCP servers." }, "MCPServerToolChanges": { "properties": { "to_update": { "items": {}, "type": "array", "title": "To Update", "description": "List of tools needed to be updated", "default": [] }, "to_remove": { "items": {}, "type": "array", "title": "To Remove", "description": "List of tools needed to be removed", "default": [] } }, "type": "object", "title": "MCPServerToolChanges", "description": "Schema tracking tool changes detected during server synchronization." }, "MCPServerTransportType": { "type": "string", "enum": [ "SSE", "HTTP" ], "title": "MCPServerTransportType", "description": "Enumeration of supported transport protocols for MCP server communication (SSE, HTTP)." }, "MCPServerUpdate": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Human-readable name which is defined from UI.", "examples": [ "Document Processing Server", "Data Analytics MCP" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Optional server description.", "examples": [ "A server for processing various document formats" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "Base connection URL (NOT NULL for SSE/HTTP).", "examples": [ "https://api.example.com/mcp", "sse://server.example.com:8080" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "UI Intended server title.", "examples": [ "Document Processing Service" ] }, "headers": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Headers", "description": "Optional Server Headers.", "examples": [ { "Authorization": "Bearer token", "Content-Type": "application/json" } ] }, "capabilities": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Capabilities", "description": "Server capabilities as JSON.", "examples": [ { "prompts": false, "resources": true, "tools": true } ] }, "instructions": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Instructions", "description": "Server instructions.", "examples": [ { "setup": "Initialize with API key", "usage": "Call tools directly" } ] }, "transport_type": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerTransportType" }, { "type": "null" } ], "description": "How the server communicates.", "default": "HTTP", "examples": [ "HTTP" ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerAuthentication-Input" }, { "$ref": "#/components/schemas/MCPServerSecureOAuthAuthentication-Input" }, { "type": "string" }, { "type": "null" } ], "title": "Authentication", "description": "Authentication configuration for the API endpoint.", "examples": [ { "config": { "password": "", "username": "" }, "type": "basic_auth" }, { "config": { "key": "", "name": "X-API-Key" }, "type": "token_auth" } ] }, "tools": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Tools", "description": "List of tools names to include from the MCP server. If not specified, all tools will be included.", "default": [], "examples": [ [ { "description": "List objects in a schema", "input_parameters": [ { "description": "Schema name", "name": "schema_name", "required": true, "title": "Schema Name", "type": "string" }, { "description": "Object type: 'table', 'view', 'sequence', or 'extension'", "name": "object_type", "required": true, "server_default": "table", "title": "Object Type", "type": "string" } ], "name": "list_objects" } ] ] }, "request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id", "description": "Unique request ID for Oauth token." }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "description": "Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.", "examples": [ { "is_latest": true, "provenance": { "sourceType": "external_registry" }, "registry_server_name": "ai.adadvisor/mcp-server", "registry_version": "1.0.1", "source_id": "019d8c94-b4c4-73e3-90b8-57716878c8db", "source_name": "Boomi Connect" } ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerStatus" }, { "type": "null" } ], "description": "Server lifecycle status.", "default": "ACTIVE", "examples": [ "ACTIVE" ] }, "unique_name": { "type": "string", "title": "Unique Name", "description": "Unique name of the MCP Server." }, "encrypted_data_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Encrypted Data Key" }, "imported_tools_count": { "type": "integer", "title": "Imported Tools Count", "description": "Count of tools imported", "default": 0, "examples": [ 4 ] }, "agents_equipped_count": { "type": "integer", "title": "Agents Equipped Count", "description": "Count of agent equipped", "default": 0, "examples": [ 3 ] }, "tool_counts": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolCounts" }, { "type": "null" } ], "description": "Count of tools count" }, "imported_tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerImportedTool-Input" }, "type": "array" }, { "type": "null" } ], "title": "Imported Tools", "description": "List of tools names to include from the MCP server.", "default": [] }, "available_tools": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPServerAvailableTools-Input" }, "type": "array" }, { "type": "null" } ], "title": "Available Tools", "description": "Available tools for MCP", "default": [] }, "tool_changes": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerToolChanges" }, { "type": "null" } ], "description": "Dictionary of tools changes" } }, "type": "object", "title": "MCPServerUpdate", "description": "Schema for updating existing MCP servers." }, "MCPTool": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Document Parser", "Data Analyzer" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Parses various document formats", "Analyzes data and generates insights" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPInputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "The list of input parameters required by the tool.", "examples": [ [ { "description": "Source of the data to be analyzed", "name": "data_source", "required": true, "server_default": "table", "title": "The Data Source", "type": "string", "user_default": "archive" }, { "description": "The user's question or request", "name": "query", "required": true, "title": "File Process", "type": "string", "user_default": "csv file" } ] ] }, "server_id": { "type": "string", "title": "Server Id", "description": "ID of the MCP server this tool belongs to.", "default": "", "examples": [ "server_123" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Human-readable title." }, "input_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Schema", "description": "JSON schema for input.", "examples": [ { "properties": { "file": { "type": "string" } }, "type": "object" } ] }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the MCP tool.", "default": "STALE", "examples": [ "ACTIVE" ] } }, "type": "object", "required": [ "name" ], "title": "MCPTool", "description": "Schema for MCP Tool response." }, "MCPToolCounts": { "properties": { "imported": { "type": "integer", "title": "Imported", "description": "Imported tools count.", "default": 0 }, "active": { "type": "integer", "title": "Active", "description": "Active tools count.", "default": 0 }, "stale": { "type": "integer", "title": "Stale", "description": "Stale tools count.", "default": 0 }, "not_available": { "type": "integer", "title": "Not Available", "description": "Not available tools count.", "default": 0 }, "available": { "type": "integer", "title": "Available", "description": "Available tools count.", "default": 0 } }, "type": "object", "title": "MCPToolCounts", "description": "Schema for aggregated tool count statistics by status." }, "MCPToolDiscover": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Document Parser", "Data Analyzer" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Parses various document formats", "Analyzes data and generates insights" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Human-readable title." }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPInputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "server_default": "table", "title": "Data Source", "type": "string" } ] } }, "type": "object", "required": [ "name" ], "title": "MCPToolDiscover", "description": "Schema for MCP tool discovery operations." }, "MCPToolResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Document Parser", "Data Analyzer" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Parses various document formats", "Analyzes data and generates insights" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPInputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "The list of input parameters required by the tool.", "examples": [ [ { "description": "Source of the data to be analyzed", "name": "data_source", "required": true, "server_default": "table", "title": "The Data Source", "type": "string", "user_default": "archive" }, { "description": "The user's question or request", "name": "query", "required": true, "title": "File Process", "type": "string", "user_default": "csv file" } ] ] }, "server_id": { "type": "string", "title": "Server Id", "description": "ID of the MCP server this tool belongs to.", "default": "", "examples": [ "server_123" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Human-readable title." }, "input_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Schema", "description": "JSON schema for input.", "examples": [ { "properties": { "file": { "type": "string" } }, "type": "object" } ] }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the MCP tool.", "default": "STALE", "examples": [ "ACTIVE" ] }, "source_details": { "anyOf": [ { "$ref": "#/components/schemas/MCPServer" }, { "type": "null" } ] } }, "type": "object", "required": [ "name" ], "title": "MCPToolResponse", "description": "Schema for MCP tool responses and data retrieval." }, "MCPToolUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool.", "examples": [ "Document Parser", "Data Analyzer" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Parses various document formats", "Analyzes data and generates insights" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPInputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "The list of input parameters required by the tool.", "examples": [ [ { "description": "Source of the data to be analyzed", "name": "data_source", "required": true, "server_default": "table", "title": "The Data Source", "type": "string", "user_default": "archive" }, { "description": "The user's question or request", "name": "query", "required": true, "title": "File Process", "type": "string", "user_default": "csv file" } ] ] }, "server_id": { "type": "string", "title": "Server Id", "description": "ID of the MCP server this tool belongs to.", "default": "", "examples": [ "server_123" ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Human-readable title.", "examples": [ "Document Parser", "Data Analyzer" ] }, "input_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Input Schema", "description": "JSON schema for input.", "examples": [ { "properties": { "file": { "type": "string" } }, "type": "object" } ] }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema", "description": "JSON schema for output.", "examples": [ { "properties": { "result": { "type": "string" } }, "type": "object" } ] }, "annotations": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Annotations", "description": "Optional hints about tool behavior.", "examples": [ { "audience": [ "user", "agent" ], "level": "beginner" } ] }, "meta": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta", "description": "Reserved by MCP to allow clients and servers to attach additional metadata.", "examples": [ { "deprecated": false, "version": "1.0" } ] } }, "type": "object", "title": "MCPToolUpdate", "description": "Schema for updating existing MCP tools." }, "OpenAPIAuthentication-Input": { "properties": { "type": { "$ref": "#/components/schemas/OpenAPIAuthenticationType" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIBasicAuthConfig" }, { "$ref": "#/components/schemas/OpenAPITokenAuth" }, { "$ref": "#/components/schemas/OpenAPIOAuth" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "required": [ "type" ], "title": "OpenAPIAuthentication" }, "OpenAPIAuthentication-Output": { "properties": { "type": { "$ref": "#/components/schemas/OpenAPIAuthenticationType" }, "config": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIBasicAuthConfig" }, { "$ref": "#/components/schemas/OpenAPITokenAuth" }, { "$ref": "#/components/schemas/OpenAPIOAuth" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "required": [ "type" ], "title": "OpenAPIAuthentication" }, "OpenAPIAuthenticationType": { "type": "string", "enum": [ "None", "token_auth", "basic_auth", "platform_jwt", "oauth" ], "title": "OpenAPIAuthenticationType" }, "OpenAPIBasicAuthConfig": { "properties": { "username": { "type": "string", "title": "Username" }, "password": { "type": "string", "title": "Password" } }, "type": "object", "required": [ "username", "password" ], "title": "OpenAPIBasicAuthConfig" }, "OpenAPIExposedRequestParameterFields": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "Input parameter to be used for this value", "examples": [ "pet_name", "user_id" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Flag to determine if parameter is sensitive based on key", "default": false } }, "type": "object", "required": [ "name" ], "title": "OpenAPIExposedRequestParameterFields", "description": "Schema used in OpenAPISecureTool for parameters that are not sensitive" }, "OpenAPIHeaders": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "Input parameter to be used for this value", "examples": [ "pet_name", "user_id" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] } }, "type": "object", "required": [ "name" ], "title": "OpenAPIHeaders" }, "OpenAPIOAuth": { "properties": { "grant_type": { "$ref": "#/components/schemas/SupportedGrantTypes", "description": "OAuth 2.0 grant type", "examples": [ "authorization_code", "client_credentials" ] }, "authorization_server_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Server Url", "description": "URL of the authorization server", "examples": [ "https://auth.example.com/oauth/authorize" ] }, "authorization_server_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Authorization Server Request Params", "description": "Additional parameters to include in authorization server requests", "examples": [ [ { "is_sensitive": false, "name": "response_type", "value": "code" } ] ] }, "access_token_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Access Token Url", "description": "URL to obtain access tokens", "examples": [ "https://auth.example.com/oauth/token" ] }, "access_token_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Access Token Request Params", "description": "Additional parameters to include in access token requests", "examples": [ [ { "is_sensitive": false, "name": "grant_type", "value": "authorization_code" } ] ] }, "client_id": { "type": "string", "title": "Client Id", "description": "OAuth client identifier", "examples": [ "my_client_id" ] }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret", "description": "OAuth client secret", "examples": [ "my_client_secret" ] }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopes", "description": "OAuth scopes (space-separated)", "examples": [ "read write", "admin" ] } }, "type": "object", "required": [ "grant_type", "authorization_server_url", "access_token_url", "client_id" ], "title": "OpenAPIOAuth" }, "OpenAPIPathParameter": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "Input parameter to be used for this value", "examples": [ "pet_name", "user_id" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] } }, "type": "object", "required": [ "name" ], "title": "OpenAPIPathParameter" }, "OpenAPIQueryParameter": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "Input parameter to be used for this value", "examples": [ "pet_name", "user_id" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] } }, "type": "object", "required": [ "name" ], "title": "OpenAPIQueryParameter" }, "OpenAPIRequestBody": { "properties": { "type": { "$ref": "#/components/schemas/RequestBodyContentType" }, "template": { "type": "string", "title": "Template", "description": "Template for the request body.", "examples": [ "{\"user_id\": \"{user_id}\", \"is_urgent\": \"{is_urgent}\", \"api_key\": \"{api_key}\"}", "{user_name}{user_age}" ] } }, "type": "object", "required": [ "type", "template" ], "title": "OpenAPIRequestBody" }, "OpenAPIRequestParameterFields": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name", "description": "Input parameter to be used for this value", "examples": [ "pet_name", "user_id" ] }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value", "description": "Value of the parameter.", "examples": [ "1234", "true", "my_api_key" ] } }, "type": "object", "required": [ "name" ], "title": "OpenAPIRequestParameterFields" }, "OpenAPISecureAuthentication-Input": { "properties": { "type": { "$ref": "#/components/schemas/OpenAPIAuthenticationType" }, "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Config" } }, "type": "object", "required": [ "type" ], "title": "OpenAPISecureAuthentication", "description": "Schema for OpenAPI Tool Authentication which removes config for returning secure responses." }, "OpenAPISecureAuthentication-Output": { "properties": { "type": { "$ref": "#/components/schemas/OpenAPIAuthenticationType" } }, "type": "object", "required": [ "type" ], "title": "OpenAPISecureAuthentication", "description": "Schema for OpenAPI Tool Authentication which removes config for returning secure responses." }, "OpenAPISecureOAuth-Input": { "properties": { "grant_type": { "$ref": "#/components/schemas/SupportedGrantTypes", "description": "OAuth 2.0 grant type", "examples": [ "authorization_code", "client_credentials" ] }, "authorization_server_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Server Url", "description": "URL of the authorization server", "examples": [ "https://auth.example.com/oauth/authorize" ] }, "authorization_server_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Authorization Server Request Params", "description": "Additional parameters to include in authorization server requests", "examples": [ [ { "is_sensitive": false, "name": "response_type", "value": "code" } ] ] }, "access_token_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Access Token Url", "description": "URL to obtain access tokens", "examples": [ "https://auth.example.com/oauth/token" ] }, "access_token_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Access Token Request Params", "description": "Additional parameters to include in access token requests", "examples": [ [ { "is_sensitive": false, "name": "grant_type", "value": "authorization_code" } ] ] }, "client_id": { "type": "string", "title": "Client Id", "description": "OAuth client identifier", "examples": [ "my_client_id" ] }, "client_secret": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Secret" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopes", "description": "OAuth scopes (space-separated)", "examples": [ "read write", "admin" ] } }, "type": "object", "required": [ "grant_type", "authorization_server_url", "access_token_url", "client_id" ], "title": "OpenAPISecureOAuth" }, "OpenAPISecureOAuth-Output": { "properties": { "grant_type": { "$ref": "#/components/schemas/SupportedGrantTypes", "description": "OAuth 2.0 grant type", "examples": [ "authorization_code", "client_credentials" ] }, "authorization_server_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Authorization Server Url", "description": "URL of the authorization server", "examples": [ "https://auth.example.com/oauth/authorize" ] }, "authorization_server_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Authorization Server Request Params", "description": "Additional parameters to include in authorization server requests", "examples": [ [ { "is_sensitive": false, "name": "response_type", "value": "code" } ] ] }, "access_token_url": { "type": "string", "minLength": 1, "format": "uri", "title": "Access Token Url", "description": "URL to obtain access tokens", "examples": [ "https://auth.example.com/oauth/token" ] }, "access_token_request_params": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RequestParameter" }, "type": "array" }, { "type": "null" } ], "title": "Access Token Request Params", "description": "Additional parameters to include in access token requests", "examples": [ [ { "is_sensitive": false, "name": "grant_type", "value": "authorization_code" } ] ] }, "client_id": { "type": "string", "title": "Client Id", "description": "OAuth client identifier", "examples": [ "my_client_id" ] }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scopes", "description": "OAuth scopes (space-separated)", "examples": [ "read write", "admin" ] } }, "type": "object", "required": [ "grant_type", "authorization_server_url", "access_token_url", "client_id" ], "title": "OpenAPISecureOAuth" }, "OpenAPISecureOAuthAuthentication-Input": { "properties": { "type": { "$ref": "#/components/schemas/OpenAPIAuthenticationType" }, "config": { "$ref": "#/components/schemas/OpenAPISecureOAuth-Input" } }, "type": "object", "required": [ "type", "config" ], "title": "OpenAPISecureOAuthAuthentication", "description": "Schema for OpenAPI Tool Authentication which removes config for returning secure responses." }, "OpenAPISecureOAuthAuthentication-Output": { "properties": { "type": { "$ref": "#/components/schemas/OpenAPIAuthenticationType" }, "config": { "$ref": "#/components/schemas/OpenAPISecureOAuth-Output" } }, "type": "object", "required": [ "type", "config" ], "title": "OpenAPISecureOAuthAuthentication", "description": "Schema for OpenAPI Tool Authentication which removes config for returning secure responses." }, "OpenAPISecureRequestParameterFields-Input": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "input_parameter_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Input Parameter Name" }, "static_value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "title": "Static Value" }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Flag to determine if parameter is sensitive based on key", "default": true } }, "type": "object", "required": [ "name" ], "title": "OpenAPISecureRequestParameterFields", "description": "Schema used in OpenAPISecureTool for parameters that are sensitive which excludes static_value and input_parameter_name" }, "OpenAPISecureRequestParameterFields-Output": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the parameter.", "examples": [ "user_id", "is_urgent", "api_key" ] }, "is_sensitive": { "type": "boolean", "title": "Is Sensitive", "description": "Flag to determine if parameter is sensitive based on key", "default": true } }, "type": "object", "required": [ "name" ], "title": "OpenAPISecureRequestParameterFields", "description": "Schema used in OpenAPISecureTool for parameters that are sensitive which excludes static_value and input_parameter_name" }, "OpenAPISecureTool": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "base_url": { "type": "string", "title": "Base Url", "description": "Base URL for the API.", "default": "", "examples": [ "https://api.example.com/v1", "https://api.example.com/v2" ] }, "path": { "type": "string", "title": "Path", "description": "Path to the API endpoint.", "default": "/", "examples": [ "/users", "/users/{user_id}" ] }, "method": { "$ref": "#/components/schemas/HTTPMethod", "description": "HTTP method for the API endpoint.", "default": "GET", "examples": [ "GET", "POST" ] }, "query_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIQueryParameter" }, "type": "array" }, { "type": "null" } ], "title": "Query Parameters", "description": "List of query parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "path_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIPathParameter" }, "type": "array" }, { "type": "null" } ], "title": "Path Parameters", "description": "List of path parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "headers": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPISecureRequestParameterFields-Output" }, { "$ref": "#/components/schemas/OpenAPIExposedRequestParameterFields" } ] }, "type": "array" }, { "type": "null" } ], "title": "Headers", "description": "List of headers for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPISecureAuthentication-Output" }, { "$ref": "#/components/schemas/OpenAPISecureOAuthAuthentication-Output" }, { "type": "null" } ], "title": "Authentication", "description": "Secure authentication configuration for the API endpoint.", "examples": [ { "type": "basic_auth" }, { "type": "token_auth" }, { "type": "oauth" } ] }, "request_body": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIRequestBody" }, { "type": "string" }, { "type": "null" } ], "title": "Request Body", "description": "Request body configuration for the API endpoint.", "examples": [ { "template": "{\"user_id\": \"{{user_id}}\", \"is_urgent\": true}", "type": "application/json" }, { "template": "{{user_id}}", "type": "application/xml" } ] }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id", "description": "ID of the ACP source this tool belongs to" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name", "description": "Name of the ACP source this tool belongs to" }, "unique_name": { "type": "string", "title": "Unique Name" }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the agent.", "default": "DRAFT", "examples": [ "DRAFT", "ACTIVE", "DISABLED" ] } }, "type": "object", "required": [ "name" ], "title": "OpenAPISecureTool", "description": "Schema for OpenAPI tools where authentication values are removed" }, "OpenAPITokenAuth": { "properties": { "key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key", "description": "The name of the header", "default": "Authorization", "examples": [ "Authorization", "X-API-Key" ] }, "value": { "type": "string", "title": "Value", "description": "The value of the header", "examples": [ "Bearer {token}", "{api_key}" ] } }, "type": "object", "required": [ "value" ], "title": "OpenAPITokenAuth" }, "OpenAPITool": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "base_url": { "type": "string", "title": "Base Url", "description": "Base URL for the API.", "default": "", "examples": [ "https://api.example.com/v1", "https://api.example.com/v2" ] }, "path": { "type": "string", "title": "Path", "description": "Path to the API endpoint.", "default": "/", "examples": [ "/users", "/users/{user_id}" ] }, "method": { "$ref": "#/components/schemas/HTTPMethod", "description": "HTTP method for the API endpoint.", "default": "GET", "examples": [ "GET", "POST" ] }, "query_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIQueryParameter" }, "type": "array" }, { "type": "null" } ], "title": "Query Parameters", "description": "List of query parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "path_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIPathParameter" }, "type": "array" }, { "type": "null" } ], "title": "Path Parameters", "description": "List of path parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIHeaders" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Headers", "description": "List of headers for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIAuthentication-Output" }, { "type": "string" }, { "type": "null" } ], "title": "Authentication", "description": "Authentication configuration for the API endpoint.", "examples": [ { "config": { "password": "XXXXXXXXXXX", "username": "XXXXX" }, "type": "basic_auth" }, { "config": { "key": "XXXXXXXXXXX", "name": "X-API-Key" }, "type": "token_auth" }, { "config": { "access_token_url": "https://auth.example.com/oauth/token", "authorization_server_url": "https://auth.example.com/oauth/authorize", "client_id": "my_client_id", "client_secret": "my_client_secret", "grant_type": "authorization_code" }, "type": "oauth" } ] }, "request_body": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIRequestBody" }, { "type": "string" }, { "type": "null" } ], "title": "Request Body", "description": "Request body configuration for the API endpoint.", "examples": [ { "template": "{\"user_id\": \"{{user_id}}\", \"is_urgent\": true}", "type": "application/json" }, { "template": "{{user_id}}", "type": "application/xml" } ] }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id", "description": "ID of the ACP source this tool belongs to" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name", "description": "Name of the ACP source this tool belongs to" }, "unique_name": { "type": "string", "title": "Unique Name" }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the agent.", "default": "DRAFT", "examples": [ "DRAFT", "ACTIVE", "DISABLED" ] } }, "type": "object", "required": [ "name" ], "title": "OpenAPITool" }, "OpenAPIToolBase": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "base_url": { "type": "string", "title": "Base Url", "description": "Base URL for the API.", "default": "", "examples": [ "https://api.example.com/v1", "https://api.example.com/v2" ] }, "path": { "type": "string", "title": "Path", "description": "Path to the API endpoint.", "default": "/", "examples": [ "/users", "/users/{user_id}" ] }, "method": { "$ref": "#/components/schemas/HTTPMethod", "description": "HTTP method for the API endpoint.", "default": "GET", "examples": [ "GET", "POST" ] }, "query_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIQueryParameter" }, "type": "array" }, { "type": "null" } ], "title": "Query Parameters", "description": "List of query parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "path_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIPathParameter" }, "type": "array" }, { "type": "null" } ], "title": "Path Parameters", "description": "List of path parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "headers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIHeaders" }, "type": "array" }, { "type": "string" }, { "type": "null" } ], "title": "Headers", "description": "List of headers for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIAuthentication-Input" }, { "type": "string" }, { "type": "null" } ], "title": "Authentication", "description": "Authentication configuration for the API endpoint.", "examples": [ { "config": { "password": "XXXXXXXXXXX", "username": "XXXXX" }, "type": "basic_auth" }, { "config": { "key": "XXXXXXXXXXX", "name": "X-API-Key" }, "type": "token_auth" }, { "config": { "access_token_url": "https://auth.example.com/oauth/token", "authorization_server_url": "https://auth.example.com/oauth/authorize", "client_id": "my_client_id", "client_secret": "my_client_secret", "grant_type": "authorization_code" }, "type": "oauth" } ] }, "request_body": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIRequestBody" }, { "type": "string" }, { "type": "null" } ], "title": "Request Body", "description": "Request body configuration for the API endpoint.", "examples": [ { "template": "{\"user_id\": \"{{user_id}}\", \"is_urgent\": true}", "type": "application/json" }, { "template": "{{user_id}}", "type": "application/xml" } ] }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id", "description": "ID of the ACP source this tool belongs to" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name", "description": "Name of the ACP source this tool belongs to" } }, "type": "object", "required": [ "name" ], "title": "OpenAPIToolBase" }, "OpenAPIToolUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool.", "examples": [ "Query_Customer_Data" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "examples": [ "Query data from Customer Hub universe" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "base_url": { "type": "string", "title": "Base Url", "description": "Base URL for the API.", "default": "", "examples": [ "https://api.example.com/v1", "https://api.example.com/v2" ] }, "path": { "type": "string", "title": "Path", "description": "Path to the API endpoint.", "default": "/", "examples": [ "/users", "/users/{user_id}" ] }, "method": { "$ref": "#/components/schemas/HTTPMethod", "description": "HTTP method for the API endpoint.", "default": "GET", "examples": [ "GET", "POST" ] }, "query_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIQueryParameter" }, "type": "array" }, { "type": "null" } ], "title": "Query Parameters", "description": "List of query parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "path_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OpenAPIPathParameter" }, "type": "array" }, { "type": "null" } ], "title": "Path Parameters", "description": "List of path parameters for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "headers": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIRequestParameterFields" }, { "$ref": "#/components/schemas/OpenAPISecureRequestParameterFields-Input" } ] }, "type": "array" }, { "type": "null" } ], "title": "Headers", "description": "List of headers for the API endpoint.", "examples": [ [ { "input_parameter": "user_id", "name": "user_id", "value": "123" }, { "input_parameter": "is_urgent", "name": "is_urgent", "value": "true" }, { "input_parameter": "api_key", "name": "api_key", "value": "my_api_key" } ] ] }, "authentication": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPISecureAuthentication-Input" }, { "$ref": "#/components/schemas/OpenAPIAuthentication-Input" }, { "$ref": "#/components/schemas/OpenAPISecureOAuthAuthentication-Input" }, { "type": "string" }, { "type": "null" } ], "title": "Authentication", "description": "Authentication configuration for the API endpoint.", "examples": [ { "config": { "password": "", "username": "XXXXX" }, "type": "basic_auth" }, { "config": { "key": "XXXXXXXXXXX", "name": "X-API-Key" }, "type": "token_auth" }, { "config": { "access_token_url": "https://auth.example.com/oauth/token", "authorization_server_url": "https://auth.example.com/oauth/authorize", "client_id": "my_client_id", "client_secret": "my_client_secret", "grant_type": "authorization_code" }, "type": "oauth" } ] }, "request_body": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPIRequestBody" }, { "type": "string" }, { "type": "null" } ], "title": "Request Body", "description": "Request body configuration for the API endpoint.", "examples": [ { "template": "{\"user_id\": \"{{user_id}}\", \"is_urgent\": true}", "type": "application/json" }, { "template": "{{user_id}}", "type": "application/xml" } ] }, "source_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Id", "description": "ID of the ACP source this tool belongs to" }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name", "description": "Name of the ACP source this tool belongs to" } }, "type": "object", "title": "OpenAPIToolUpdate" }, "PackageDeployBody": { "properties": { "deploy_to_environment_id": { "type": "string", "title": "Deploy To Environment Id", "description": "Agent Garden Environment ID to deploy the created package to", "examples": [ "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b" ] } }, "type": "object", "title": "PackageDeployBody", "description": "Request body format to deploy an agent while creating a package" }, "PackageResponse": { "properties": { "package_id": { "type": "string", "title": "Package Id", "description": "The unique identifier for the package.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "agent_id": { "type": "string", "title": "Agent Id", "description": "The Agent ID related to the package.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "version": { "type": "string", "title": "Version", "description": "Version of the package", "default": "1.0", "examples": [ "1.0", "2.0" ] }, "name": { "type": "string", "title": "Name", "description": "Name of the agent package.", "examples": [ "ITSupportBot", "HRBuddy" ] }, "snapshot": { "$ref": "#/components/schemas/AgentSnapshotResponse", "description": "Immutable configuration of the agent at the time of package creation with sensitive data removed." }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the package was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] } }, "type": "object", "required": [ "agent_id", "name", "snapshot" ], "title": "PackageResponse" }, "PackageSummaryResponse": { "properties": { "package_id": { "type": "string", "title": "Package Id", "description": "The unique identifier for the package." }, "name": { "type": "string", "title": "Name", "description": "Name of the package." }, "version": { "type": "string", "title": "Version", "description": "Version of the package" }, "agent_id": { "type": "string", "title": "Agent Id", "description": "The Agent ID related to the package." }, "agent_name": { "type": "string", "title": "Agent Name", "description": "Name of the agent." }, "agent_mode": { "$ref": "#/components/schemas/AgentMode", "description": "Mode of the agent in the package snapshot." }, "profile_picture": { "anyOf": [ { "$ref": "#/components/schemas/ProfilePicture" }, { "type": "null" } ], "description": "Attributes of the agent's profile picture." }, "deployment_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Deployment Count", "description": "Number of deployments associated with the agent.", "default": 0 }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the package was created." } }, "type": "object", "required": [ "package_id", "name", "version", "agent_id", "agent_name", "agent_mode", "created_on" ], "title": "PackageSummaryResponse", "description": "Response Schema for List Packages" }, "PaginationResponse_AgentFavoriteResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/AgentFavoriteResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[AgentFavoriteResponse]" }, "PaginationResponse_AgentSummaryResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/AgentSummaryResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[AgentSummaryResponse]" }, "PaginationResponse_DeploymentResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/DeploymentResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[DeploymentResponse]" }, "PaginationResponse_MCPServerSummaryResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/MCPServerSummaryResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[MCPServerSummaryResponse]" }, "PaginationResponse_PackageSummaryResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/PackageSummaryResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[PackageSummaryResponse]" }, "PaginationResponse_SourceSummaryResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/SourceSummaryResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[SourceSummaryResponse]" }, "PaginationResponse_ToolSummaryResponse_": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "$ref": "#/components/schemas/ToolSummaryResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[ToolSummaryResponse]" }, "PaginationResponse_Union_EnvironmentResponse__IntegrationEnvironmentResponse__": { "properties": { "total_items": { "type": "integer", "title": "Total Items" }, "total_pages": { "type": "integer", "title": "Total Pages" }, "current_page": { "type": "integer", "title": "Current Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/EnvironmentResponse" }, { "$ref": "#/components/schemas/IntegrationEnvironmentResponse" } ] }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "total_items", "total_pages", "current_page", "page_size", "items" ], "title": "PaginationResponse[Union[EnvironmentResponse, IntegrationEnvironmentResponse]]" }, "ParamType": { "type": "string", "enum": [ "string", "integer", "float", "boolean" ], "title": "ParamType" }, "PerformanceConfig": { "properties": { "processing_mode": { "$ref": "#/components/schemas/ProcessingMode", "description": "Processing mode for inference", "default": "standard" }, "rationale": { "type": "boolean", "title": "Rationale", "description": "Whether to enable analysis/rationale in response", "default": true } }, "type": "object", "title": "PerformanceConfig", "description": "Configuration model for performance settings.\n\n:param processing_mode: Processing mode for inference\n:param rationale: Whether to enable analysis/rationale in response\n\n:type processing_mode: ProcessingMode\n:type rationale: bool" }, "PersonalityTraits": { "properties": { "voice_tone": { "$ref": "#/components/schemas/VoiceTone", "default": "Professional", "examples": [ "Professional", "Friendly", "Instructional", "Playful" ] }, "creativity": { "type": "integer", "maximum": 100.0, "minimum": 0.0, "title": "Creativity", "default": 50, "examples": [ 10, 50, 90 ] }, "decisiveness": { "type": "integer", "maximum": 100.0, "minimum": 0.0, "title": "Decisiveness", "default": 50, "examples": [ 10, 50, 90 ] }, "clarity": { "type": "integer", "maximum": 100.0, "minimum": 0.0, "title": "Clarity", "default": 50, "examples": [ 10, 50, 90 ] }, "confidence": { "type": "integer", "maximum": 100.0, "minimum": 0.0, "title": "Confidence", "default": 50, "examples": [ 10, 50, 90 ] }, "engagement": { "type": "integer", "maximum": 100.0, "minimum": 0.0, "title": "Engagement", "default": 50, "examples": [ 10, 50, 90 ] } }, "type": "object", "title": "PersonalityTraits" }, "Policy": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the policy." }, "type": { "$ref": "#/components/schemas/PolicyType", "description": "Type of the policy", "examples": [ "denied_topic", "word_filter", "regex_pattern" ] }, "configuration": { "anyOf": [ { "$ref": "#/components/schemas/DeniedTopicConfiguration" }, { "$ref": "#/components/schemas/WordFilterConfiguration" }, { "$ref": "#/components/schemas/RegexPatternConfiguration" } ], "title": "Configuration", "description": "Configuration for the policy, depends on the policy type." } }, "type": "object", "required": [ "configuration" ], "title": "Policy" }, "PolicyType": { "type": "string", "enum": [ "denied_topic", "word_filter", "regex_pattern" ], "title": "PolicyType" }, "ProcessingMode": { "type": "string", "enum": [ "standard", "quick" ], "title": "ProcessingMode" }, "ProfilePicture": { "properties": { "role": { "type": "string", "title": "Role", "description": "Role of the agent for profile picture selection.", "default": "Default", "examples": [ "Assistant", "Analyst", "Support" ] }, "colour": { "type": "string", "title": "Colour", "description": "Color associated with the profile picture.", "default": "Sunset", "examples": [ "Sunset", "Lavender", "Seabreeze", "Midnight" ] }, "image_id": { "type": "string", "title": "Image Id", "description": "The emoji representing the profile picture image.", "default": "image_person", "examples": [ "image_person", "image_location", "image_phone", "image_headphones", "image_camera" ] } }, "type": "object", "title": "ProfilePicture" }, "PromptTool": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "prompt": { "type": "string", "title": "Prompt", "description": "The prompt message or query that the tool will execute, typically a message or question to generate a response. Use placeholder variables like {data_source} and {query} as needed.", "examples": [ "Summarize the key insights from {data_source} based on the question: {query}.", "Translate the content from {data_source} into French for the following text: {query}.", "Generate recommendations from {data_source} to address the request: {query}." ] }, "examples": { "anyOf": [ { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Examples", "description": "A dictionary of sample inputs and their expected outputs for the prompt tool. This helps demonstrate how the tool is expected to behave.", "examples": [ [ { "input": "Summarize the key insights from research papers based on the question: 'What are the latest trends in AI?'", "output": "Recent trends in AI include advancements in large language models, generative AI applications, and ethical considerations in AI deployment." }, { "input": "Translate the content from an article into French for the following text: 'Artificial intelligence is transforming industries worldwide.'", "output": "L'intelligence artificielle transforme les industries \u00e0 travers le monde." }, { "input": "Generate recommendations from customer feedback data to address the request: 'How can we improve our product delivery time?'", "output": "Recommendations include optimizing the supply chain, using predictive analytics for inventory management, and enhancing communication with logistics partners." } ] ] }, "unique_name": { "type": "string", "title": "Unique Name" }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the agent.", "default": "DRAFT", "examples": [ "DRAFT", "ACTIVE", "DISABLED" ] } }, "type": "object", "required": [ "name", "prompt" ], "title": "PromptTool" }, "PromptToolBase": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the tool.", "examples": [ "Data Analyzer", "Language Translator", "Image Recognition" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "prompt": { "type": "string", "title": "Prompt", "description": "The prompt message or query that the tool will execute, typically a message or question to generate a response. Use placeholder variables like {data_source} and {query} as needed.", "examples": [ "Summarize the key insights from {data_source} based on the question: {query}.", "Translate the content from {data_source} into French for the following text: {query}.", "Generate recommendations from {data_source} to address the request: {query}." ] }, "examples": { "anyOf": [ { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Examples", "description": "A dictionary of sample inputs and their expected outputs for the prompt tool. This helps demonstrate how the tool is expected to behave.", "examples": [ [ { "input": "Summarize the key insights from research papers based on the question: 'What are the latest trends in AI?'", "output": "Recent trends in AI include advancements in large language models, generative AI applications, and ethical considerations in AI deployment." }, { "input": "Translate the content from an article into French for the following text: 'Artificial intelligence is transforming industries worldwide.'", "output": "L'intelligence artificielle transforme les industries \u00e0 travers le monde." }, { "input": "Generate recommendations from customer feedback data to address the request: 'How can we improve our product delivery time?'", "output": "Recommendations include optimizing the supply chain, using predictive analytics for inventory management, and enhancing communication with logistics partners." } ] ] } }, "type": "object", "required": [ "name", "prompt" ], "title": "PromptToolBase" }, "PromptToolUpdate": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool.", "examples": [ "JiraTemplateGenerator" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "examples": [ "Generates a JIRA template based on the provided JIRA ID and description" ] }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/app__schemas__tool__InputParameter" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "List of input parameters required by the tool.", "examples": [ [ { "description": "The source of the data to be analyzed", "name": "data_source", "required": true, "type": "string" }, { "description": "The user's question or request", "name": "query", "required": true, "type": "string" } ] ] }, "prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt", "description": "The prompt message or query that the tool will execute, typically a message or question to generate a response. Use placeholder variables like {data_source} and {query} as needed.", "examples": [ "Summarize the key insights from {data_source} based on the question: {query}.", "Translate the content from {data_source} into French for the following text: {query}.", "Generate recommendations from {data_source} to address the request: {query}." ] }, "examples": { "anyOf": [ { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Examples", "description": "A dictionary of sample inputs and their expected outputs for the prompt tool. This helps demonstrate how the tool is expected to behave.", "examples": [ [ { "input": "Summarize the key insights from research papers based on the question: 'What are the latest trends in AI?'", "output": "Recent trends in AI include advancements in large language models, generative AI applications, and ethical considerations in AI deployment." }, { "input": "Translate the content from an article into French for the following text: 'Artificial intelligence is transforming industries worldwide.'", "output": "L'intelligence artificielle transforme les industries \u00e0 travers le monde." }, { "input": "Generate recommendations from customer feedback data to address the request: 'How can we improve our product delivery time?'", "output": "Recommendations include optimizing the supply chain, using predictive analytics for inventory management, and enhancing communication with logistics partners." } ] ] } }, "type": "object", "title": "PromptToolUpdate" }, "RegexPatternConfiguration": { "properties": { "pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pattern", "description": "Regex pattern for matching content in the regex pattern policy.", "examples": [ "\\d{4}-\\d{2}-\\d{2}", "[a-zA-Z]+" ] } }, "type": "object", "title": "RegexPatternConfiguration" }, "RequestBodyContentType": { "type": "string", "enum": [ "application/json", "application/xml", "application/x-www-form-urlencoded", "multipart/form-data", "text/plain" ], "title": "RequestBodyContentType" }, "RequestParameter": { "properties": { "name": { "type": "string", "title": "Name", "description": "Parameter name" }, "value": { "type": "string", "title": "Value", "description": "Value for the parameter" } }, "type": "object", "required": [ "name", "value" ], "title": "RequestParameter", "description": "Request parameter schema." }, "RuntimeInfo": { "properties": { "runtime_id": { "type": "string", "title": "Runtime Id", "description": "The unique identifier for the runtime.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "runtime_name": { "type": "string", "title": "Runtime Name", "description": "The name of the runtime.", "examples": [ "USA East Agent Garden Cloud" ] }, "runtime_region": { "type": "string", "title": "Runtime Region", "description": "Where the runtime is hosted", "examples": [ "US", "UK" ] }, "endpoint_url": { "type": "string", "title": "Endpoint Url", "description": "Base URL of the Agent Executor", "examples": [ "https://ai-agent-garden.datalake-sandbox.boomi.com/api/v1/agent-garden-runtime" ] } }, "type": "object", "required": [ "runtime_id", "runtime_name", "runtime_region", "endpoint_url" ], "title": "RuntimeInfo", "description": "Used to track runtimes stored in environments" }, "SchemaType": { "type": "string", "enum": [ "json", "xml" ], "title": "SchemaType" }, "SourceParamType": { "type": "string", "enum": [ "string", "integer", "float", "number", "boolean", "array", "object", "null" ], "title": "SourceParamType" }, "SourceStatus": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DISABLED", "STALE", "NOT_AVAILABLE" ], "title": "SourceStatus" }, "SourceSummaryResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the source.", "examples": [ "MCPServer" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the source.", "default": "", "examples": [ "Identifies objects and patterns in images" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url", "description": "URL for source base", "examples": [ "http://example.com" ] }, "type": { "type": "string", "title": "Type", "description": "Type of Source.", "examples": [ "MCPServer" ] }, "status": { "$ref": "#/components/schemas/SourceStatus", "description": "Status for Sources", "default": "DRAFT" }, "agents_equipped": { "type": "integer", "title": "Agents Equipped", "description": "Count of agents using this tools.", "default": 0, "examples": [ 3 ] }, "imported_tools_count": { "type": "integer", "title": "Imported Tools Count", "description": "Count of imported tools.", "default": 0, "examples": [ 3 ] }, "application_icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Icon", "description": "Base64 Icon for this Applications." }, "application_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Name", "description": "Name of the application." } }, "type": "object", "required": [ "type" ], "title": "SourceSummaryResponse" }, "SourceType": { "type": "string", "enum": [ "MCPServer", "acp_source", "Application" ], "title": "SourceType" }, "SuccessResponse_AgentDetailedResponse_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/AgentDetailedResponse" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[AgentDetailedResponse]" }, "SuccessResponse_Agent_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/Agent" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[Agent]" }, "SuccessResponse_DeploymentResponse_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/DeploymentResponse" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[DeploymentResponse]" }, "SuccessResponse_Deployment_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/Deployment" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[Deployment]" }, "SuccessResponse_HubTool_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/HubTool" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[HubTool]" }, "SuccessResponse_IntegrationTool_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/IntegrationTool" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[IntegrationTool]" }, "SuccessResponse_List_MCPToolDiscover__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPToolDiscover" }, "type": "array" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "title": "SuccessResponse[List[MCPToolDiscover]]" }, "SuccessResponse_MCPServerSecure_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/MCPServerSecure" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[MCPServerSecure]" }, "SuccessResponse_MCPServer_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/MCPServer" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[MCPServer]" }, "SuccessResponse_MCPToolResponse_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/MCPToolResponse" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[MCPToolResponse]" }, "SuccessResponse_MCPTool_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/MCPTool" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[MCPTool]" }, "SuccessResponse_OpenAPISecureTool_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPISecureTool" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[OpenAPISecureTool]" }, "SuccessResponse_OpenAPITool_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/OpenAPITool" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[OpenAPITool]" }, "SuccessResponse_PackageResponse_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PackageResponse" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PackageResponse]" }, "SuccessResponse_PaginationResponse_DeploymentResponse__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_DeploymentResponse_" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PaginationResponse[DeploymentResponse]]" }, "SuccessResponse_PaginationResponse_MCPServerSummaryResponse__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_MCPServerSummaryResponse_" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PaginationResponse[MCPServerSummaryResponse]]" }, "SuccessResponse_PaginationResponse_PackageSummaryResponse__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_PackageSummaryResponse_" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PaginationResponse[PackageSummaryResponse]]" }, "SuccessResponse_PaginationResponse_SourceSummaryResponse__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_SourceSummaryResponse_" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PaginationResponse[SourceSummaryResponse]]" }, "SuccessResponse_PaginationResponse_ToolSummaryResponse__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_ToolSummaryResponse_" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PaginationResponse[ToolSummaryResponse]]" }, "SuccessResponse_PaginationResponse_Union_EnvironmentResponse__IntegrationEnvironmentResponse___": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_Union_EnvironmentResponse__IntegrationEnvironmentResponse__" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PaginationResponse[Union[EnvironmentResponse, IntegrationEnvironmentResponse]]]" }, "SuccessResponse_PromptTool_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PromptTool" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[PromptTool]" }, "SuccessResponse_SystemFabricSourceDetailResponse_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SystemFabricSourceDetailResponse" }, { "type": "null" } ] } }, "type": "object", "title": "SuccessResponse[SystemFabricSourceDetailResponse]" }, "SuccessResponse_Union_PackageResponse__DeploymentResponse__": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PackageResponse" }, { "$ref": "#/components/schemas/DeploymentResponse" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "title": "SuccessResponse[Union[PackageResponse, DeploymentResponse]]" }, "SuccessResponse_Union_PaginationResponse_AgentSummaryResponse___PaginationResponse_AgentFavoriteResponse___": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginationResponse_AgentSummaryResponse_" }, { "$ref": "#/components/schemas/PaginationResponse_AgentFavoriteResponse_" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "title": "SuccessResponse[Union[PaginationResponse[AgentSummaryResponse], PaginationResponse[AgentFavoriteResponse]]]" }, "SuccessResponse_str_": { "properties": { "success": { "type": "boolean", "title": "Success", "default": true }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data" } }, "type": "object", "title": "SuccessResponse[str]" }, "SupportedGrantTypes": { "type": "string", "enum": [ "authorization_code" ], "title": "SupportedGrantTypes" }, "SystemFabricImportedToolSummary": { "properties": { "id": { "type": "string", "title": "Id", "description": "Tool ID" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Creation timestamp" }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Last update timestamp" }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Installation timestamp" }, "name": { "type": "string", "title": "Name", "description": "Tool name/title" }, "description": { "type": "string", "title": "Description", "description": "Tool description" }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Tool status" } }, "type": "object", "required": [ "id", "created_on", "last_updated_on", "name", "description", "tool_status" ], "title": "SystemFabricImportedToolSummary", "description": "Summary of an imported tool." }, "SystemFabricSourceDetailResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Source ID" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Creation timestamp" }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Last update timestamp" }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Installation timestamp" }, "name": { "type": "string", "title": "Name", "description": "Source/Application name" }, "description": { "type": "string", "title": "Description", "description": "Source description" }, "application_name": { "type": "string", "title": "Application Name", "description": "Application name" }, "application_icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Icon", "description": "Application icon (base64)" }, "status": { "type": "string", "title": "Status", "description": "Source status" }, "unique_name": { "type": "string", "title": "Unique Name", "description": "Unique name" }, "agents_equipped_count": { "type": "integer", "title": "Agents Equipped Count", "description": "Number of agents using tools from this source" }, "tool_counts": { "$ref": "#/components/schemas/SystemFabricToolCountResponse", "description": "Tool counts by status" }, "imported_tools": { "items": { "$ref": "#/components/schemas/SystemFabricImportedToolSummary" }, "type": "array", "title": "Imported Tools", "description": "List of imported tools" }, "fabric_application_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fabric Application Id", "description": "Fabric application ID" } }, "type": "object", "required": [ "id", "created_on", "last_updated_on", "name", "description", "application_name", "status", "unique_name", "agents_equipped_count", "tool_counts", "imported_tools", "fabric_application_id" ], "title": "SystemFabricSourceDetailResponse", "description": "Detailed response for a single Application/Fabric source." }, "SystemFabricToolCountResponse": { "properties": { "imported": { "type": "integer", "title": "Imported", "description": "Total imported tools" }, "active": { "type": "integer", "title": "Active", "description": "Active tools count" }, "disabled": { "type": "integer", "title": "Disabled", "description": "Disabled tools count" }, "not_available": { "type": "integer", "title": "Not Available", "description": "Not available tools count" } }, "type": "object", "required": [ "imported", "active", "disabled", "not_available" ], "title": "SystemFabricToolCountResponse", "description": "Tool counts by status." }, "Task-Input": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the task.", "examples": [ "diagnose_issue", "provide_solution", "create_ticket" ] }, "objective": { "type": "string", "title": "Objective", "description": "Objective of the task.", "examples": [ "Diagnose the user's IT issue", "Provide a solution or troubleshooting steps", "Create a support ticket for unresolved issues" ] }, "instructions": { "items": { "type": "string" }, "type": "array", "title": "Instructions", "description": "Instructions for completing the task.", "default": [], "examples": [ [ "Ask clarifying questions about the issue", "Offer step-by-step instructions for common issues" ] ] }, "tools": { "items": { "$ref": "#/components/schemas/TaskTool-Input" }, "type": "array", "title": "Tools", "description": "List of tools required for the task.", "default": [] } }, "type": "object", "required": [ "name", "objective" ], "title": "Task" }, "Task-Output": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the task.", "examples": [ "diagnose_issue", "provide_solution", "create_ticket" ] }, "objective": { "type": "string", "title": "Objective", "description": "Objective of the task.", "examples": [ "Diagnose the user's IT issue", "Provide a solution or troubleshooting steps", "Create a support ticket for unresolved issues" ] }, "instructions": { "items": { "type": "string" }, "type": "array", "title": "Instructions", "description": "Instructions for completing the task.", "default": [], "examples": [ [ "Ask clarifying questions about the issue", "Offer step-by-step instructions for common issues" ] ] }, "tools": { "items": { "$ref": "#/components/schemas/TaskTool-Output" }, "type": "array", "title": "Tools", "description": "List of tools required for the task.", "default": [] } }, "type": "object", "required": [ "name", "objective" ], "title": "Task" }, "TaskTool-Input": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier for the tool used in this task." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool used in this task." }, "status": { "anyOf": [ { "$ref": "#/components/schemas/ToolStatus" }, { "type": "null" } ], "description": "Status of the tool used in this task." }, "type": { "type": "string", "title": "Type", "description": "Type of the tool" }, "requires_approval": { "type": "boolean", "title": "Requires Approval", "description": "Whether the tool requires approval for this task.", "default": false }, "response_passthrough": { "type": "boolean", "title": "Response Passthrough", "description": "Whether the tool's response should be passed through directly in this task.", "default": false } }, "type": "object", "required": [ "id", "type" ], "title": "TaskTool" }, "TaskTool-Output": { "properties": { "id": { "type": "string", "title": "Id", "description": "The unique identifier for the tool used in this task." }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool used in this task." }, "type": { "type": "string", "title": "Type", "description": "Type of the tool" }, "requires_approval": { "type": "boolean", "title": "Requires Approval", "description": "Whether the tool requires approval for this task.", "default": false }, "response_passthrough": { "type": "boolean", "title": "Response Passthrough", "description": "Whether the tool's response should be passed through directly in this task.", "default": false } }, "type": "object", "required": [ "id", "type" ], "title": "TaskTool" }, "ToolSchema-Input": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Tool title from MCP Server" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Tool description from MCP Server" }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPInputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "", "default": [] } }, "type": "object", "title": "ToolSchema", "description": "Schema representing tool metadata from MCP servers." }, "ToolSchema-Output": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title", "description": "Tool title from MCP Server" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Tool description from MCP Server" }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/MCPInputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "", "default": [] } }, "type": "object", "title": "ToolSchema", "description": "Schema representing tool metadata from MCP servers." }, "ToolStatus": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DISABLED", "STALE", "NOT_AVAILABLE" ], "title": "ToolStatus" }, "ToolSummaryResponse": { "properties": { "id": { "type": "string", "title": "Id", "description": "Unique identifier for the resource.", "examples": [ "e8e6d6ad-76d4-4529-bb0e-0f0a2f84cc1d" ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On", "description": "Timestamp when the resource was created.", "examples": [ "2024-11-13T12:00:00+00:00" ] }, "last_updated_on": { "type": "string", "format": "date-time", "title": "Last Updated On", "description": "Timestamp when the resource was last updated.", "examples": [ "2024-11-13T12:30:00+00:00" ] }, "installed_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Installed On", "description": "Timestamp when the resource was last used.", "examples": [ null ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of the tool.", "examples": [ "IntegrationTool", "HubTool" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the tool.", "default": "", "examples": [ "Analyzes data and generates insights", "Translates text between languages", "Identifies objects and patterns in images" ] }, "type": { "type": "string", "title": "Type", "description": "Type of the tool.", "examples": [ "IntegrationTool", "HubTool", "OpenApiTool", "PromptTool" ] }, "source_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Name", "description": "Name of the tool source." }, "tool_status": { "$ref": "#/components/schemas/ToolStatus", "description": "Status of the tool.", "default": "DRAFT" }, "agents_equipped": { "type": "integer", "title": "Agents Equipped", "description": "Count of agents using this tool.", "default": 0, "examples": [ 5 ] }, "application_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Name", "description": "Name of the tool application." }, "application_icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Application Icon", "description": "Base64 icon of the tool application." } }, "type": "object", "required": [ "type" ], "title": "ToolSummaryResponse" }, "ToolType": { "type": "string", "enum": [ "Integration", "Hub", "Prompt", "MCP", "OpenAPI", "Application" ], "title": "ToolType" }, "UniverseField": { "properties": { "unique_id": { "type": "string", "title": "Unique Id", "description": "Unique identifier of the Hub field", "examples": [ "FIRST_NAME", "ZIP_CODE" ] }, "pretty_name": { "type": "string", "title": "Pretty Name", "description": "Readable name of the Hub field", "examples": [ "First Name", "Zip Code" ] }, "path": { "type": "string", "title": "Path", "description": "Hierarchy of the field in the Hub universe", "examples": [ "name/first_name", "address/zip_code" ] }, "data_type": { "type": "string", "title": "Data Type", "description": "Type of data for the field", "examples": [ "STRING", "CLOB", "INTEGER" ] }, "repeatable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Repeatable", "description": "Boolean value determining if a field can hold multiple values", "default": false, "examples": [ true, false ] } }, "type": "object", "required": [ "unique_id", "pretty_name", "path", "data_type" ], "title": "UniverseField" }, "VoiceTone": { "type": "string", "enum": [ "Professional", "Friendly", "Instructional", "Playful" ], "title": "VoiceTone" }, "WordFilterConfiguration": { "properties": { "words": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Words", "description": "List of words to filter out in the word filter policy.", "default": [], "examples": [ "confidential", "NDA", "prohibited" ] } }, "type": "object", "title": "WordFilterConfiguration" }, "app__schemas__tool__InputParameter": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the input parameter.", "examples": [ "data_source", "query", "user_id" ] }, "description": { "type": "string", "title": "Description", "description": "Description of the input parameter.", "examples": [ "The source of the data to be analyzed", "The user's question or request", "Unique identifier for the user" ] }, "required": { "type": "boolean", "title": "Required", "description": "Whether the input parameter is required.", "examples": [ true, false ] }, "type": { "$ref": "#/components/schemas/ParamType", "description": "Type of the input parameter.", "examples": [ "string", "integer", "float" ] } }, "type": "object", "required": [ "name", "description", "required", "type" ], "title": "InputParameter" } }, "securitySchemes": { "Boomi-Platform-JWT": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Boomi Platform JWT authentication. Pass a valid JWT token in the Authorization header as: Bearer " }, "Boomi-Platform-API-Key": { "type": "http", "scheme": "basic", "description": "Boomi Platform API Token authentication using HTTP Basic. Username: BOOMI_TOKEN. (e.g. BOOMI_TOKEN.user@example.com). Password: your API token value." } } }, "tags": [ { "name": "Agents", "description": "Create and manage AI agents." }, { "name": "Tools", "description": "Register and configure tools that agents can invoke." }, { "name": "Sources", "description": "Manage data sources and MCP servers available to agents." }, { "name": "Packages", "description": "Package agents for versioned deployment." }, { "name": "Environments", "description": "Query runtime environments available for deployment." } ], "security": [ { "Boomi-Platform-JWT": [] }, { "Boomi-Platform-API-Key": [] } ], "servers": [ { "url": "https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}", "description": "Agent Garden Design API (US Platform)", "variables": { "accountId": { "default": "your-account-id", "description": "Your Boomi account ID." } } }, { "url": "https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}", "description": "Agent Garden Design API (UK Platform)", "variables": { "accountId": { "default": "your-account-id", "description": "Your Boomi account ID." } } } ] }