Zo

https://docs.zocomputer.com
Admin
Zo is a personal cloud computer platform that combines AI chat, file storage, integrations,...
Tokens:36,637
Snippets:312
Trust Score:5.6
Update:7 months ago
Show doc for...
Tokens:
Raw
### Install SyncThing on Zo via CLI

Source: https://docs.zocomputer.com/sync-files

A sequence of shell commands to install the SyncThing repository and package on a Linux-based Zo system. This requires root privileges and internet access to fetch the GPG key and package lists.

```bash
mkdir -p /etc/apt/keyrings
curl -L -o /etc/apt/keyrings/syncthing-archive-keyring.gpg https://syncthing.net/release-key.gpg
echo "deb [signed-by=/etc/apt/keyrings/syncthing-archive-keyring.gpg] https://apt.syncthing.net/ syncthing stable-v2" | tee /etc/apt/sources.list.d/syncthing.list
apt-get update
apt-get install syncthing
```

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

### Configure Claude Desktop for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Guide to adding the ZoComputer MCP server configuration to Claude Desktop. This involves specifying the command to run mcp-remote and its arguments within the `claude_desktop_config.json` file.

```json
{
  "mcpServers": {
    "zo": {
      "command": "npx",
      "args": [
        "mcp-remote@latest",
        "https://api.zo.computer/mcp",
        "--header",
        "Authorization: Bearer zo_sk_your_key_here"
      ]
    }
  }
}
```

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

### Configure Codex for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Guide to configuring OpenAI's Codex CLI tool to use the ZoComputer MCP endpoint. This includes command-line options and manual configuration in `~/.codex/config.toml`.

```bash
codex mcp add zo -- npx -y mcp-remote https://api.zo.computer/mcp \
  --header "Authorization:Bearer zo_sk_your_key_here" --transport http-only
```

```toml
[mcp_servers.zo]
command = "npx"
args = ["-y", "mcp-remote", "https://api.zo.computer/mcp", "--header", "Authorization:Bearer zo_sk_your_key_here", "--transport", "http-only"]
```

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

### GET /models/available

Source: https://docs.zocomputer.com/api

Retrieves a list of all AI models currently available for use.

```APIDOC
## GET /models/available

### Description
Fetches a list of available AI models that can be used for processing requests.

### Method
GET

### Endpoint
https://api.zo.computer/models/available

### Response
#### Success Response (200)
- **models** (array) - List of available model objects.
```

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

### GET /personas/available

Source: https://docs.zocomputer.com/api-reference/personas/list-available-personas

Retrieves a list of all configured personas. If an API key is provided, it returns the personas associated with the key owner.

```APIDOC
## GET /personas/available

### Description
List all configured personas. When authenticated with an API key, returns personas for the key owner.

### Method
GET

### Endpoint
https://api.zo.computer/personas/available

### Parameters
None

### Request Example
GET /personas/available
Authorization: Bearer zo_sk_...

### Response
#### Success Response (200)
- **personas** (array) - List of configured personas
  - **id** (string) - Unique persona identifier
  - **name** (string) - Display name
  - **prompt** (string) - System prompt defining the persona's behavior
  - **model** (string|null) - AI model ID, or null for system default
  - **image** (string|null) - Avatar image URL

#### Response Example
{
  "personas": [
    {
      "id": "persona_123",
      "name": "Helpful Assistant",
      "prompt": "You are a helpful assistant.",
      "model": "gpt-4",
      "image": "https://example.com/avatar.png"
    }
  ]
}
```

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

### GET /models/available

Source: https://docs.zocomputer.com/api

List all available models you can use with the `/zo/ask` endpoint. When authenticated with an API key, this endpoint includes your BYOK (Bring Your Own Key) configurations.

```APIDOC
## GET /models/available

### Description
List all available models you can use with the `/zo/ask` endpoint. When authenticated with an API key, this endpoint includes your BYOK (Bring Your Own Key) configurations.

### Method
GET

### Endpoint
/models/available

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **models** (array) - List of available models
  - **model_name** (string) - The value to pass to `model_name` in `/zo/ask`
  - **label** (string) - Human-readable model name
  - **vendor** (string) - Model provider (e.g., "Anthropic", "OpenAI", "Custom")
  - **description** (string | null) - Short description of the model's capabilities
  - **type** (string | null) - Either "fast" or "capable", indicating the model's speed/capability tradeoff
  - **context_window** (number | null) - Maximum context window size in tokens
  - **is_byok** (boolean) - Whether this is a BYOK (Bring Your Own Key) model

#### Response Example
```json
{
  "models": [
    {
      "model_name": "byok:3d078e43-1465-4d67-a399-35ef1a8ea1e6",
      "label": "My Custom Model",
      "vendor": "Custom",
      "description": "BYOK: openai format",
      "type": null,
      "context_window": null,
      "is_byok": true
    },
    {
      "model_name": "anthropic:claude-haiku-4-5-20251001",
      "label": "Haiku 4.5",
      "vendor": "Anthropic",
      "description": "Anthropic's fastest model...",
      "type": "fast",
      "context_window": 200000,
      "is_byok": false
    }
  ]
}
```
```

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

### List App Tools

Source: https://docs.zocomputer.com/tools/list-app-tools

Lists all available tools and configured props for an app connected by the user.

```APIDOC
## POST /websites/zocomputer/apps/tools

### Description
List all available tools and configured props for an app connected by the user.

### Method
POST

### Endpoint
/websites/zocomputer/apps/tools

### Parameters
#### Query Parameters
- **app_slug** (string) - Required - The app slug to list tools for.

### Request Example
```json
{
  "app_slug": "example_app_slug"
}
```

### Response
#### Success Response (200)
- **tools** (array) - A list of available tools and their properties.
  - **name** (string) - The name of the tool.
  - **description** (string) - A description of the tool.
  - **props** (object) - The configured properties for the tool.

#### Response Example
```json
{
  "tools": [
    {
      "name": "example_tool",
      "description": "An example tool.",
      "props": {
        "prop1": "value1",
        "prop2": "value2"
      }
    }
  ]
}
```
```

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

### Configure Gemini CLI for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Instructions for setting up the Gemini CLI to connect to the ZoComputer MCP endpoint. This can be done via the command line or by manually editing the `~/.gemini/settings.json` file.

```bash
gemini mcp add zo https://api.zo.computer/mcp --transport http --scope user \
  -H "Authorization: Bearer zo_sk_your_key_here"
```

```json
{
  "mcpServers": {
    "zo": {
      "url": "https://api.zo.computer/mcp",
      "type": "http",
      "headers": {
        "Authorization": "Bearer zo_sk_your_key_here"
      }
    }
  }
}
```

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

### Diagnose Service

Source: https://docs.zocomputer.com/tools/service-doctor

Diagnose issues and get details about the status of a user_service.

```APIDOC
## POST /websites/zocomputer/diagnose

### Description
Diagnose issues and get details about the status of a user_service.

### Method
POST

### Endpoint
/websites/zocomputer/diagnose

### Parameters
#### Query Parameters
- **service** (string) - Required - Service label or service_id to inspect.

### Request Example
```json
{
  "service": "user_service_123"
}
```

### Response
#### Success Response (200)
- **status** (string) - The current status of the service.
- **issues** (array) - A list of any detected issues.
- **details** (object) - Additional diagnostic details.

#### Response Example
```json
{
  "status": "operational",
  "issues": [],
  "details": {
    "cpu_usage": "25%",
    "memory_usage": "50%"
  }
}
```
```

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

### GET /list_stripe_payment_links

Source: https://docs.zocomputer.com/tools/list-stripe-payment-links

Retrieves a list of all payment links associated with the user account, with support for test mode filtering.

```APIDOC
## GET /list_stripe_payment_links

### Description
List all payment links for the user. This endpoint allows retrieving active payment links and can be toggled to view test mode links.

### Method
GET

### Endpoint
/list_stripe_payment_links

### Parameters
#### Query Parameters
- **testmode** (boolean) - Optional - Use test mode (default: false)

### Request Example
GET /list_stripe_payment_links?testmode=false

### Response
#### Success Response (200)
- **data** (array) - A list of payment link objects.

#### Response Example
{
  "data": [
    {
      "id": "plink_123",
      "url": "https://buy.stripe.com/test_123"
    }
  ]
}
```

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

### POST /websites/zocomputer

Source: https://docs.zocomputer.com/tools/create-website

Creates a new site, also known as an app or a website, within the zocomputer platform. You can specify the site's name, template variant, parent path, and whether to force overwrite.

```APIDOC
## POST /websites/zocomputer

### Description
Creates a new site (also known as an app, or a website).

### Method
POST

### Endpoint
/websites/zocomputer

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of the project, e.g. my-app (lowercase, no spaces).
- **variant** (string) - Optional - The template variant to use (blank, blog, event, slides, data, marketing). Defaults to 'blank'.
- **parent_path_parts** (string[]) - Optional - Workspace-relative (/home/workspace/...parts/name) path segments where the project will be created, e.g. ["projects"] or empty for root of workspace.
- **force** (boolean) - Optional - Whether to overwrite an existing directory with the same name. Defaults to false.

### Request Example
```json
{
  "name": "my-new-app",
  "variant": "blog",
  "parent_path_parts": ["projects"],
  "force": true
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the site was created successfully.

#### Response Example
```json
{
  "message": "Site 'my-new-app' created successfully."
}
```
```

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

### Documentation Index

Source: https://docs.zocomputer.com/tools/list-stripe-orders

Fetch the complete documentation index for Zocomputer LLMs.

```APIDOC
## GET /websites/zocomputer/documentation/index

### Description
Fetch the complete documentation index at the provided URL. This index helps discover all available documentation pages.

### Method
GET

### Endpoint
/websites/zocomputer/documentation/index

### Parameters
None

### Request Example
```
GET /websites/zocomputer/documentation/index HTTP/1.1
Host: docs.zocomputer.com
```

### Response
#### Success Response (200)
- **documentation_url** (string) - The URL to the documentation index file (e.g., https://docs.zocomputer.com/llms.txt).

#### Response Example
```json
{
  "documentation_url": "https://docs.zocomputer.com/llms.txt"
}
```
```

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

### Ask Zo API

Source: https://docs.zocomputer.com/api-reference/ai/ask-zo

Send a message to your Zo and get a response. Use `stream: true` for Server-Sent Events streaming.

```APIDOC
## POST /ask

### Description
Send a message to Zo and receive a response. Supports streaming responses via Server-Sent Events.

### Method
POST

### Endpoint
/ask

### Parameters
#### Query Parameters
- **stream** (boolean) - Optional - Set to `true` to enable Server-Sent Events streaming.

#### Request Body
- **message** (string) - Required - The message to send to Zo.

### Request Example
```json
{
  "message": "Hello Zo, can you tell me about AI?"
}
```

### Response
#### Success Response (200)
- **response** (string) - The response from Zo.
- **stream** (string) - If `stream: true` is used, this will contain the streamed response data.

#### Response Example
```json
{
  "response": "Artificial intelligence (AI) is intelligence demonstrated by machines, as opposed to the natural intelligence displayed by humans and animals."
}
```
```

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

### GET /personas/available

Source: https://docs.zocomputer.com/api

Retrieves a list of available personas including their prompts, models, and avatar images.

```APIDOC
## GET /personas/available

### Description
Returns a list of configured personas with their specific behavioral prompts and settings.

### Method
GET

### Endpoint
https://api.zo.computer/personas/available

### Response
#### Success Response (200)
- **personas[].prompt** (string) - System prompt defining the persona's behavior.
- **personas[].model** (string | null) - AI model ID, or null for system default.
- **personas[].image** (string | null) - Avatar image URL.
```

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

### Configure SSH Host Shortcut

Source: https://docs.zocomputer.com/ssh-computer

This configuration snippet defines a shortcut named 'laptop' for connecting to your computer via SSH. Replace placeholders like <host>, <port>, and <user> with your specific connection details. The ServerAlive settings help maintain an active connection.

```sh
Host laptop
   HostName <host>
   Port <port>
   User <user>
   ServerAliveInterval 30
   ServerAliveCountMax 3
   IdentityFile ~/.ssh/id_ed25519
```

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

### General MCP Client Configuration for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Provides general settings for any MCP-compatible client connecting to ZoComputer's HTTP endpoint. It also explains how to use `mcp-remote` as a bridge for clients that only support stdio transport.

```bash
npx -y mcp-remote https://api.zo.computer/mcp --header "Authorization:Bearer zo_sk_your_key_here" --transport http-only
```

```json
{
  "command": "npx",
  "args": ["-y", "mcp-remote", "https://api.zo.computer/mcp", "--header", "Authorization:Bearer zo_sk_your_key_here", "--transport", "http-only"]
}
```

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

### POST /zo/ask

Source: https://docs.zocomputer.com/api-reference/ai/ask-zo

Send a message to your Zo and get a response. Supports conversation continuity, custom model selection, and structured output formats.

```APIDOC
## POST /zo/ask

### Description
Send a message to your Zo and get a response. Use `stream: true` for Server-Sent Events streaming.

### Method
POST

### Endpoint
/zo/ask

### Parameters
#### Request Body
- **input** (string) - Required - Your message to Zo
- **conversation_id** (string|null) - Optional - Continue an existing conversation
- **model_name** (string|null) - Optional - Override the default model
- **persona_id** (string|null) - Optional - Override the active persona
- **output_format** (object|null) - Optional - JSON Schema for structured output
- **stream** (boolean) - Optional - Enable streaming mode (default: false)

### Request Example
{
  "input": "Hello, how are you?",
  "conversation_id": "conv-123",
  "stream": false
}

### Response
#### Success Response (200)
- **output** (string|object) - Zo's response
- **conversation_id** (string|null) - ID to continue this conversation

#### Response Example
{
  "output": "I am doing well, thank you!",
  "conversation_id": "conv-123"
}
```

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

### Get Space Route by Path

Source: https://docs.zocomputer.com/tools/get-space-route

Retrieves a specific space route by its path, including its source code. This is useful for inspecting route code before making modifications.

```APIDOC
## GET /websites/zocomputer/spaces/route

### Description
Retrieves a specific space route by its path, including its source code. This is useful for inspecting route code before making modifications.

### Method
GET

### Endpoint
/websites/zocomputer/spaces/route

### Parameters
#### Query Parameters
- **path** (string) - Required - Route path, e.g. '/api/hello' or '/about'.

### Request Example
```json
{
  "path": "/api/hello"
}
```

### Response
#### Success Response (200)
- **source_code** (string) - The source code of the route.

#### Response Example
```json
{
  "source_code": "// Example route code"
}
```
```

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

### POST /tools/create-stripe-product

Source: https://docs.zocomputer.com/tools

Creates a new Stripe product on the user's connected account.

```APIDOC
## POST /tools/create-stripe-product

### Description
Creates a Stripe product on the user's connected account.

### Method
POST

### Endpoint
/tools/create-stripe-product

### Request Body
- **name** (string) - Required - Name of the product
- **description** (string) - Optional - Description of the product

### Request Example
{
  "name": "Premium Subscription",
  "description": "Monthly access to premium features"
}

### Response
#### Success Response (200)
- **id** (string) - The created Stripe product ID

#### Response Example
{
  "id": "prod_12345"
}
```

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

### GET /personas/available

Source: https://docs.zocomputer.com/api

List all configured personas. Use the returned `id` values with the `persona_id` parameter in `/zo/ask` to override the active persona.

```APIDOC
## GET /personas/available

### Description
List all configured personas. Use the returned `id` values with the `persona_id` parameter in `/zo/ask` to override the active persona.

### Method
GET

### Endpoint
/personas/available

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **personas** (array) - List of configured personas
  - **id** (string) - The value to pass to `persona_id` in `/zo/ask`
  - **name** (string) - Display name for the persona
  - **prompt** (string) - The prompt used for the persona
  - **model** (string | null) - The default model for the persona
  - **image** (string | null) - URL for the persona's image

#### Response Example
```json
{
  "personas": [
    {
      "id": "a1b2c3d4",
      "name": "Technical Writer",
      "prompt": "You are a concise technical writer...",
      "model": "anthropic:claude-sonnet-4",
      "image": null
    },
    {
      "id": "e5f6g7h8",
      "name": "Data Analyst",
      "prompt": "You analyze data and produce insights...",
      "model": null,
      "image": "https://static.z.computer/img/persona/649a97ba-c7af-4d63-b401-b0660cd91dd2.png"
    }
  ]
}
```
```

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

### Use Device

Source: https://docs.zocomputer.com/tools/use-device

Executes a specified command on a user's device. Currently supports agent-browser commands for browser automation.

```APIDOC
## Use device

### Description
Run a command on the user's device (currently supports agent-browser for browser automation).

### Method
POST

### Endpoint
/websites/zocomputer/use_device

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **device** (string) - Required - Name of the device to use (e.g. "ian's macbook air"). Must match a registered device.
- **command** (string) - Required - The agent-browser command to execute (e.g. "agent-browser open [https://github.com](https://github.com)").

### Request Example
```json
{
  "device": "ian's macbook air",
  "command": "agent-browser open https://github.com"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the command execution.
- **output** (string) - The output from the executed command, if any.

#### Response Example
```json
{
  "status": "success",
  "output": "Browser opened successfully."
}
```
```

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

### Zo API Response Format

Source: https://docs.zocomputer.com/api

Example of the JSON response structure returned by the Zo API. Includes the text output and the associated conversation identifier.

```json
{
  "output": "Hello! How can I help you today?",
  "conversation_id": "conv_abc123"
}
```

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

### POST /zo/ask

Source: https://docs.zocomputer.com/api

Send a message to your Zo and get a response. This endpoint allows for conversational interactions, model and persona overrides, and structured output formatting.

```APIDOC
## POST /zo/ask

### Description
Send a message to your Zo and get a response. This endpoint allows for conversational interactions, model and persona overrides, and structured output formatting.

### Method
POST

### Endpoint
/zo/ask

### Parameters
#### Query Parameters
None

#### Request Body
- **input** (string) - Required - Your message to Zo
- **conversation_id** (string) - Optional - Continue an existing conversation
- **model_name** (string) - Optional - Override the default model (use `/models/available` to list options)
- **persona_id** (string) - Optional - Override the active persona (use `/personas/available` to list options)
- **output_format** (object) - Optional - JSON Schema for structured output
- **stream** (boolean) - Optional - Enable streaming mode. Returns Server-Sent Events (SSE) instead of JSON. Defaults to `false`.

### Request Example
```json
{
  "input": "Add 52% to the humidity log",
  "conversation_id": null,
  "model_name": null,
  "persona_id": null,
  "output_format": null,
  "stream": false
}
```

### Response
#### Success Response (200)
- **output** (string | object) - Zo's response. Returns an object if `output_format` was specified.
- **conversation_id** (string) - ID to continue this conversation in subsequent requests.

#### Response Example
```json
{
  "output": "Done! Added 52% humidity reading for today.",
  "conversation_id": "conv_abc123"
}
```

#### Streaming Response (when `stream: true`)
Returns a Server-Sent Events stream with `Content-Type: text/event-stream`.

**Event Types:**
- `FrontendModelResponse` — Text chunk from the model (`data.content`)
- `End` — Stream completed (includes `data.output` if `output_format` was specified)
- `Error` — Error occurred (`data.message`)

The `x-conversation-id` response header contains the conversation ID for follow-up requests.
```

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

### POST /use_app_dropbox

Source: https://docs.zocomputer.com/tools/use-app-dropbox

Executes a specific tool action on a connected Dropbox account using Pipedream.

```APIDOC
## POST /use_app_dropbox

### Description
Executes a predefined tool action for the Dropbox integration. This endpoint requires the tool name and configuration properties to perform operations on the user's Dropbox account.

### Method
POST

### Endpoint
/use_app_dropbox

### Parameters
#### Request Body
- **tool_name** (string) - Required - Exact tool name returned by `list_app_tools`.
- **configured_props** (string) - Required - The configured props for the action (e.g., `{\"filePath\": \"/home/workspace/profile.jpeg\", \"mimeType\": \"image/jpeg\"}`).
- **download_path** (string) - Optional - Optional write location for downloaded files on the host filesystem.
- **email** (string) - Optional - Optional email address to select a specific connected account.

### Request Example
{
  \"tool_name\": \"upload_file\",
  \"configured_props\": \"{\\\"path\\\": \\\"/test.txt\\\"}\",
  \"email\": \"user@example.com\"
}

### Response
#### Success Response (200)
- **status** (string) - The execution status of the tool.
- **result** (object) - The output data from the Dropbox action.

#### Response Example
{
  \"status\": \"success\",
  \"result\": {\"id\": \"id_12345\"}
}
```

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

### Run Sequential Commands

Source: https://docs.zocomputer.com/tools/run-sequential-cmds

Execute a list of shell commands sequentially in a specified working directory.

```APIDOC
## POST /websites/zocomputer/run_sequential_cmds

### Description
Run multiple shell commands sequentially on the computer. Zo can execute shell commands in a bash session, allowing for system operations, script execution, and command-line automation.

### Method
POST

### Endpoint
/websites/zocomputer/run_sequential_cmds

### Parameters
#### Request Body
- **cmd_list** (string[]) - Required - A list of shell command strings to execute in order.
- **cwd** (string) - Optional - The working directory in which to execute the commands. Defaults to the user's workspace root.

### Request Example
```json
{
  "cmd_list": [
    "echo 'Hello'",
    "ls -l"
  ],
  "cwd": "/home/workspace"
}
```

### Response
#### Success Response (200)
- **output** (string) - The combined output of all executed commands.
- **errors** (string) - Any errors encountered during command execution.

#### Response Example
```json
{
  "output": "Hello\n-rw-r--r-- 1 user user 1024 Jan 1 10:00 file.txt",
  "errors": ""
}
```
```

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

### Configure Zed for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Details on how to add the ZoComputer MCP server to the Zed code editor's settings. This involves updating the `~/.config/zed/settings.json` file with the server URL and authorization headers.

```json
{
  "context_servers": {
    "zo": {
      "settings": {},
      "url": "https://api.zo.computer/mcp",
      "headers": {
        "Authorization": "Bearer zo_sk_your_key_here"
      }
    }
  }
}
```

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

### POST /use_app_spotify

Source: https://docs.zocomputer.com/tools/use-app-spotify

Executes a specific Spotify tool action or performs a search query on the user's connected Spotify account.

```APIDOC
## POST /use_app_spotify

### Description
Executes a tool to interact with the user's connected Spotify account, supporting both predefined tool actions and music searches.

### Method
POST

### Endpoint
/use_app_spotify

### Parameters
#### Request Body
- **tool_name** (string) - Required - Exact tool name from `list_app_tools`, or "spotify-search" to search for music
- **configured_props** (string) - Required - Props for the action. For search: `{"type": "track|album|artist|playlist"}`. For actions: see list_app_tools
- **search_query** (string) - Optional - Search string (required when tool_name="spotify-search"), e.g., "Drake Hotline Bling"

### Request Example
{
  "tool_name": "spotify-search",
  "configured_props": "{\"type\": \"track\"}",
  "search_query": "Drake Hotline Bling"
}

### Response
#### Success Response (200)
- **status** (string) - The result status of the tool execution
- **data** (object) - The requested Spotify data or action confirmation

#### Response Example
{
  "status": "success",
  "data": {
    "id": "3yfqSUWyeyEhmqiHIAUvLz",
    "name": "Hotline Bling",
    "artist": "Drake"
  }
}
```

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

### Retrieve available AI models via OpenAPI

Source: https://docs.zocomputer.com/api-reference/ai/list-available-models

Defines the GET /models/available endpoint for the Zo API. This specification includes the response schema for model lists and authentication via bearer tokens.

```yaml
openapi: 3.1.0
info:
  title: Zo API
  version: 1.0.0
servers:
  - url: https://api.zo.computer
    description: Zo API
security:
  - bearerAuth: []
paths:
  /models/available:
    get:
      tags:
        - AI
      summary: List available models
      description: >-
        List all available models. When authenticated with an API key, includes
        BYOK configurations.
      operationId: getAvailableModels
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZoModelsResponse'
components:
  schemas:
    ZoModelsResponse:
      properties:
        models:
          items:
            $ref: '#/components/schemas/ZoModelInfo'
          type: array
          title: Models
          description: List of available AI models
        featured_models_are_free:
          type: boolean
          title: Featured Models Are Free
          description: When true, frontend shows Free badge on featured models
      type: object
      required:
        - models
        - featured_models_are_free
      title: ZoModelsResponse
      description: Response from /models/available endpoint.
    ZoModelInfo:
      properties:
        model_name:
          type: string
          title: Model Name
          description: Unique model identifier (e.g., 'anthropic:claude-sonnet-4')
        label:
          type: string
          title: Label
          description: Human-readable model name
        vendor:
          type: string
          title: Vendor
          description: Model provider (e.g., 'Anthropic', 'OpenAI')
        type:
          anyOf:
            - type: string
              enum:
                - free
                - subscribers
            - type: 'null'
          title: Type
          description: 'Access tier: ''free'' (available to all) or ''subscribers'' (paid only)'
        priority:
          anyOf:
            - type: number
            - type: 'null'
          title: Priority
          description: Sort priority for UI pickers; lower values appear first
        context_window:
          anyOf:
            - type: integer
            - type: 'null'
          title: Context Window
          description: Maximum context length in tokens
        is_byok:
          type: boolean
          title: Is Byok
          description: True if this is a user-configured BYOK model
          default: false
      type: object
      required:
        - model_name
        - label
        - vendor
      title: ZoModelInfo
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Zo API key (zo_sk_...)
```

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

### Configure Cursor for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Instructions for integrating the ZoComputer MCP endpoint into the Cursor AI code editor. This is done by adding the server details to the `~/.cursor/mcp.json` configuration file.

```json
{
  "mcpServers": {
    "zo": {
      "url": "https://api.zo.computer/mcp",
      "headers": {
        "Authorization": "Bearer zo_sk_your_key_here"
      }
    }
  }
}
```

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

### List Available Models (GET /models/available)

Source: https://docs.zocomputer.com/api

Retrieves a list of all available models that can be used with the `/zo/ask` endpoint. This includes custom BYOK (Bring Your Own Key) configurations when authenticated. The response is a JSON object containing an array of model details.

```json
{
  "models": [
    {
      "model_name": "byok:3d078e43-1465-4d67-a399-35ef1a8ea1e6",
      "label": "My Custom Model",
      "vendor": "Custom",
      "description": "BYOK: openai format",
      "type": null,
      "context_window": null,
      "is_byok": true
    },
    {
      "model_name": "anthropic:claude-haiku-4-5-20251001",
      "label": "Haiku 4.5",
      "vendor": "Anthropic",
      "description": "Anthropic's fastest model...",
      "type": "fast",
      "context_window": 200000,
      "is_byok": false
    }
  ]
}
```

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

### POST /create_stripe_product

Source: https://docs.zocomputer.com/tools/create-stripe-product

Creates a new Stripe product on the user's connected account with optional price and payment link configuration.

```APIDOC
## POST /create_stripe_product

### Description
Creates a Stripe product on the user's connected account. Optionally creates a price and payment link if amount_cents is provided.

### Method
POST

### Endpoint
/create_stripe_product

### Parameters
#### Request Body
- **name** (string) - Required - Product name (e.g., "Consulting Session", "E-book Download")
- **description** (string) - Optional - Product description
- **amount_cents** (number) - Optional - Price in cents (e.g., 1000 for $10.00). If provided, creates a price and payment link.
- **currency** (string) - Optional - Currency code (default: "usd")
- **recurring** (object) - Optional - For subscriptions, provide interval info (e.g., {"interval": "month", "interval_count": 1})
- **redirect_url** (string) - Optional - URL to redirect customer to after payment
- **hosted_confirmation_message** (string) - Optional - Custom message for Stripe's hosted confirmation page
- **testmode** (boolean) - Optional - Use test mode (default: false)

### Request Example
{
  "name": "Consulting Session",
  "amount_cents": 5000,
  "currency": "usd",
  "testmode": true
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created Stripe product
- **payment_link** (string) - The URL for the generated payment link (if applicable)

#### Response Example
{
  "id": "prod_12345",
  "payment_link": "https://buy.stripe.com/test_abc123"
}
```

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

### List Available Personas (GET /personas/available)

Source: https://docs.zocomputer.com/api

Fetches a list of all configured personas. The `id` returned for each persona can be used with the `persona_id` parameter in the `/zo/ask` endpoint to override the default persona. The response is a JSON object containing an array of persona details.

```json
{
  "personas": [
    {
      "id": "a1b2c3d4",
      "name": "Technical Writer",
      "prompt": "You are a concise technical writer...",
      "model": "anthropic:claude-sonnet-4",
      "image": null
    },
    {
      "id": "e5f6g7h8",
      "name": "Data Analyst",
      "prompt": "You analyze data and produce insights...",
      "model": null,
      "image": "https://static.z.computer/img/persona/649a97ba-c7af-4d63-b401-b0660cd91dd2.png"
    }
  ]
}
```

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

### POST /create_or_rewrite_file

Source: https://docs.zocomputer.com/tools/create-or-rewrite-file

This endpoint allows users to create a new file or overwrite the contents of an existing file at a specified path.

```APIDOC
## POST /create_or_rewrite_file

### Description
Creates a new file or rewrites an existing one with the provided content. Returns a status message and the absolute path of the affected file.

### Method
POST

### Endpoint
/create_or_rewrite_file

### Parameters
#### Request Body
- **target_file** (string) - Required - The absolute path of the file to create or rewrite.
- **content** (string) - Optional - The content to write to the file. Defaults to an empty string.

### Request Example
{
  "target_file": "/path/to/file.txt",
  "content": "Hello World"
}

### Response
#### Success Response (200)
- **message** (string) - Success or failure status message.
- **path** (string) - The absolute path of the file.

#### Response Example
{
  "message": "File created successfully",
  "path": "/path/to/file.txt"
}
```

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

### Change Hardware Configuration

Source: https://docs.zocomputer.com/tools/change-hardware

Allows modification of the GPU, CPU, and RAM for a Zo computer.

```APIDOC
## Change Hardware Configuration

### Description
Change the GPU, CPU, or RAM configuration of your Zo computer.

### Method
POST

### Endpoint
/websites/zocomputer/change_hardware

### Parameters
#### Query Parameters
- **gpu** (string) - Optional - GPU type string (e.g., 'A100', 'H100:2'). Pass None to keep current or no GPU.
- **cpu** (number) - Optional - CPU cores as float (e.g., 4.0 for 4 cores). Pass None to keep plan default.
- **memory_mb** (number) - Optional - Memory in MiB (e.g., 8192 for 8 GiB). Pass None to keep plan default.

### Request Example
```json
{
  "gpu": "A100",
  "cpu": 8.0,
  "memory_mb": 16384
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "Hardware configuration updated successfully."
}
```
```

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

### POST /use_app_notion

Source: https://docs.zocomputer.com/tools/use-app-notion

Executes a specific tool action within a connected Notion account.

```APIDOC
## POST /use_app_notion

### Description
Executes a predefined tool action on a connected Notion account. This endpoint requires the tool name and the specific configuration properties for the action.

### Method
POST

### Endpoint
/use_app_notion

### Parameters
#### Request Body
- **tool_name** (string) - Required - Exact tool name returned by `list_app_tools`.
- **configured_props** (string) - Required - The configured props for the action (e.g., `{"title": "", "sortDirection": "ascending", "pageSize": 100}`).
- **email** (string) - Optional - Email address to select a specific connected account.

### Request Example
{
  "tool_name": "get_database",
  "configured_props": "{\"database_id\": \"12345\"}",
  "email": "user@example.com"
}

### Response
#### Success Response (200)
- **result** (object) - The output of the executed Notion tool action.

#### Response Example
{
  "status": "success",
  "data": {
    "id": "12345",
    "object": "database"
  }
}
```

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

### Configure Claude Code CLI for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Instructions for adding the ZoComputer MCP server to Claude Code CLI, either via command line or by manually editing the settings file. This enables the CLI to communicate with the ZoComputer API.

```bash
claude mcp add --transport http zo https://api.zo.computer/mcp \
  --header "Authorization: Bearer zo_sk_your_key_here"
```

```json
{
  "mcpServers": {
    "zo": {
      "type": "http",
      "url": "https://api.zo.computer/mcp",
      "headers": {
        "Authorization": "Bearer zo_sk_your_key_here"
      }
    }
  }
}
```

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

### Authenticate GitHub CLI with Token

Source: https://docs.zocomputer.com/github

Uses the GitHub CLI to authenticate the current session by passing a personal access token. This command requires a valid token with repo, read:org, and gist permissions.

```bash
gh auth login --with-token <your-personal-access-token>
```

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

### POST /tools/create-agent

Source: https://docs.zocomputer.com/tools

Creates a new agent to automatically run an AI task.

```APIDOC
## POST /tools/create-agent

### Description
Creates an agent to automatically run an AI task.

### Method
POST

### Endpoint
/tools/create-agent

### Request Body
- **name** (string) - Required - Name of the agent
- **instructions** (string) - Required - AI behavior instructions

### Request Example
{
  "name": "SupportAgent",
  "instructions": "Answer customer queries based on documentation."
}

### Response
#### Success Response (200)
- **agent_id** (string) - The unique ID of the created agent

#### Response Example
{
  "agent_id": "agt_98765"
}
```

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

### Configure Microsoft OneDrive Tool Parameters

Source: https://docs.zocomputer.com/tools/use-app-microsoft-onedrive

Defines the required and optional parameters for the use_app_microsoft_onedrive tool. This configuration allows users to specify the tool name, action properties, download destinations, and account email identifiers.

```json
{
  "tool_name": "string",
  "configured_props": {
    "fileId": "abc123"
  },
  "download_path": "/path/to/save",
  "email": "user@example.com"
}
```

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

### Configure OpenCode for ZoComputer

Source: https://docs.zocomputer.com/mcp-server

Steps to configure the OpenCode AI coding agent to use the ZoComputer MCP endpoint. This requires updating the `opencode.json` file with the server's type, URL, and authentication headers.

```json
{
  "mcp": {
    "zo": {
      "type": "remote",
      "url": "https://api.zo.computer/mcp",
      "headers": {
        "Authorization": "Bearer zo_sk_your_key_here"
      }
    }
  }
}
```

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

### POST /create_persona

Source: https://docs.zocomputer.com/tools/create-persona

Creates a new persona for Zo by providing a name, system prompt, and optional avatar.

```APIDOC
## POST /create_persona

### Description
Creates a new persona for Zo. This endpoint initializes a persona with a specific system prompt and display name.

### Method
POST

### Endpoint
/create_persona

### Parameters
#### Request Body
- **name** (string) - Required - Persona display name.
- **prompt** (string) - Required - System prompt text for the persona.
- **image** (string) - Optional - Optional image URL for the persona avatar.

### Request Example
{
  "name": "Helpful Assistant",
  "prompt": "You are a helpful assistant.",
  "image": "https://example.com/avatar.png"
}

### Response
#### Success Response (200)
- **status** (string) - Success message
- **id** (string) - The unique identifier of the created persona

#### Response Example
{
  "status": "success",
  "id": "persona_12345"
}
```
Tokens:
Raw