Actions26
- Agent Actions
- API Key Actions
- Async Actions
- Headless Actions
- Persona Actions
- Playbook Actions
- Product Actions
- Reference Actions
- Use Case Actions
Overview
The "Build Workspace" operation under the "Agent" resource is designed to create or configure a workspace environment within the Octave platform. This operation allows users to specify workspace details such as its name, URL, associated agents, and user inclusion preferences. Additionally, it supports defining an offering/product with its unique value proposition, related URLs, status quo description, and references. The operation can also accept a runtime context in JSON format to customize the build process.
This node is beneficial for automating the setup of collaborative workspaces tailored to specific offerings or products, streamlining onboarding processes, and managing agent associations programmatically. For example, a company launching a new product can use this node to quickly establish a dedicated workspace with relevant agents and documentation links, ensuring all team members have immediate access to necessary resources.
Properties
| Name | Meaning |
|---|---|
| Workspace: Name | Name of the workspace to be built or configured (required). |
| Workspace: URL | Optional URL of the workspace (e.g., https://octave.com). |
| Workspace: Add Existing Users | Boolean flag indicating whether to add existing users to the workspace; defaults to true if not specified. |
| Workspace: Agent OIds (JSON Array) | Optional JSON array of Agent Object IDs to associate with the workspace (e.g., ["id1", "id2"]). |
| Offering: Name | Name of the offering or product associated with the workspace (required). |
| Offering: Differentiated Value | The unique value proposition or differentiator of the offering (required). |
| Offering: Additional URLs (JSON Array) | Optional JSON array of additional URLs related to the offering (e.g., documentation links like ["https://docs.octave.com"]). |
| Offering: Status Quo | Optional description of the current status quo or problem that the offering addresses. |
| Offering: References (JSON Array of Objects) | Optional JSON array of reference objects providing URLs and details, e.g., [{"url": "https://casestudy.example.com/customer-a", "details": "Customer A achieved X results..."}]. |
| Runtime Context (JSON for Build Workspace) | Optional JSON object providing runtime context parameters to customize the workspace build process. |
Output
The node outputs an array of JSON objects representing the result of the workspace build operation. Each output item corresponds to an input item processed and contains structured data returned by the Octave API about the created or configured workspace, including confirmation details and any metadata related to the workspace and offering.
If errors occur during execution and the node is set to continue on failure, the output will include error information with messages and optionally API response details for troubleshooting.
No binary data output is indicated for this operation.
Dependencies
- Requires an active connection to the Octave V2 API via an API key credential.
- The node depends on proper configuration of the API authentication token within n8n credentials.
- No other external services are explicitly required beyond the Octave API.
Troubleshooting
Common Issues:
- Invalid or missing required properties such as workspace name or offering name may cause the API call to fail.
- Malformed JSON inputs for properties expecting JSON arrays or objects (e.g., Agent OIds, Additional URLs, References, Runtime Context) can lead to parsing errors.
- Network or authentication failures due to incorrect API key configuration.
Error Messages:
- Errors from the Octave API will be surfaced with their message and, if available, the API response body parsed as JSON.
- Parsing errors on API responses are caught and reported with a parse error note.
- If the node is configured to continue on failure, errors are included in the output JSON with contextual information to aid debugging.
Resolution Tips:
- Ensure all required fields are provided and correctly formatted.
- Validate JSON inputs before running the node.
- Verify API key credentials and network connectivity.
- Use the error output details to identify issues with API requests or responses.
Links and References
- Octave Platform Documentation (example placeholder)
- API Reference for Workspace Management (example placeholder)
Note: Actual URLs should be replaced with official Octave documentation links.