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

# Vued api setup prompt

> Canonical reference: `docs/vued-api-guide-for-coding-agents.md`
>
> If anything below contradicts source, read the canonical reference and source files. Report staleness back to the user.

# Vued API Setup Guide

## Your Configuration

| Setting                | Value                                             |
| ---------------------- | ------------------------------------------------- |
| Integration            | Python SDK                                        |
| Package                | `vued`                                            |
| Auth env var           | `VUED_API_KEY`                                    |
| Org env var            | `VUED_ORG_ID`                                     |
| Cloud base URL         | `https://vued-office-api-dev.onrender.com/v1`     |
| Decrypted content path | Local desktop API / SDK local methods / local MCP |
| MCP command            | `vued mcp`                                        |

## API Key Setup

```bash theme={null}
export VUED_API_KEY="vued_live_..."
export VUED_ORG_ID="00000000-0000-0000-0000-000000000000"
```

```python theme={null}
import os
from vued import Vued

client = Vued(
    api_key=os.environ["VUED_API_KEY"],
    org_id=os.environ["VUED_ORG_ID"],
)
```

## Quick Start

```bash theme={null}
pip install vued
```

```python theme={null}
from vued import Vued, VuedLocalUnavailableError

client = Vued(api_key="vued_live_...", org_id="org_uuid")

try:
    results = client.search("customer renewal risk", limit=5)
except VuedLocalUnavailableError:
    raise SystemExit("Open and unlock Vued Desktop.")

meeting = client.get_meeting(results["items"][0]["meeting"]["id"])
print(meeting["transcript"]["text"])
```

## Pick Your Pattern

### 1. Decrypted meeting retrieval

Use local methods when the app or agent needs plaintext transcripts.

```python theme={null}
results = client.search("pricing discussion", include_transcript=True, limit=10)
meeting = client.get_meeting(results["items"][0]["meeting"]["id"])
```

### 2. Fuzzy memory retrieval

Use semantic search when wording may differ.

```python theme={null}
results = client.semantic_search("decisions about enterprise rollout", limit=5)
```

### 3. Cloud metadata writes

Use cloud methods for folders, rooms, API keys, and webhooks.

```python theme={null}
folder = client.create_file(name="Customer calls", type="folder", visibility="restricted")
room = client.create_room(display_name="Conference Room", microphone_id="tablet-01")
```

### 4. Agent tool use

Use local MCP for coding agents that should answer from decrypted Vued memory.

```bash theme={null}
vued mcp
```

Manual MCP config:

```json theme={null}
{
  "mcpServers": {
    "vued": {
      "command": "vued",
      "args": ["mcp"]
    }
  }
}
```

## Tool Function Example

```python theme={null}
import json
from vued import Vued

client = Vued(api_key=os.environ["VUED_API_KEY"], org_id=os.environ["VUED_ORG_ID"])

def vued_search(query: str) -> str:
    """Search decrypted Vued meeting memories."""
    page = client.search(query, limit=5)
    return json.dumps(page["items"], ensure_ascii=False)
```

Tool schema:

```json theme={null}
{
  "type": "function",
  "function": {
    "name": "vued_search",
    "description": "Search decrypted Vued meeting memories.",
    "parameters": {
      "type": "object",
      "properties": {
        "query": {
          "type": "string",
          "description": "Meeting memory search query."
        }
      },
      "required": ["query"]
    }
  }
}
```

## Reference

| Method                                      | Use                                          |
| ------------------------------------------- | -------------------------------------------- |
| `search`                                    | Exact terms, names, phrases, decisions.      |
| `semantic_search`                           | Fuzzy memory search.                         |
| `list_meetings`                             | Browse by source/time/room/microphone/file.  |
| `get_meeting`                               | Full meeting plus transcript.                |
| `get_transcript`                            | One transcript event plus parent meeting.    |
| `list_files`, `get_file`                    | Decrypted file/folder names.                 |
| `create_file`, `update_file`                | Cloud file/folder mutations.                 |
| `get_meeting_audio`, `get_transcript_audio` | Short-lived signed audio URLs.               |
| `create_webhook`                            | Public webhook with one-time signing secret. |

## Troubleshooting

* Desktop unavailable: open and unlock Vued Desktop.
* Multiple orgs cached: pass `org_id` or set `VUED_ORG_ID`.
* Need plaintext transcript: use local SDK methods or MCP, not cloud routes.
* Need signed audio: call cloud audio helpers; URLs expire quickly.
* Need remote MCP: not currently implemented in checked server source. Use local MCP.
* File move: omit `parent_id` to keep parent; pass `None` to move to root.

## Resources

* Coding-agent reference: `docs/vued-api-guide-for-coding-agents.md`
* Human reference: `docs/local-api-sdk-mcp.md`
* Docs index: `docs/llms.txt`
* SDK quickstart: `vued-python-sdk/examples/quickstart.py`