Python SDK

The SDK talks to cloud and to your local runtime.

Vued Desktop or headless must be running for decrypted methods like search, get_meeting, and list_files.

Install

pip install vued

API key

For local decrypted methods, Desktop and headless store scoped local SDK auth automatically:

client = Vued()

For cloud methods, CI/server use, or an explicit override, set or pass a public API key:

export VUED_API_KEY="vued_live_..."

client = Vued(api_key="vued_live_...")

If VUED_API_KEY is stale or belongs to another user, local methods fall back to the runtime-stored key. Passing api_key=... explicitly remains a strict override.

Quick start

from vued import Vued

client = Vued(
    base_url="https://vued-office-api-dev.onrender.com/v1",
    timeout=30.0,
    auto_start_daemon=True,
    auto_open_desktop=True,
    desktop_open_timeout=8.0,
    telemetry=True,
)

results = client.search("customer renewal risk", limit=5)
meeting = client.get_meeting(results["items"][0]["meeting"]["id"])
print(meeting["transcript"]["text"])

Download Markdown:

path = client.download_meeting(meeting["meeting"]["id"])
print(path)

Cloud metadata:

client = Vued(api_key="vued_live_...")
orgs = client.list_orgs()
room = client.create_room(display_name="Conference Room", microphone_id="tablet-01")

If no runtime is reachable:

VuedLocalUnavailableError

Start Vued Desktop, or run:

vued setup

Options

Parameter	Type	Meaning
`api_key`	string \| null	Optional `vued_live_...` public API key. Defaults to `VUED_API_KEY`. Local methods can omit it after Desktop or headless setup. Cloud methods require it.
`org_id`	string \| null	Optional org override. Standard public API keys are scoped to one org and resolve automatically.
`base_url`	string	Cloud `/v1` base URL.
`timeout`	float	HTTP timeout seconds.
`auto_start_daemon`	boolean	Start installed Vued headless when a local plaintext method needs it. Defaults to true.
`auto_open_desktop`	boolean	On macOS, open Vued Desktop automatically when a local plaintext method needs it.
`desktop_open_timeout`	float	Seconds to wait for the local runtime API after opening Desktop.
`telemetry`	boolean	Send SDK identity and request telemetry headers. Disable with `telemetry=False` or `VUED_TELEMETRY_DISABLED=1`.

Local methods

client.search(q, type=None, include_transcript=True, limit=20)
client.semantic_search(q, type=None, limit=5)
client.list_meetings(type=None, started_after=None, started_before=None, room_id=None, microphone_id=None, file_id=None, limit=100, cursor=None)
client.get_meeting(meeting_id)
client.download_meeting(meeting_id, path=".")
client.get_transcript(transcript_id)
client.list_files(type=None, q=None, parent_id=None, root_only=None, visibility=None, record_id=None, created_after=None, created_before=None, updated_after=None, updated_before=None, sort=None, limit=50, cursor=None)
client.get_file(file_id)

Cloud methods

client.list_orgs(limit=50, cursor=None)
client.get_meeting_audio(meeting_id)
client.get_transcript_audio(transcript_id)

client.create_file(name="Folder", type="folder", parent_id=None, visibility="org")
client.update_file(file_id, name=None, parent_id=..., visibility=None)
client.list_file_grants(file_id, limit=50, cursor=None)
client.grant_file(file_id, user_id)
client.revoke_file_grant(file_id, user_id)

client.list_speakers(q=None, limit=50, cursor=None)
client.get_speaker(speaker_id)
client.list_rooms(q=None, limit=50, cursor=None)
client.get_room(room_id)
client.create_room(display_name="Conference Room", microphone_id="mic-1")
client.update_room(room_id, display_name=None, microphone_id=None, is_primary=None, participant_user_ids=None)
client.list_microphones(limit=50, cursor=None)
client.get_microphone(microphone_id)
client.list_users(q=None, limit=50, cursor=None)
client.get_user(user_id)

client.list_api_keys(limit=50, cursor=None)
client.create_api_key(name="Public API key", expires_at=None, scopes=None)
client.revoke_api_key(key_id)

client.list_webhooks(limit=50, cursor=None)
client.create_webhook(name="Webhook", url="https://example.com/vued", events=["meeting.finalized"])
client.update_webhook(webhook_id, name=None, url=None, events=None, payload_fields=None, disabled=None)
client.delete_webhook(webhook_id)

Headless helpers

client.local_status()
client.ensure_daemon(start=True)

The SDK discovers VUED_LOCAL_API_URL + VUED_LOCAL_API_TOKEN, VUED_LOCAL_API_DISCOVERY, then the shared OS local-api.json written by either Vued Desktop or Vued headless.

Get Started

MCP

Headless CLI

Docs Ops

API Reference

Webhooks

Install

API key

Quick start

Options

Local methods

Cloud methods

Headless helpers

​Install

​API key

​Quick start

​Options

​Local methods

​Cloud methods

​Headless helpers

Install

API key

Quick start

Options

Local methods

Cloud methods

Headless helpers