### Manually Start Qoder (Windows/macOS)

Source: https://docs.qoder.com/troubleshooting/common-issue

Execute the Qoder application directly from its binary path to manually start the application if automatic startup fails.

```bash
Qoder.exe start or Qoder start
```

--------------------------------

### Install Node.js using Homebrew on macOS

Source: https://docs.qoder.com/troubleshooting/mcp-common-issue

Install Node.js and verify its installation using Homebrew. Configure environment variables if necessary for older Node.js versions.

```shellscript
# 1. Update Homebrew and install Node.js.
brew update
brew install node

    # 2. Verify installation and confirm the versions.
echo "Node.js version: $(node -v)"
echo "npm version: $(npm -v)"
echo "npx version: $(npx -v)"

# 3. Configure environment variables (if necessary).
echo 'export PATH="/usr/local/opt/node@16/bin:$PATH"' >> ~/.zshrc
```

--------------------------------

### List Sessions Request

Source: https://docs.qoder.com/cloud-agents/api/sessions/list

Example of how to make a GET request to list sessions, specifying a limit. Ensure the Authorization header is correctly set with your Bearer token.

```bash
curl -X GET "https://api.qoder.com/api/v1/cloud/sessions?limit=3" \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### Install System, Python, and Node.js Packages

Source: https://docs.qoder.com/cloud-agents/container-reference

Use the 'packages' field to install additional dependencies like system packages, Python packages, and Node.js packages at container startup.

```json
{
  "config": {
    "packages": {
      "apt": ["postgresql-client", "redis-tools", "ffmpeg"]
    }
  }
}
```

--------------------------------

### Install Skill from Marketplace

Source: https://docs.qoder.com/extensions/skills

Install a skill from the skills.sh marketplace using the `npx skills add` command. The `-a qoder` flag is used for Qoder integration.

```bash
# Install from skills.sh marketplace
npx skills add vercel-labs/agent-browser -a qoder
```

--------------------------------

### Install Skill from GitHub

Source: https://docs.qoder.com/extensions/skills

Install a specific skill from a GitHub repository using the `npx skills add` command. Specify the repository URL and the skill name.

```bash
# Install specific skill from GitHub repository
npx skills add https://github.com/anthropics/skills --skill skill-creator -a qoder
```

--------------------------------

### Example Session Creation Response

Source: https://docs.qoder.com/cloud-agents/quickstart

This is an example JSON response received after creating a session. It includes details about the session and the associated agent.

```json
{
  "id": "sess_019e451b146470cda02c560bf019fb37",
  "agent": {
    "id": "agent_019e451902fe7a2ca42c2dfc62d9320e",
    "name": "my-first-agent",
    "model": "ultimate",
    "instructions": "You are an efficient programming assistant skilled at writing code and troubleshooting issues.",
    "system": "You are an efficient programming assistant skilled at writing code and troubleshooting issues.",
    "tools": [
      {"type": "agent_toolset_20260401", "enabled_tools": ["Bash", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch"]}
    ],
    "mcp_servers": [],
    "default_environment": "",
    "description": "",
    "type": "agent",
    "version": 1,
    "created_at": "2026-05-18T10:00:00Z",
    "updated_at": "2026-05-18T10:00:00Z"
  },
  "agent_id": "agent_019e451902fe7a2ca42c2dfc62d9320e",
  "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428",
  "status": "idle",
  "title": "",
  "turn_status": "idle",
  "memory_store_ids": [],
  "resources": [],
  "vault_ids": [],
  "type": "session",
  "created_at": "2026-05-18T10:01:00Z",
  "updated_at": "2026-05-18T10:01:00Z"
}
```

--------------------------------

### Install Node.js and Manage Versions with nvm-windows

Source: https://docs.qoder.com/troubleshooting/mcp-common-issue

Use nvm-windows to install and switch between Node.js versions. Ensure Node.js v18 or later is installed for MCP compatibility.

```shellscript
nvm install 22.14.0
nvm use 22.14.0
```

```shellscript
node -v
npx -v
```

--------------------------------

### Standard SQL Table Structure Example

Source: https://docs.qoder.com/plugins/database

Example of a CREATE TABLE statement with comments for table and fields, adhering to standard naming conventions.

```sql
-- Table-level comment example
CREATE TABLE user_info (
    id INT COMMENT 'User ID (standard field name: user_id, primary key)',
    name VARCHAR(50) COMMENT 'User name (standard field name: name, real name)',
    created_at DATETIME COMMENT 'Registration time (standard field name: created_at, account creation time)',
    status TINYINT COMMENT 'Status (standard field name: status, enum: 0-disabled 1-normal 2-frozen)',
    PRIMARY KEY (id)
) COMMENT='User basic information table | Standard table name: user_information | Business domain: User domain | Update method: Real-time';
```

--------------------------------

### Install Fish Shell Integration

Source: https://docs.qoder.com/troubleshooting/terminal-execution-exceptions

Add this line to your ~/.config/fish/config.fish file to manually install Fish shell integration for Qoder.

```shellscript
string match -q "$TERM_PROGRAM" "vscode"; and . (code --locate-shell-integration-path fish)
```

--------------------------------

### Legacy SQL Table Structure Example

Source: https://docs.qoder.com/plugins/database

Example of a legacy CREATE TABLE statement with non-standard naming conventions.

```sql
CREATE TABLE tbl_yonghu (
  id        BIGINT AUTO_INCREMENT PRIMARY KEY,
  xin_bie   CHAR(2)     NOT NULL,
  nian_ling INT         NOT NULL,
  gonghao   VARCHAR(32) NOT NULL UNIQUE,
  jiru_date VARCHAR(32)
);
```

--------------------------------

### Create Agent Request Example

Source: https://docs.qoder.com/cloud-agents/api/agents/create

Example cURL command to create a new agent configuration with specified name, model, instructions, tools, and MCP servers.

```bash
curl -X POST "https://api.qoder.com/api/v1/cloud/agents" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "doc-test-agent",
    "model": "ultimate",
    "instructions": "You are a documentation testing assistant.",
    "tools": [
      {
        "type": "agent_toolset_20260401",
        "enabled_tools": ["Bash", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch"]
      }
    ],
    "mcp_servers": [
      {
        "type": "url",
        "name": "weather-service",
        "url": "https://mcp.example.com/sse"
      }
    ]
  }'
```

--------------------------------

### Full Qoder Hooks Configuration Example

Source: https://docs.qoder.com/extensions/hooks

A comprehensive JSON configuration demonstrating how to set up hooks for all five Qoder events: UserPromptSubmit, PreToolUse, PostToolUse, PostToolUseFailure, and Stop. This example includes matchers for specific events and command hooks.

```json
{
  "hooks": {
    "UserPromptSubmit": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "~/.qoder/hooks/check-prompt.sh"
          }
        ]
      }
    ],
    "PreToolUse": [
      {
        "matcher": "Bash",
        "hooks": [
          {
            "type": "command",
            "command": "~/.qoder/hooks/block-dangerous.sh"
          }
        ]
      },
      {
        "matcher": "Write|Edit",
        "hooks": [
          {
            "type": "command",
            "command": ".qoder/hooks/validate-file-path.sh"
          }
        ]
      }
    ],
    "PostToolUse": [
      {
        "matcher": "Write|Edit",
        "hooks": [
          {
            "type": "command",
            "command": ".qoder/hooks/auto-lint.sh"
          }
        ]
      }
    ],
    "PostToolUseFailure": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "~/.qoder/hooks/log-failure.sh"
          }
        ]
      }
    ],
    "Stop": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "~/.qoder/hooks/notify-done.sh"
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Install QoderWake on macOS and Linux

Source: https://docs.qoder.com/qoderwake/quick-start

Use this command to install QoderWake on macOS and Linux systems. It automatically detects your platform, downloads the package, sets up the command entry, and initiates the sign-in process.

```bash
curl -fsSL https://qoder-ide.oss-ap-southeast-1.aliyuncs.com/qoderwake/install.sh | bash
```

--------------------------------

### Initialize and Fetch Environment

Source: https://docs.qoder.com/cloud-agents/quickstart

Sets up API headers and fetches or creates a default environment. Ensure QODER_PAT is exported.

```bash
set -euo pipefail

BASE_URL="https://api.qoder.com/api/v1/cloud"
HEADERS=(
  -H "Authorization: Bearer $QODER_PAT"
)

echo "=== Step 1: Fetch environment ==="
ENV_ID=$(curl -s "$BASE_URL/environments" "${HEADERS[@]}" | jq -r '.data[0].id')
if [ "$ENV_ID" = "null" ] || [ -z "$ENV_ID" ]; then
  echo "No environment found. Creating a default one..."
  ENV_ID=$(curl -s -X POST "$BASE_URL/environments" \
    "${HEADERS[@]}" \
    -H "Content-Type: application/json" \
    -d '{"name":"default","config":{"type":"cloud","networking":{"type":"unrestricted"}}}' | jq -r '.id')
fi
echo "Environment ID: $ENV_ID"
```

--------------------------------

### End-to-End Example: Upload and Get File ID

Source: https://docs.qoder.com/cloud-agents/files

This example shows how to upload a source file and capture its file ID using curl and jq. The file ID is then stored in a variable for subsequent use.

```bash
# 1. Upload the source file
FILE_ID=$(curl -s -X POST https://api.qoder.com/api/v1/cloud/files \
  -H "Authorization: Bearer $QODER_PAT" \
  -F "file=@./app.py" \
  -F "purpose=user_upload" | jq -r '.file_id')

echo "Uploaded: $FILE_ID"
```

--------------------------------

### Get file extension statistics

Source: https://docs.qoder.com/account/teams/openapi/ai-code-metrics

Retrieves statistics for file extensions within an organization for a given start date.

```APIDOC
## GET /v1/organizations/{org_id}/ai-code/file-extensions

### Description
Retrieves statistics for file extensions within an organization for a given start date.

### Method
GET

### Endpoint
/v1/organizations/{org_id}/ai-code/file-extensions

### Parameters
#### Query Parameters
- **start_date** (string) - Required - The start date for the statistics in ISO 8601 format.

### Response
#### Success Response (200)
- **success** (boolean) - Whether the request succeeded.
- **data.commits** (array) - Commit details list (preserves request order).
  - **data.commits[].commitHash** (string) - Commit hash.
  - **data.commits[].rangeAnnotations** (array) - File-level AI attribution annotations.
    - **data.commits[].rangeAnnotations[].filePath** (string) - File path.
    - **data.commits[].rangeAnnotations[].groups** (array) - AI session contribution groups.
      - **data.commits[].rangeAnnotations[].groups[].conversationId** (string) - AI session ID.
      - **data.commits[].rangeAnnotations[].groups[].source** (string) - Source: `AGENT`, `NEXT`, `QUEST`, `INLINECHAT`.
      - **data.commits[].rangeAnnotations[].groups[].productType** (string) - Product type (lowercase, e.g., `ide`).
      - **data.commits[].rangeAnnotations[].groups[].type** (string) - Type: `added` (added), `deleted` (deleted).
      - **data.commits[].rangeAnnotations[].groups[].ranges** (array) - Line range list.
        - **data.commits[].rangeAnnotations[].groups[].ranges[].start** (int32) - Start line number.
        - **data.commits[].rangeAnnotations[].groups[].ranges[].end** (int32) - End line number.

#### Response Example
{
  "success": true,
  "data": {
    "commits": [
      {
        "commitHash": "abc123def456",
        "rangeAnnotations": [
          {
            "filePath": "src/main.js",
            "groups": [
              {
                "conversationId": "conv_123",
                "source": "AGENT",
                "productType": "ide",
                "type": "added",
                "ranges": [
                  {
                    "start": 10,
                    "end": 20
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Cloud Environment with Preinstalled Packages

Source: https://docs.qoder.com/cloud-agents/environments

Configure an environment to automatically install specified packages (apt, pip, npm) upon startup. This can increase environment startup time.

```json
{
  "config": {
    "type": "cloud",
    "networking": {"type": "unrestricted"},
    "packages": {
      "apt": ["git", "build-essential", "libssl-dev"],
      "pip": ["pandas", "numpy", "scikit-learn"],
      "npm": ["typescript", "eslint", "prettier"]
    }
  }
}
```

--------------------------------

### Session Status Running SSE Example

Source: https://docs.qoder.com/cloud-agents/api/sessions/stream-events

This SSE event indicates that the session has started running. It includes session and turn identifiers.

```text
id: evt_771c1195bcbd4a07834d4ed4dd6450ca
event: session.status_running
data: {"id": "evt_771c1195bcbd4a07834d4ed4dd6450ca", "type": "session.status_running", "turn_id": "turn_019e392c0d787ceea6bb62943f9ac3ec", "created_at": "2026-05-18T03:40:50.321Z", "session_id": "sess_019e392c0d1e74e095d21ea4c6b41def", "processed_at": "2026-05-18T03:40:50.321Z", "schema_version": "1.0"}
```

--------------------------------

### Get File Extension Statistics

Source: https://docs.qoder.com/account/teams/openapi/ai-code-metrics

Retrieve statistics on AI code usage by file extension, starting from a specified date. Requires an API key.

```bash
curl -X GET "https://api.qoder.com/v1/organizations/org_xxx/ai-code/file-extensions?start_date=2025-06-01T00:00:00Z" \
  -H "Authorization: Bearer <api_key>"
```

--------------------------------

### Example cURL Request to Get a Skill

Source: https://docs.qoder.com/cloud-agents/api/skills/get

Use this cURL command to retrieve a specific skill's details by providing its ID and authorization token.

```bash
curl -X GET https://api.qoder.com/api/v1/cloud/skills/skill_019e3bba474b73cfaf19eae9b5f5e66d \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### Example Environment Response

Source: https://docs.qoder.com/cloud-agents/api/environments/get

This is a successful HTTP 200 OK response containing the detailed configuration and metadata for a requested environment.

```json
{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "",
  "status": "ready",
  "config": {
    "type": "cloud",
    "networking": {
      "type": "limited"
    },
    "packages": {
      "apt": [
        "curl"
      ]
    }
  },
  "archived": false,
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:07.017808Z"
}
```

--------------------------------

### Get Agent Request Example

Source: https://docs.qoder.com/cloud-agents/api/agents/get

Use this cURL command to retrieve the full details of a specific agent by providing its ID in the path and the authorization token in the header.

```bash
curl -X GET "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### Lightweight Mobile Chat Example

Source: https://docs.qoder.com/qoderwork/im-channels

Send simple queries directly in your IM channel to get quick answers from configured MCP tools and data sources. This is ideal for straightforward Q&A.

```plaintext
Help me find the quote sent to Company XX
```

--------------------------------

### Version Skill using curl

Source: https://docs.qoder.com/cloud-agents/skills

Example demonstrating how to create a new version of a skill by bumping the version in SKILL.md and re-uploading the zip archive.

```bash
# Bump the version field in SKILL.md, then re-upload
curl -X POST https://api.qoder.com/api/v1/cloud/skills \
  -H "Authorization: Bearer $QODER_PAT" \
  -F "file=@my-skill-v2.zip"
```

--------------------------------

### Create a Data-Science Environment

Source: https://docs.qoder.com/cloud-agents/environments

Create a new cloud environment named 'data-science' with specific apt and pip packages preinstalled and unrestricted networking.

```bash
# Create a data-science Environment
curl -s -X POST https://api.qoder.com/api/v1/cloud/environments \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "data-science",
    "config": {
      "type": "cloud",
      "networking": {"type": "unrestricted"},
      "packages": {
        "apt": ["build-essential"],
        "pip": ["pandas", "numpy", "matplotlib", "scikit-learn", "jupyter"]
      }
    }
  }' | jq .
```

--------------------------------

### Example Rule Deeplink

Source: https://docs.qoder.com/user-guide/deeplink

This is a direct example of a rule deeplink. It specifies the rule name and its content.

```plaintext
qoder://aicoding.aicoding-deeplink/rule?name=typescript-conventions&text=Always%20use%20strict%20TypeScript%20types
```

--------------------------------

### Verify uv Installation

Source: https://docs.qoder.com/troubleshooting/mcp-common-issue

Verify that the 'uv' Python environment manager has been successfully installed by checking its version.

```shellscript
uv --version
```

--------------------------------

### Example Quest Deeplink

Source: https://docs.qoder.com/user-guide/deeplink

This is a direct example of a quest deeplink. It specifies the task text and the execution agent class.

```plaintext
qoder://aicoding.aicoding-deeplink/quest?text=Implement%20user%20authentication%20with%20JWT&agentClass=LocalWorktree
```

--------------------------------

### List Available Environments

Source: https://docs.qoder.com/cloud-agents/quickstart

Fetch a list of available cloud environments for your account. This command requires your PAT for authentication.

```bash
curl -s https://api.qoder.com/api/v1/cloud/environments \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### Create Introductory PPT from Academic Paper

Source: https://docs.qoder.com/qoderwork/user-stories

Generates a beginner-friendly PPT from an academic paper, explaining core ideas in plain English with simple diagrams.

```plaintext
Create an introductory PPT from this paper:
Paper link: https://arxiv.org/abs/xxxx.xxxxx
Requirements:
1. Explain core ideas in plain English for non-experts
2. One main point per slide, with simple diagrams or analogies
3. 12–15 slides: background, main method, key results, implications
4. Last slide: suggested further reading
```

--------------------------------

### Example Full URL

Source: https://docs.qoder.com/account/teams/openapi/conventions

Illustrates the structure of a full URL for accessing members within an organization.

```text
https://api.qoder.com/v1/organizations/{organization_id}/members
```

--------------------------------

### Install bash Shell Integration

Source: https://docs.qoder.com/troubleshooting/terminal-execution-exceptions

Add this line to your ~/.bashrc file to manually install bash shell integration for Qoder.

```shellscript
[[ "$TERM_PROGRAM" == "vscode" ]] && . "$(code --locate-shell-integration-path bash)"
```

--------------------------------

### Automate Internal Platform Deployment Skill Creation

Source: https://docs.qoder.com/qoderwork/user-stories

Use create-skill to transform a manual release process into a reusable 'Release Assistant' Skill for consistent and efficient deployments.

```plaintext
Run the Release Assistant Skill, target environment: production.
```

--------------------------------

### Install zsh Shell Integration

Source: https://docs.qoder.com/troubleshooting/terminal-execution-exceptions

Add this line to your ~/.zshrc file to manually install zsh shell integration for Qoder.

```shellscript
[[ "$TERM_PROGRAM" == "vscode" ]] && . "$(code --locate-shell-integration-path zsh)"
```

--------------------------------

### Install PowerShell Shell Integration

Source: https://docs.qoder.com/troubleshooting/terminal-execution-exceptions

Add this line to your PowerShell profile ($Profile) to manually install PowerShell shell integration for Qoder.

```powershell
if ($env:TERM_PROGRAM -eq "vscode") { . "$(code --locate-shell-integration-path pwsh)" }
```

--------------------------------

### Create Skill using curl

Source: https://docs.qoder.com/cloud-agents/skills

Example using curl to package a skill directory into a zip archive and then upload it to the create skill API endpoint. Requires an authorization token.

```bash
# Package the skill directory
cd my-skill && zip -r ../my-skill.zip . && cd ..

# Upload
curl -X POST https://api.qoder.com/api/v1/cloud/skills \
  -H "Authorization: Bearer $QODER_PAT" \
  -F "file=@my-skill.zip"
```

--------------------------------

### Vault Creation Response Example

Source: https://docs.qoder.com/cloud-agents/vaults

This is an example of a successful response after creating a Vault. Note that the access token is not included in the response for security.

```json
{
  "id": "vault_019e5cdb9c3f71c3b6505eba937a40b4",
  "type": "vault",
  "display_name": "My GitHub credentials",
  "status": "active",
  "credentials": [
    {
      "id": "vcred_019e5cdb9c4f72a3b6505eba937a40c5",
      "vault_id": "vault_019e5cdb9c3f71c3b6505eba937a40b4",
      "status": "active",
      "mcp_server_url": "https://mcp.github.com/sse",
      "protocol": "sse",
      "type": "static_bearer",
      "created_at": "2026-05-18T08:00:00Z",
      "updated_at": "2026-05-18T08:00:00Z"
    }
  ],
  "metadata": {},
  "created_at": "2026-05-18T08:00:00Z",
  "updated_at": "2026-05-18T08:00:00Z"
}
```

--------------------------------

### Example Output of Tool Configuration

Source: https://docs.qoder.com/cloud-agents/tools

This JSON represents the tool configuration as returned by the inspection command. It lists the enabled tools for the agent.

```json
[
  {
    "type": "agent_toolset_20260401",
    "enabled_tools": ["Bash", "Read", "Write", "Edit", "Glob", "Grep", "WebFetch", "WebSearch"]
  }
]
```

--------------------------------

### Invalid Request Error Example

Source: https://docs.qoder.com/cloud-agents/api/conventions/errors

This example demonstrates an `invalid_request_error` triggered by a missing required field. Ensure all required parameters are present and correctly formatted.

```json
{
  "type": "error",
  "error": {
    "type": "invalid_request_error",
    "message": "Missing required field: name",
    "param": "name"
  }
}
```

--------------------------------

### Get Download URL (Bash)

Source: https://docs.qoder.com/cloud-agents/api/files/download

Use this command to obtain the presigned download URL for a file. The -X GET flag specifies the HTTP method.

```bash
# Get the download URL (do not follow redirects)
curl -X GET "https://api.qoder.com/api/v1/cloud/files/file_019e3bb9b0c2752688aeb5fdacf00565/content" \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### Example Response - HTTP 200 OK

Source: https://docs.qoder.com/cloud-agents/api/files/list

A successful response containing a list of file objects. Includes pagination details like first ID, last ID, and whether more pages are available.

```json
{
  "data": [
    {
      "created_at": "2026-05-18T15:33:53Z",
      "file_id": "file_019e3bb8e6c47d189212a79642136696",
      "filename": "report.txt",
      "metadata": {
        "project": "test"
      },
      "mime_type": "text/plain",
      "purpose": "session_resource",
      "size_bytes": 110,
      "status": "ready",
      "updated_at": "2026-05-18T15:33:54Z"
    }
  ],
  "first_id": "file_019e3bb8e6c47d189212a79642136696",
  "has_more": false,
  "last_id": "file_019e3bb8e6c47d189212a79642136696"
}
```

--------------------------------

### List All Environments

Source: https://docs.qoder.com/cloud-agents/environments

Retrieve a list of all available cloud environments using a GET request to the environments endpoint.

```bash
# List all Environments
curl -s https://api.qoder.com/api/v1/cloud/environments \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### JavaScript EventSource Example

Source: https://docs.qoder.com/cloud-agents/events-stream

Example using the browser's EventSource API to connect to the events stream, handle agent messages, and session status updates.

```javascript
const url = new URL('https://api.qoder.com/api/v1/cloud/sessions/sess_abc123/events/stream');
// To resume: url.searchParams.set('after_id', lastEventId);

const es = new EventSource(url, {
  headers: { 'Authorization': `Bearer ${QODER_PAT}` }
});

es.addEventListener('agent.message', (e) => {
  const data = JSON.parse(e.data);
  console.log('Agent:', data.content);
});

es.addEventListener('session.status_idle', () => {
  console.log('Turn complete; awaiting next user input');
});

es.addEventListener('session.error', (e) => {
  const data = JSON.parse(e.data);
  console.error('Error:', data.error);
  es.close();
});

es.onerror = () => {
  console.warn('Connection lost; the browser will reconnect automatically');
};
```

--------------------------------

### Example successful vault list response

Source: https://docs.qoder.com/cloud-agents/api/vaults/list

An example of a successful HTTP 200 OK response when listing vaults, including vault details and pagination information.

```json
{
  "data": [
    {
      "id": "vault_019e3bb940277f0db05ab74291acf6ef",
      "type": "vault",
      "display_name": "my-mcp-vault",
      "status": "active",
      "metadata": {},
      "created_at": "2026-05-18T15:34:16.874877Z",
      "updated_at": "2026-05-18T15:34:16.874877Z"
    }
  ],
  "first_id": "vault_019e3bb940277f0db05ab74291acf6ef",
  "last_id": "vault_019e3bb940277f0db05ab74291acf6ef",
  "has_more": false
}
```

--------------------------------

### Create Environment Request

Source: https://docs.qoder.com/cloud-agents/api/environments/create

Use this `curl` command to send a POST request to create a new cloud execution environment. Ensure you replace `$QODER_PAT` with your actual Personal Access Token.

```bash
curl -s -X POST 'https://api.qoder.com/api/v1/cloud/environments' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "doc-test-env",
    "config": {
      "type": "cloud",
      "networking": {
        "type": "limited"
      },
      "packages": {
        "apt": ["curl"]
      }
    }
  }'
```

--------------------------------

### Example JSON Response for a Skill

Source: https://docs.qoder.com/cloud-agents/api/skills/get

This is a successful HTTP 200 OK response containing the details of a requested skill.

```json
{
  "id": "skill_019e3bba474b73cfaf19eae9b5f5e66d",
  "type": "skill",
  "name": "test-skill-api-doc",
  "description": "A test skill for API documentation",
  "skill_type": "custom",
  "status": "active",
  "version": 1,
  "content_size": 309,
  "content_sha256": "f253cb7d35790025f85917c0c239422cff1de067d00278db8897c585a3f28d94",
  "metadata": {},
  "created_at": "2026-05-18T15:35:24.248164Z",
  "updated_at": "2026-05-18T15:35:24.248164Z"
}
```

--------------------------------

### List All Skills

Source: https://docs.qoder.com/cloud-agents/api/skills/list

Use this command to retrieve a list of all skills under the current account. Ensure your Authorization header is correctly set.

```bash
# List all skills
curl -X GET https://api.qoder.com/api/v1/cloud/skills \
  -H "Authorization: Bearer $QODER_PAT"
```

--------------------------------

### Technical Guide Generation Prompt

Source: https://docs.qoder.com/qoderwork/writing

Use this format to instruct the agent to create a technical guide from rough notes. Specify the target audience and key topics.

```plaintext
@oss-notes.md
Turn these rough notes into a technical guide for engineers new
to Alibaba Cloud OSS. Cover core concepts, storage classes,
permissions, upload/download mechanics, lifecycle, monitoring,
and best practices. Use code examples and comparison tables.
```

--------------------------------

### Create an Environment

Source: https://docs.qoder.com/cloud-agents/environments

Creates a new cloud environment with a specified name, network configuration, and preinstalled packages. A successful call returns a 201 Created status.

```APIDOC
## POST /api/v1/cloud/environments

### Description
Creates a new cloud environment.

### Method
POST

### Endpoint
https://api.qoder.com/api/v1/cloud/environments

### Parameters
#### Request Body
- **name** (string) - Required - The name of the environment.
- **config** (object) - Required - The configuration for the environment.
  - **type** (string) - Required - The type of environment, e.g., "cloud".
  - **networking** (object) - Required - Network configuration.
    - **type** (string) - Required - Type of networking, e.g., "unrestricted", "limited", "allowed_hosts".
    - **allowed_hosts** (array) - Optional - List of allowed host strings if networking type is "allowed_hosts".
  - **packages** (object) - Optional - Specifies preinstalled packages.
    - **apt** (array) - Optional - List of Debian/Ubuntu system packages.
    - **pip** (array) - Optional - List of Python packages.
    - **npm** (array) - Optional - List of Node.js packages.

### Request Example
```json
{
  "name": "data-science",
  "config": {
    "type": "cloud",
    "networking": {"type": "unrestricted"},
    "packages": {
      "apt": ["build-essential"],
      "pip": ["pandas", "numpy", "matplotlib", "scikit-learn", "jupyter"]
    }
  }
}
```

### Response
#### Success Response (201 Created)
- **id** (string) - The unique identifier of the created environment.
- **type** (string) - The type of the resource, e.g., "environment".
- **name** (string) - The name of the environment.
- **description** (string) - A description of the environment.
- **config** (object) - The configuration of the environment.
- **status** (string) - The current status of the environment (e.g., "ready").
- **archived** (boolean) - Indicates if the environment is archived.
- **archived_at** (string) - Timestamp when the environment was archived.
- **created_at** (string) - Timestamp when the environment was created.
- **updated_at** (string) - Timestamp when the environment was last updated.

#### Response Example
```json
{
  "id": "env_019e44eb66bb748cabcd1489f6fa4428",
  "type": "environment",
  "name": "data-science",
  "description": "",
  "config": {
    "type": "cloud",
    "networking": {"type": "unrestricted"},
    "packages": {
      "apt": ["build-essential"],
      "pip": ["pandas", "numpy", "matplotlib", "scikit-learn", "jupyter"]
    }
  },
  "status": "ready",
  "archived": false,
  "archived_at": null,
  "created_at": "2026-05-18T10:00:00Z",
  "updated_at": "2026-05-18T10:00:00Z"
}
```
```

--------------------------------

### Example Deeplink for Adding MCP Server

Source: https://docs.qoder.com/user-guide/deeplink

This is an example of a deeplink used to add an MCP server to the AICoding IDE. It includes the server name and a Base64 encoded configuration.

```deeplink
qoder://aicoding.aicoding-deeplink/mcp/add?name=postgres&config=JTdCJTIyY29tbWFuZCUyMiUzQSUyMm5weCUyMiUyQyUyMmFyZ3MlMjIlM0ElNUIlMjIteSUyMiUyQyUyMiU0MG1vZGVsY29udGV4dHByb3RvY29sJTJGc2VydmVyLXBvc3RncmVzJTIyJTJDJTIycG9zdGdyZXNxbCUzQSUyRiUyRmxvY2FsaG9zdCUyRm15ZGIlMjIlNUQlN0Q%3D
```

--------------------------------

### Paginated Session Response Example

Source: https://docs.qoder.com/cloud-agents/sessions

An example of the JSON response structure when listing sessions, including session data, pagination identifiers, and a flag indicating if more results are available.

```json
{
  "data": [
    {
      "id": "sess_019e5ce0bf9074b69c3481e93771a522",
      "type": "session",
      "agent_id": "agent_019e5ce0bf307a1a8f952eb814aea3d5",
      "environment_id": "env_019e44eb66bb748cabcd1489f6fa4428",
      "status": "idle",
      "turn_status": "idle",
      "title": "",
      "memory_store_ids": [],
      "vault_ids": [],
      "resources": [],
      "created_at": "2026-05-18T12:00:00Z",
      "updated_at": "2026-05-18T12:30:00Z"
    }
  ],
  "first_id": "sess_019e5ce0bf9074b69c3481e93771a522",
  "last_id": "sess_019e5ce0bf9074b69c3481e93771a522",
  "has_more": false
}
```