API docs by Redocly

AInTandem Orchestrator API (0.6.0-alpha)

Download OpenAPI specification:

License: ISC

API for the orchestrator that manages workflows, tasks, containers, and context in the AInTandem platform

Authentication

Authentication endpoints

Login

Authenticate user credentials and return JWT tokens

Request Body schema: application/json
required
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "token": "string",
  • "refreshToken": "string",
  • "user": {
    },
  • "error": "string"
}

Logout

Invalidate the refresh token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Refresh

Refresh the access token using the refresh token The refresh token can be provided in the request body or in a cookie

Request Body schema: application/json
optional
refreshToken
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "token": "string",
  • "refreshToken": "string",
  • "error": "string"
}

VerifyCurrentToken

Verify the validity of the current access token (from Authorization header) Use this to check if the current user is authenticated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "user": {
    },
  • "error": "string"
}

VerifyToken

Verify the validity of an access token (provided in request body) Use this for backend-to-backend token validation

Request Body schema: application/json
required
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "user": {
    },
  • "error": "string"
}

Container Management

Container management endpoints

Project Management

Project management endpoints

ListOrganizations

List all organizations

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • null
]

CreateOrganization

Create a new organization

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
folderPath
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderPath": "string"
}

Response samples

Content type
application/json
null

GetOrganization

Get a specific organization

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
null

UpdateOrganization

Update an organization

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
folderPath
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderPath": "string"
}

Response samples

Content type
application/json
null

DeleteOrganization

Delete an organization

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

ListWorkspacesInOrganization

List workspaces in an organization

Authorizations:
bearerAuth
path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
[
  • null
]

CreateWorkspace

Create a new workspace

Authorizations:
bearerAuth
path Parameters
organizationId
required
string
Request Body schema: application/json
required
name
required
string
folderPath
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderPath": "string"
}

Response samples

Content type
application/json
null

ListAllWorkspaces

List all workspaces (across all organizations)

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • null
]

GetWorkspace

Get a specific workspace

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
null

UpdateWorkspace

Update a workspace

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
folderPath
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderPath": "string"
}

Response samples

Content type
application/json
null

DeleteWorkspace

Delete a workspace

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

ListProjectsInWorkspace

List projects in a workspace

Authorizations:
bearerAuth
path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
[
  • null
]

CreateProject

Create a new project

Authorizations:
bearerAuth
path Parameters
workspaceId
required
string
Request Body schema: application/json
required
name
required
string
folderPath
required
string
workflowId
string
aiConfig
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderPath": "string",
  • "workflowId": "string",
  • "aiConfig": null
}

Response samples

Content type
application/json
null

ListAllProjects

List all projects (across all workspaces)

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • null
]

GetProject

Get a specific project

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
null

UpdateProject

Update a project

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
folderPath
string
sandboxId
string
sandboxName
string
workflowState
any
workflowId
string or null
aiConfig
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderPath": "string",
  • "sandboxId": "string",
  • "sandboxName": "string",
  • "workflowState": null,
  • "workflowId": "string",
  • "aiConfig": null
}

Response samples

Content type
application/json
null

DeleteProject

Delete a project

Authorizations:
bearerAuth
path Parameters
id
required
string
  • Project ID
query Parameters
deleteFolder
boolean
  • Whether to delete the project folder (default: false)

Responses

MoveProject

Move a project to another workspace

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
newWorkspaceId
required
string

Responses

Request samples

Content type
application/json
{
  • "newWorkspaceId": "string"
}

Response samples

Content type
application/json
null

GetWorkflowState

Get workflow state for a project

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
null

UpdateWorkflowState

Update workflow state for a project

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
currentPhaseId
required
string
currentStepId
string
stepStatuses
any

Responses

Request samples

Content type
application/json
{
  • "currentPhaseId": "string",
  • "currentStepId": "string",
  • "stepStatuses": null
}

Response samples

Content type
application/json
null

UpdateStepStatus

Update a single step status

Authorizations:
bearerAuth
path Parameters
id
required
string
stepId
required
string
Request Body schema: application/json
required
status
required
string

Responses

Request samples

Content type
application/json
{
  • "status": "string"
}

Response samples

Content type
application/json
null

Workflow Management

Workflow management endpoints

ListWorkflows

List all workflows with optional status filter

Authorizations:
bearerAuth
query Parameters
status
string
Enum: "published" "draft" "archived"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateWorkflow

Create new workflow (starts as Draft)

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
description
required
string
definition
required
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "definition": null
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "definition": {
    },
  • "status": "published",
  • "version": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "changeDescription": "string",
  • "organizationId": "string"
}

GetWorkflow

Get specific workflow by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "definition": {
    },
  • "status": "published",
  • "version": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "changeDescription": "string",
  • "organizationId": "string"
}

UpdateWorkflow

Update workflow If workflow is Published, creates a new version automatically

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
description
string
definition
any
changeDescription
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "definition": null,
  • "changeDescription": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "definition": {
    },
  • "status": "published",
  • "version": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "changeDescription": "string",
  • "organizationId": "string"
}

DeleteWorkflow

Delete workflow Cannot delete templates or workflows in use by projects

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

ChangeWorkflowStatus

Change workflow status (Publish, Archive, back to Draft)

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
status
required
string
Enum: "published" "draft" "archived"

Responses

Request samples

Content type
application/json
{
  • "status": "published"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "definition": {
    },
  • "status": "published",
  • "version": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "changeDescription": "string",
  • "organizationId": "string"
}

CloneWorkflow

Clone workflow for customization

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "definition": {
    },
  • "status": "published",
  • "version": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "changeDescription": "string",
  • "organizationId": "string"
}

ListWorkflowVersions

List all versions for a workflow

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GetWorkflowVersion

Get specific workflow version by ID

Authorizations:
bearerAuth
path Parameters
versionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "definition": {
    },
  • "status": "published",
  • "version": 0.1,
  • "createdAt": "string",
  • "updatedAt": "string",
  • "changeDescription": "string",
  • "organizationId": "string"
}

CreateWorkflowExecution

Create a new workflow execution

Authorizations:
bearerAuth
path Parameters
workflowId
required
string
Request Body schema: application/json
required
projectId
required
string
object

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "executionId": "string",
  • "status": "string",
  • "message": "string"
}

StartWorkflowExecution

Start a workflow execution

Authorizations:
bearerAuth
path Parameters
executionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

GetWorkflowExecution

Get workflow execution status

Authorizations:
bearerAuth
path Parameters
executionId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "workflowId": "string",
  • "workflowName": "string",
  • "projectId": "string",
  • "userId": "string",
  • "status": "pending",
  • "phases": [
    ],
  • "currentPhase": 0.1,
  • "totalPhases": 0.1,
  • "progress": {
    },
  • "startTime": "string",
  • "endTime": "string",
  • "duration": 0.1,
  • "error": "string",
  • "metadata": {
    }
}

GetProjectWorkflowExecutions

Get workflow executions for a project

Authorizations:
bearerAuth
path Parameters
projectId
required
string
query Parameters
status
Array of strings

Responses

Response samples

Content type
application/json
{
  • "executions": [
    ]
}

PauseWorkflowExecution

Pause a running workflow execution

Authorizations:
bearerAuth
path Parameters
executionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

ResumeWorkflowExecution

Resume a paused workflow execution

Authorizations:
bearerAuth
path Parameters
executionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

CancelWorkflowExecution

Cancel a workflow execution

Authorizations:
bearerAuth
path Parameters
executionId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Task Management

Task management endpoints

ExecuteTask

Execute a new task in the project's sandbox

Authorizations:
bearerAuth
path Parameters
projectId
required
string
Request Body schema: application/json
required
stepId
required
string
prompt
required
string
parameters
any

Responses

Request samples

Content type
application/json
{
  • "stepId": "string",
  • "prompt": "string",
  • "parameters": null
}

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "message": "string"
}

GetProjectTasks

Get task history for a project with optional filters

Authorizations:
bearerAuth
path Parameters
projectId
required
string
query Parameters
status
Array of strings
type
string
Enum: "workflow" "adhoc"
search
string
limit
number <double>
offset
number <double>

Responses

Response samples

Content type
application/json
null

ExecuteAdhocTask

Execute an ad-hoc task (single-use task)

Authorizations:
bearerAuth
path Parameters
projectId
required
string
Request Body schema: application/json
required
title
required
string
description
string
prompt
required
string
parameters
any
taskType
string
Enum: "claude" "qwen" "bash"
contextMemoryIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "prompt": "string",
  • "parameters": null,
  • "taskType": "claude",
  • "contextMemoryIds": [
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "message": "string"
}

GetTaskDetails

Get specific task details

Authorizations:
bearerAuth
path Parameters
projectId
required
string
taskId
required
string

Responses

Response samples

Content type
application/json
null

SetTaskLimit

Set task limit for project's sandbox

Authorizations:
bearerAuth
path Parameters
projectId
required
string
Request Body schema: application/json
required
limit
required
number <double>

Responses

Request samples

Content type
application/json
{
  • "limit": 0.1
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "limit": 0.1,
  • "sandboxId": "string"
}

GetQueueStatus

Get queue status for project's sandbox

Authorizations:
bearerAuth
path Parameters
projectId
required
string

Responses

Response samples

Content type
application/json
{
  • "pending": 0.1,
  • "running": 0.1,
  • "projectId": "string",
  • "sandboxId": "string"
}

CancelTask

Cancel a queued task

Authorizations:
bearerAuth
path Parameters
projectId
required
string
taskId
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "taskId": "string"
}

ExecuteWorkflowStep

Execute a workflow step as a task

Authorizations:
bearerAuth
path Parameters
projectId
required
string
stepId
required
string
Request Body schema: application/json
required
additionalInput
string
parameters
any

Responses

Request samples

Content type
application/json
{
  • "additionalInput": "string",
  • "parameters": null
}

Response samples

Content type
application/json
{
  • "taskId": "string",
  • "message": "string",
  • "stepId": "string"
}

GetTaskContext

Get context information for a specific task

Authorizations:
bearerAuth
path Parameters
projectId
required
string
taskId
required
string

Responses

Response samples

Content type
application/json
{
  • "injectedMemories": [
    ],
  • "generatedMemory": null,
  • "activeDialog": null,
  • "usage": {
    }
}

SaveTaskOutputAsContext

Manually save task output as a context memory

Authorizations:
bearerAuth
path Parameters
projectId
required
string
taskId
required
string
Request Body schema: application/json
required
content
required
string
type
string
summary
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "type": "string",
  • "summary": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "memory": null
}

GetRelevantContext

Get relevant context for a task prompt (used by frontend for suggestions)

Authorizations:
bearerAuth
path Parameters
projectId
required
string
Request Body schema: application/json
required
prompt
required
string
maxMemories
number <double>
types
Array of strings
includeWorkspace
boolean
includeOrg
boolean

Responses

Request samples

Content type
application/json
{
  • "prompt": "string",
  • "maxMemories": 0.1,
  • "types": [
    ],
  • "includeWorkspace": true,
  • "includeOrg": true
}

Response samples

Content type
application/json
{
  • "memories": [
    ]
}

Context Management

Context management endpoints

CreateMemory

Create a new memory

Authorizations:
bearerAuth
Request Body schema: application/json
required
content
required
string
scope
required
string
scope_id
required
string
memory_type
string
visibility
string
tags
Array of strings
source
any
custom
any

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "memory_type": "string",
  • "visibility": "string",
  • "tags": [
    ],
  • "source": null,
  • "custom": null
}

Response samples

Content type
application/json
null

ListMemories

Get all memories with optional filters

Authorizations:
bearerAuth
query Parameters
scope
required
string
scope_id
required
string
memory_type
string
tags
Array of strings
limit
number <double>
Default: 100
offset
number <double>
Default: 0

Responses

Response samples

Content type
application/json
null

UpsertMemory

Create or update memory by unique identifier This endpoint prevents duplicate memories from external sources like CoSpec AI

Authorizations:
bearerAuth
query Parameters
uniqueKey
string
Request Body schema: application/json
required
content
required
string
scope
required
string
scope_id
required
string
memory_type
string
visibility
string
tags
Array of strings
source
any
custom
any

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "memory_type": "string",
  • "visibility": "string",
  • "tags": [
    ],
  • "source": null,
  • "custom": null
}

Response samples

Content type
application/json
null

GetMemory

Get a specific memory by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
null

UpdateMemory

Update a memory

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
content
required
string

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
null

DeleteMemory

Delete a memory

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

SearchMemories

Semantic search for memories

Authorizations:
bearerAuth
Request Body schema: application/json
required
query
required
string
scope
required
string
scope_id
required
string
limit
number <double>
include_inherited
boolean

Responses

Request samples

Content type
application/json
{
  • "query": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "limit": 0.1,
  • "include_inherited": true
}

Response samples

Content type
application/json
null

GetScopeMemories

Get memories for a specific scope with optional hierarchical inheritance

Authorizations:
bearerAuth
path Parameters
scope
required
string
scopeId
required
string
query Parameters
memory_type
string
tags
Array of strings
limit
number <double>
Default: 100
include_inherited
string
Default: "false"

Responses

Response samples

Content type
application/json
null

GetSimilarMemories

Get similar memories (semantic search based on memory content)

Authorizations:
bearerAuth
path Parameters
id
required
string
query Parameters
limit
number <double>
Default: 10

Responses

Response samples

Content type
application/json
null

GetStats

Get overall memory statistics

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
null

GetScopeStats

Get memory statistics for a specific scope

Authorizations:
bearerAuth
path Parameters
scope
required
string
scopeId
required
string

Responses

Response samples

Content type
application/json
null

HealthCheck

Health check for the context system

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
null

GetContextInfo

Get context system information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
null

ImportDocument

Import a document file to the context system

Authorizations:
bearerAuth
Request Body schema: application/json
required
file_path
required
string
scope
required
string
scope_id
required
string
memory_type
string
visibility
string
tags
Array of strings
chunk_content
boolean

Responses

Request samples

Content type
application/json
{
  • "file_path": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "memory_type": "string",
  • "visibility": "string",
  • "tags": [
    ],
  • "chunk_content": true
}

Response samples

Content type
application/json
null

ImportDocumentContent

Import document content directly (no filesystem access needed)

Authorizations:
bearerAuth
Request Body schema: application/json
required
content
required
string
file_path
string
scope
required
string
scope_id
required
string
memory_type
string
visibility
string
tags
Array of strings
chunk_content
boolean

Responses

Request samples

Content type
application/json
{
  • "content": "string",
  • "file_path": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "memory_type": "string",
  • "visibility": "string",
  • "tags": [
    ],
  • "chunk_content": true
}

Response samples

Content type
application/json
null

ImportFolder

Import all documents from a folder

Authorizations:
bearerAuth
Request Body schema: application/json
required
folder_path
required
string
scope
required
string
scope_id
required
string
recursive
boolean
file_extensions
Array of strings
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "folder_path": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "recursive": true,
  • "file_extensions": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
null

SyncFile

Sync a single file (re-import if changed)

Authorizations:
bearerAuth
Request Body schema: application/json
required
file_path
required
string
scope
required
string
scope_id
required
string
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "file_path": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "tags": [
    ]
}

Response samples

Content type
application/json
null

SyncFolder

Sync all files in a folder

Authorizations:
bearerAuth
Request Body schema: application/json
required
folder_path
required
string
scope
required
string
scope_id
required
string
recursive
boolean
file_extensions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "folder_path": "string",
  • "scope": "string",
  • "scope_id": "string",
  • "recursive": true,
  • "file_extensions": [
    ]
}

Response samples

Content type
application/json
null

GetSyncStats

Get file sync statistics

Authorizations:
bearerAuth
query Parameters
scope
required
string
scope_id
required
string

Responses

Response samples

Content type
application/json
null

GetTrackedFiles

Get list of tracked files

Authorizations:
bearerAuth
query Parameters
scope
required
string
scope_id
required
string

Responses

Response samples

Content type
application/json
null

CaptureTaskDialog

Auto-capture task dialog to context

Authorizations:
bearerAuth
path Parameters
taskId
required
string
Request Body schema: application/json
required
projectId
required
string
content
required
string
metadata
any

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "content": "string",
  • "metadata": null
}

Response samples

Content type
application/json
null

SyncHierarchy

Trigger full hierarchy resync to context-manager

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
null

Settings

User settings endpoints

GetUserSettings

Get user settings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "userId": "string",
  • "preferences": {
    },
  • "gitDisplayName": "string",
  • "gitEmail": "string",
  • "dockerImage": "string",
  • "updatedAt": "string"
}

UpdateUserSettings

Update user settings

Authorizations:
bearerAuth
Request Body schema: application/json
required
gitDisplayName
string
gitEmail
string
dockerImage
string

Responses

Request samples

Content type
application/json
{
  • "gitDisplayName": "string",
  • "gitEmail": "string",
  • "dockerImage": "string"
}

Response samples

Content type
application/json
{
  • "userId": "string",
  • "preferences": {
    },
  • "gitDisplayName": "string",
  • "gitEmail": "string",
  • "dockerImage": "string",
  • "updatedAt": "string"
}

Host

Host-related endpoints

BrowseDirectories

Browse host directories (legacy)

Authorizations:
bearerAuth
Request Body schema: application/json
required
currentPath
string

Responses

Request samples

Content type
application/json
{
  • "currentPath": "string"
}

Response samples

Content type
application/json
{
  • "currentPath": "string",
  • "directories": [
    ]
}

ListOrganizationFolders

List folders at BASE_ROOT level (for organizations)

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "folders": [
    ]
}

ListWorkspaceFolders

List folders within an organization (for workspaces)

Authorizations:
bearerAuth
path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "folders": [
    ]
}

ListProjectFolders

List folders within a workspace (for projects)

Authorizations:
bearerAuth
path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
{
  • "folders": [
    ]
}

Sandbox Management

ListSandboxes

List all Docker sandboxes managed by the orchestrator

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

CreateSandbox

Create a new Docker sandbox for a project

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
folderMapping
string
projectId
string
aiConfig
any
imageName
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "folderMapping": "string",
  • "projectId": "string",
  • "aiConfig": null,
  • "imageName": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "image": "string",
  • "imageName": "string",
  • "folderMapping": "string",
  • "workingDir": "string",
  • "projectId": "string",
  • "aiConfig": null
}

ListSandboxImages

List all available sandbox images

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "images": [
    ],
  • "total": 0.1,
  • "defaultImageId": "string"
}

StartSandbox

Start a Docker sandbox by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

StopSandbox

Stop a Docker sandbox by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

DeleteSandbox

Delete a Docker sandbox by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

StartSandboxAsync

Start a Docker sandbox asynchronously with progress tracking

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "operationId": "string",
  • "status": "string",
  • "message": "string"
}

StopSandboxAsync

Stop a Docker sandbox asynchronously with progress tracking

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "operationId": "string",
  • "status": "string",
  • "message": "string"
}

RestartSandboxAsync

Restart a Docker sandbox asynchronously with progress tracking

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "operationId": "string",
  • "status": "string",
  • "message": "string"
}

DeleteSandboxAsync

Delete a Docker sandbox asynchronously with progress tracking

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "operationId": "string",
  • "status": "string",
  • "message": "string"
}

GetOperationStatus

Get the status of an asynchronous sandbox operation

Authorizations:
bearerAuth
path Parameters
operationId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "create",
  • "status": "pending",
  • "sandboxId": "string",
  • "sandboxName": "string",
  • "projectId": "string",
  • "userId": "string",
  • "progress": {
    },
  • "error": "string",
  • "startTime": "string",
  • "endTime": "string",
  • "duration": 0.1,
  • "steps": [
    ],
  • "metadata": {
    }
}

CancelOperation

Cancel an asynchronous sandbox operation

Authorizations:
bearerAuth
path Parameters
operationId
required
string

Responses

Response samples

Content type
application/json
{
  • "operationId": "string",
  • "message": "string"
}

GetProjectOperations

Get operations for a specific project

Authorizations:
bearerAuth
path Parameters
projectId
required
string
query Parameters
status
Array of strings

Responses

Response samples

Content type
application/json
{
  • "operations": [
    ]
}

Health

Health

Health check endpoint for the API server

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "uptime": 0.1
}