> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octen.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Octen Skills

> Add Octen skills to Claude Code, Cursor, Codex, and other agents.

<p style={{ fontSize: "0.8rem", opacity: 0.6 }}>For AI agents: <a href="https://docs.octen.ai/integrations/octen-skills.md">docs.octen.ai/integrations/octen-skills.md</a></p>

## Why Octen Skills

Octen Skills put Octen inside your agent: live broad web search and UI design references with clean, model-ready context.

<CardGroup cols={2}>
  <Card title="Fast" icon="bolt">
    Web search averages 62ms. Fast enough for multi-step agent workflows.
  </Card>

  <Card title="Accurate" icon="bullseye">
    Powered by SOTA text and VL embedding models. Better sources, fewer hallucinations.
  </Card>

  <Card title="Fresh" icon="clock-rotate-left">
    Live web data with minute-level updates. Useful for news, prices, and fast-moving pages.
  </Card>

  <Card title="Efficient" icon="filter">
    Clean highlights, optional full content, and time and domain filters keep model context relevant.
  </Card>
</CardGroup>

## Get started

<CardGroup cols={2}>
  <Card title="Get API Key" icon="key" href="https://octen.ai/platform/api-keys">
    Create a key from the API Platform.
  </Card>

  <Card title="GitHub" icon="github" href="https://github.com/Octen-Team/octen-skills">
    View and install the skills.
  </Card>
</CardGroup>

## Skills

| Skill              | Endpoint                             | Use for                                                                                       |
| ------------------ | ------------------------------------ | --------------------------------------------------------------------------------------------- |
| octen-search       | `POST /broad-search`, `POST /search` | Search bars, answer engines, news lookup, and broad multi-angle research.                     |
| octen-image-search | `POST /image-search`                 | Image lookup and visual references. Invite-only beta — contact us for access.                 |
| octen-video-search | `POST /video-search`                 | Video lookup, clip discovery, and media previews. Invite-only beta — contact us for access.   |
| octen-extract      | `POST /extract`                      | Reading pages, cleaning articles, and knowledge ingestion.                                    |
| octen-design       | `POST /image-search`                 | UI design references and inspiration for frontends. Invite-only beta — contact us for access. |

## Installation

<Tabs>
  <Tab title="Claude Code">
    ```bash theme={null}
    npx skills add Octen-Team/octen-skills -a claude-code
    ```
  </Tab>

  <Tab title="Cursor">
    ```bash theme={null}
    npx skills add Octen-Team/octen-skills -a cursor
    ```
  </Tab>

  <Tab title="Codex">
    ```bash theme={null}
    npx skills add Octen-Team/octen-skills -a codex
    ```
  </Tab>

  <Tab title="Gemini CLI">
    ```bash theme={null}
    npx skills add Octen-Team/octen-skills -a gemini-cli
    ```
  </Tab>

  <Tab title="OpenClaw">
    ```bash theme={null}
    npx skills add Octen-Team/octen-skills -a openclaw
    ```
  </Tab>

  <Tab title="Other agents">
    `skills` auto-detects your current agent — just run:

    ```bash theme={null}
    npx skills add Octen-Team/octen-skills
    ```
  </Tab>
</Tabs>

### Without Node (curl)

If you can't run `npx`, copy the `skills/` directory into your agent's skills folder:

```bash theme={null}
mkdir -p <skills-dir> && \
  curl -sL https://github.com/Octen-Team/octen-skills/archive/main.tar.gz | \
  tar xz -C <skills-dir> --strip-components=2 octen-skills-main/skills
```

## API key

Set `OCTEN_API_KEY` before using either skill. Get a key from the [API Platform](https://octen.ai/platform/api-keys).

<Tabs>
  <Tab title="Claude Code">
    Add to `~/.claude/settings.json`:

    ```json theme={null}
    {
      "env": {
        "OCTEN_API_KEY": "your-key"
      }
    }
    ```

    For per-project use, add the same `env` block to `.claude/settings.local.json`.
  </Tab>

  <Tab title="Cursor">
    Use `direnv` for a directory-scoped key:

    ```bash theme={null}
    echo 'export OCTEN_API_KEY="your-key"' >> .envrc
    direnv allow
    ```

    Or export it in your shell profile (`~/.zshrc` or `~/.bashrc`), then fully quit and reopen Cursor:

    ```bash theme={null}
    export OCTEN_API_KEY="your-key"
    ```
  </Tab>

  <Tab title="Codex">
    Add to `~/.codex/config.toml`:

    ```toml theme={null}
    [shell_environment_policy]
    set = { OCTEN_API_KEY = "your-key" }
    ```

    Or export it in your shell profile (`~/.zshrc` or `~/.bashrc`).
  </Tab>

  <Tab title="OpenClaw">
    Add to `~/.openclaw/.env`:

    ```bash theme={null}
    OCTEN_API_KEY=your-key
    ```
  </Tab>

  <Tab title="Other agents">
    Export the key in the shell environment your agent runs in (covers Hermes Agent, Gemini CLI, Windsurf, and others):

    ```bash theme={null}
    export OCTEN_API_KEY="your-key"
    ```
  </Tab>
</Tabs>

### octen-search

```bash theme={null}
curl -s -X POST "https://api.octen.ai/broad-search" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${OCTEN_API_KEY}" \
  -d '{"query": "latest AI research 2026", "count": 5}'
```

For broad, multi-angle coverage, pass the full question as-is — Octen expands it into sub-queries searched concurrently and returns results grouped per sub-query:

```bash theme={null}
curl -s -X POST "https://api.octen.ai/broad-search" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${OCTEN_API_KEY}" \
  -d '{
    "query": "compare cloud GPU pricing across major providers",
    "max_queries": 5,
    "search_options": {"count": 10, "highlight": {"enable": true}}
  }'
```

### octen-image-search — invite-only beta

Image lookup, visual references, and design assets — search by text or a reference image.

```bash theme={null}
curl -s -X POST "https://api.octen.ai/image-search" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${OCTEN_API_KEY}" \
  -d '{
    "inputs": [{"type": "text", "data": "red sports car"}],
    "count": 5
  }'
```

### octen-video-search — invite-only beta

Video lookup, clip discovery, and media previews.

```bash theme={null}
curl -s -X POST "https://api.octen.ai/video-search" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${OCTEN_API_KEY}" \
  -d '{
    "inputs": [{"type": "text", "data": "how to make espresso"}],
    "count": 5
  }'
```

### octen-extract

```bash theme={null}
curl -s -X POST "https://api.octen.ai/extract" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${OCTEN_API_KEY}" \
  -d '{
    "urls": ["https://example.com", "https://octen.ai"],
    "format": "markdown"
  }'
```

### octen-design — invite-only beta

Find real UI references — each `design` hit returns a reference image, a structured style `summary`, and a reusable `html_snippet`.

```bash theme={null}
curl -s -X POST "https://api.octen.ai/image-search" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ${OCTEN_API_KEY}" \
  -d '{
    "inputs": [{"type": "text", "data": "pricing comparison table, dark theme, SaaS"}],
    "topic": "design",
    "count": 5,
    "html_snippet": {"enable": true, "max_tokens": 5000}
  }'
```

## When to use each skill

| Need                                      | Skill                                 |
| ----------------------------------------- | ------------------------------------- |
| Comprehensive, multi-angle research       | `octen-search` (broad search)         |
| A quick web search                        | `octen-search`                        |
| Recent news or fast-changing topics       | `octen-search` with time filters      |
| Results scoped to specific sites          | `octen-search` with `include_domains` |
| Photos, diagrams, or visual references    | `octen-image-search` (beta)           |
| Videos, clips, or a moment within a video | `octen-video-search` (beta)           |
| Reading known URLs as clean content       | `octen-extract`                       |
| UI reference, style tokens, or HTML/CSS   | `octen-design` (beta)                 |