Complete Lightbulb Python SDK reference

active_company_id

@property
def active_company_id() -> str | None

The currently selected company context (needed for write operations).

Source: lightbulb/client.py:222

active_company_id

@active_company_id.setter
def active_company_id(value: str | None) -> None

Source: lightbulb/client.py:227

apply_aoc_tick

def apply_aoc_tick(tick_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Apply a previously-computed AutoCompany tick (committing its decisions).

Source: lightbulb/client.py:2265

apply_code_workspace_proposal

def apply_code_workspace_proposal(workspace_id: str, proposal_id: str) -> Dict[str, Any]

Apply a previously-submitted proposal to the workspace files.

Source: lightbulb/client.py:1768

approve_runtime_action

def approve_runtime_action(action_id: str) -> Dict[str, Any]

Approve (activate) a pending runtime action — ADMIN/TENANT only (``POST /api/domain-agents/runtime-actions/{id}/approve``).

Approve (activate) a pending runtime action — ADMIN/TENANT only
(``POST /api/domain-agents/runtime-actions/{id}/approve``).

Source: lightbulb/client.py:1341

approve_task

def approve_task(task_id: str, *, comments: str='') -> Dict[str, Any]

Approve a pending HITL task.

Source: lightbulb/client.py:1098

approve_voice_action

def approve_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

Approve a pending in-call action (e.g. transfer, wire info, commit booking).

Source: lightbulb/client.py:1415

backbone_execute

def backbone_execute(objective: str, *, inputs: Dict[str, Any] | None=None) -> Dict[str, Any]

Execute a task through the backbone agent (research, analysis, code generation).

Source: lightbulb/client.py:978

cancel_code_workspace_run

def cancel_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

Cancel an in-flight coding run.

Source: lightbulb/client.py:1812

claude_session_action

def claude_session_action(workspace_id: str, session_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Perform an action on a Claude SDK session.

Perform an action on a Claude SDK session.

action: one of rename, tag, fork, delete, interrupt, mcp/reconnect,
        mcp/toggle, rewind, tasks/stop, compact

Source: lightbulb/client.py:2024

code_workspace_add_collaborator

def code_workspace_add_collaborator(workspace_id: str, *, email: str | None=None, user_id: str | None=None, role: str='viewer') -> Dict[str, Any]

Add a collaborator to a code workspace (role: viewer | editor | admin).

Source: lightbulb/client.py:1572

code_workspace_add_note

def code_workspace_add_note(workspace_id: str, content: str) -> Dict[str, Any]

Append a workspace note (visible to collaborators).

Source: lightbulb/client.py:1671

code_workspace_approve_access_request

def code_workspace_approve_access_request(workspace_id: str, request_id: str) -> Dict[str, Any]

Approve a pending workspace access request.

Source: lightbulb/client.py:1649

code_workspace_chat

def code_workspace_chat(workspace_id: str, message: str, **kwargs) -> Dict[str, Any]

Send a chat message to a code workspace.

Source: lightbulb/client.py:860

code_workspace_clear_policy

def code_workspace_clear_policy(workspace_id: str, request_family: str) -> Dict[str, Any]

Clear cached policy decisions for a request family.

Source: lightbulb/client.py:1979

code_workspace_collaboration

def code_workspace_collaboration(workspace_id: str) -> Dict[str, Any]

Get collaboration info (members, share links, pending requests).

Source: lightbulb/client.py:1562

code_workspace_create_pull_request

def code_workspace_create_pull_request(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Open a GitHub pull request from the workspace branch.

Source: lightbulb/client.py:1790

code_workspace_create_share_link

def code_workspace_create_share_link(workspace_id: str, *, role: str='viewer', expires_in_seconds: int | None=None) -> Dict[str, Any]

Create a share-link token granting access to the workspace.

Source: lightbulb/client.py:1615

code_workspace_deny_access_request

def code_workspace_deny_access_request(workspace_id: str, request_id: str) -> Dict[str, Any]

Deny a pending workspace access request.

Source: lightbulb/client.py:1660

code_workspace_evals

def code_workspace_evals(workspace_id: str) -> Dict[str, Any]

Get accumulated eval rollups for a workspace's runs.

Source: lightbulb/client.py:1958

code_workspace_invoke_tool

def code_workspace_invoke_tool(workspace_id: str, tool_key: str, arguments: Dict[str, Any] | None=None) -> Dict[str, Any]

Invoke a workspace-scoped tool (read/write files, run commands, git ops).

Invoke a workspace-scoped tool (read/write files, run commands, git ops).

Tool keys are registered in the workspace's runtime catalog. Common keys:
    - ``files.read`` — read a file by path
    - ``files.write`` — write a file
    - ``files.list`` — list directory contents
    - ``shell.run`` — execute a shell command
    - ``git.status`` — show git working-tree state
    - ``git.diff`` — produce a diff
    - ``git.commit`` — create a commit
Use :meth:`code_workspace_runtime_catalog` to discover what's available
for a specific workspace.

Source: lightbulb/client.py:1825

code_workspace_link_repository

def code_workspace_link_repository(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Link a GitHub repository to the workspace.

Source: lightbulb/client.py:1801

code_workspace_policy_replay

def code_workspace_policy_replay(workspace_id: str, **filters: Any) -> Dict[str, Any]

Replay a policy decision over historical runs (debug helper).

Source: lightbulb/client.py:1968

code_workspace_preview

def code_workspace_preview(workspace_id: str) -> Dict[str, Any]

Get the current preview state (URL, status, last build).

Source: lightbulb/client.py:1898

code_workspace_preview_proxy

def code_workspace_preview_proxy(workspace_id: str, path: str='', *, method: str='GET', body: Any=None, headers: Dict[str, str] | None=None) -> httpx.Response

Proxy an HTTP call through the workspace preview.

Proxy an HTTP call through the workspace preview.

Returns the raw httpx.Response so callers can inspect status/headers/body.
Use this for headless e2e tests against in-progress code.

Security: caller-supplied ``headers`` are merged BEFORE auth headers, so
a caller cannot overwrite ``Authorization`` / ``X-Tenant-Id`` /
``X-Internal-API-Key``. ``method`` and ``path`` are validated.

Source: lightbulb/client.py:1919

code_workspace_preview_start

def code_workspace_preview_start(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Start the workspace preview server (renders the in-progress code).

Source: lightbulb/client.py:1883

code_workspace_preview_stop

def code_workspace_preview_stop(workspace_id: str) -> Dict[str, Any]

Stop the workspace preview server.

Source: lightbulb/client.py:1908

code_workspace_promote_policy

def code_workspace_promote_policy(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Promote workspace-scoped policy to a higher scope (company/tenant).

Source: lightbulb/client.py:1990

code_workspace_redeem_share_link

def code_workspace_redeem_share_link(token: str) -> Dict[str, Any]

Redeem a workspace share-link token to gain access.

Source: lightbulb/client.py:1638

code_workspace_register_runtime_tools

def code_workspace_register_runtime_tools(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Register or update workspace runtime tools.

Source: lightbulb/client.py:1866

code_workspace_remove_collaborator

def code_workspace_remove_collaborator(workspace_id: str, collaborator_id: str) -> None

Revoke a collaborator's access.

Source: lightbulb/client.py:1606

code_workspace_revoke_share_link

def code_workspace_revoke_share_link(workspace_id: str, link_id: str) -> None

Revoke a share link.

Source: lightbulb/client.py:1629

code_workspace_run_review

def code_workspace_run_review(workspace_id: str, run_id: str, *, verdict: str, feedback: str='') -> Dict[str, Any]

Submit a human review verdict (accept | reject | request_changes) for a run.

Source: lightbulb/client.py:1717

code_workspace_run_review_apply

def code_workspace_run_review_apply(workspace_id: str, run_id: str) -> Dict[str, Any]

Apply review-suggested changes to the workspace.

Source: lightbulb/client.py:1735

code_workspace_run_telemetry

def code_workspace_run_telemetry(workspace_id: str, **filters: Any) -> Dict[str, Any]

Raw telemetry rows for a workspace's runs.

Source: lightbulb/client.py:1706

code_workspace_runs_insights

def code_workspace_runs_insights(workspace_id: str) -> Dict[str, Any]

Aggregate run-quality insights for a workspace (cost, latency, success rate).

Source: lightbulb/client.py:1696

code_workspace_runtime_catalog

def code_workspace_runtime_catalog(workspace_id: str) -> Dict[str, Any]

Read the workspace's runtime tool catalog (which tool keys are available).

Source: lightbulb/client.py:1856

code_workspace_update_collaborator

def code_workspace_update_collaborator(workspace_id: str, collaborator_id: str, *, role: str) -> Dict[str, Any]

Change a collaborator's role.

Source: lightbulb/client.py:1595

codex_thread_action

def codex_thread_action(workspace_id: str, thread_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Perform a thread-level action (rename | archive | unarchive | compact | rollback).

Source: lightbulb/client.py:2073

codex_turn_action

def codex_turn_action(workspace_id: str, thread_id: str, turn_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Steer or interrupt a specific Codex turn (action: steer | interrupt).

Source: lightbulb/client.py:2094

compute_aoc_tick

def compute_aoc_tick(body: Dict[str, Any] | None=None) -> Dict[str, Any]

Run a one-shot AutoCompany tick computation.

Source: lightbulb/client.py:2254

create_aoc_run

def create_aoc_run(body: Dict[str, Any]) -> Dict[str, Any]

Create a new AutoCompany run.

Source: lightbulb/client.py:2131

create_aoc_task

def create_aoc_task(body: Dict[str, Any]) -> Dict[str, Any]

Create an AutoCompany task.

Source: lightbulb/client.py:2174

create_approval_auto_accept

def create_approval_auto_accept(task_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Create an auto-accept rule keyed off the shape of an existing approval task.

Source: lightbulb/client.py:2508

create_code_workspace

def create_code_workspace(*, source: str | None=None, repo_connection_id: str | None=None, branch: str | None=None, depth: int | None=None, label: str | None=None, metadata: Dict[str, Any] | None=None, company_id: str | None=None) -> Dict[str, Any]

Create a code workspace.

Source: lightbulb/client.py:816

create_conversation

def create_conversation(domain: str) -> Dict[str, Any]

Create a new conversation for a domain.

Source: lightbulb/client.py:587

create_crm_task

def create_crm_task(body: Dict[str, Any], tenant_id: str | None=None) -> Dict[str, Any]

Create a CRM task.

Source: lightbulb/client.py:2461

create_document

def create_document(title: str, body: str, *, format: str='docx', target_suite: str='internal_library') -> DispatchResult

Create a new document.

Source: lightbulb/client.py:706

create_document_session

def create_document_session(*, document_type: str='general', document_title: str='Untitled Document') -> Dict[str, Any]

Create a new document builder session.

Source: lightbulb/client.py:606

create_page_builder_session

def create_page_builder_session(brand_name: str='', initial_prompt: str='') -> Dict[str, Any]

Create a new page builder session.

Source: lightbulb/client.py:759

create_project

def create_project(name: str, *, instructions: str='', workspace_id: str | None=None, repo_connection_id: str | None=None, product_machine_plan: Dict[str, Any] | None=None, idempotency_key: str | None=None) -> Dict[str, Any]

Create a Lightbulb project (``POST /api/projects`` → ``ProjectCreateRequest``).

Create a Lightbulb project (``POST /api/projects`` → ``ProjectCreateRequest``).

``name`` is required. Optionally bind a code workspace / repo connection
and seed the product-machine plan. Pass ``idempotency_key`` to make a
retried create return the existing project instead of duplicating it
(sent via the ``Idempotency-Key`` header the controller honours).

Source: lightbulb/client.py:899

create_slide_deck

def create_slide_deck(title: str, body: str='', *, target_suite: str='internal_library') -> DispatchResult

Create a new slide deck.

Source: lightbulb/client.py:742

create_spreadsheet

def create_spreadsheet(title: str, body: str='', *, target_suite: str='internal_library') -> DispatchResult

Create a new spreadsheet.

Source: lightbulb/client.py:727

delete_approval_preference

def delete_approval_preference(preference_id: str) -> Dict[str, Any]

Remove an auto-accept rule.

Source: lightbulb/client.py:2519

delete_conversation

def delete_conversation(domain: str, conversation_id: str) -> None

Delete a conversation.

Source: lightbulb/client.py:596

delete_crm_task

def delete_crm_task(task_id: str, tenant_id: str | None=None) -> None

Delete a CRM task.

Source: lightbulb/client.py:2485

dispatch

def dispatch(domain: str, *, action: str='chat', message: str='', objective: str='', inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> DispatchResult

Dispatch a one-shot action to a domain agent and wait for the result.

Source: lightbulb/client.py:361

document_builder_add_collaborator

def document_builder_add_collaborator(session_id: str, *, email: str | None=None, user_id: str | None=None, role: str='viewer') -> Dict[str, Any]

Add a collaborator to a document builder session.

Source: lightbulb/client.py:2737

document_builder_add_note

def document_builder_add_note(session_id: str, content: str) -> Dict[str, Any]

Add a note to a document builder session.

Source: lightbulb/client.py:2886

document_builder_collaboration

def document_builder_collaboration(session_id: str) -> Dict[str, Any]

Collaboration info for a document builder session.

Source: lightbulb/client.py:2727

document_builder_create_share_link

def document_builder_create_share_link(session_id: str, *, role: str='viewer', expires_in_seconds: int | None=None) -> Dict[str, Any]

Create a share-link token for a document builder session.

Source: lightbulb/client.py:2760

document_builder_get_messages

def document_builder_get_messages(session_id: str, **filters: Any) -> List[Dict[str, Any]]

Get the message history for a document builder session.

Source: lightbulb/client.py:2785

document_builder_redeem_share_link

def document_builder_redeem_share_link(session_id: str, token: str) -> Dict[str, Any]

Redeem a document builder share link.

Source: lightbulb/client.py:2774

document_builder_save

def document_builder_save(session_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Save a document builder session's current state.

Source: lightbulb/client.py:2797

get_aoc_decision

def get_aoc_decision(decision_id: str) -> Dict[str, Any]

Get a specific AutoCompany decision.

Source: lightbulb/client.py:2222

get_aoc_run

def get_aoc_run(run_id: str) -> Dict[str, Any]

Get an AutoCompany run detail.

Source: lightbulb/client.py:2138

get_aoc_task

def get_aoc_task(task_id: str) -> Dict[str, Any]

Get an AutoCompany task detail.

Source: lightbulb/client.py:2181

get_aoc_tick

def get_aoc_tick(tick_id: str) -> Dict[str, Any]

Get a single AutoCompany tick.

Source: lightbulb/client.py:2244

get_approval

def get_approval(task_id: str) -> Dict[str, Any]

Get full details of an approval task.

Source: lightbulb/client.py:1091

get_artifact

def get_artifact(artifact_id: str) -> Dict[str, Any]

Get a specific artifact by ID.

Source: lightbulb/client.py:1005

get_code_workspace_active_run

def get_code_workspace_active_run(workspace_id: str) -> Dict[str, Any] | None

Get the currently active run for a code workspace, if one exists.

Source: lightbulb/client.py:875

get_code_workspace_claude_session

def get_code_workspace_claude_session(workspace_id: str, session_id: str) -> Dict[str, Any]

Get a single Claude SDK session.

Source: lightbulb/client.py:2014

get_code_workspace_codex_thread

def get_code_workspace_codex_thread(workspace_id: str, thread_id: str) -> Dict[str, Any]

Get a Codex thread (turns, status, metadata).

Source: lightbulb/client.py:2063

get_code_workspace_run

def get_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

Get a specific code workspace run.

Source: lightbulb/client.py:887

get_conversation

def get_conversation(domain: str, conversation_id: str) -> Dict[str, Any]

Get conversation history.

Source: lightbulb/client.py:578

get_crm_task

def get_crm_task(task_id: str, tenant_id: str | None=None) -> Dict[str, Any]

Get a single CRM task.

Source: lightbulb/client.py:2450

get_document_schemas

def get_document_schemas(session_id: str) -> Dict[str, Any]

Get the document schemas for a session.

Source: lightbulb/client.py:636

get_document_session

def get_document_session(session_id: str) -> Dict[str, Any]

Get a document builder session.

Source: lightbulb/client.py:628

get_product_machine_plan

def get_product_machine_plan(project_id: str) -> Dict[str, Any]

Get a project's product-machine plan / deliverables (``GET /api/projects/{id}/product-machine/plan``).

Get a project's product-machine plan / deliverables
(``GET /api/projects/{id}/product-machine/plan``).

Source: lightbulb/client.py:953

get_project

def get_project(project_id: str) -> Dict[str, Any]

Get a single project (``GET /api/projects/{id}``).

Source: lightbulb/client.py:943

get_voice_execution

def get_voice_execution(execution_id: str) -> Dict[str, Any]

Get a voice execution detail (transcripts, status, agent decisions).

Source: lightbulb/client.py:1394

get_workflow

def get_workflow(workflow_id: str) -> Dict[str, Any]

Get a workflow by ID.

Source: lightbulb/client.py:1065

grep_documents

def grep_documents(pattern: str, *, regex: bool=True, case_sensitive: bool=False, folder_path: str | None=None, top_k: int=20) -> DispatchResult

Grep across document content using pattern matching.

Source: lightbulb/client.py:664

hr_live_advance_application

def hr_live_advance_application(application_id: str, *, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Advance a Greenhouse candidate to the next stage (HITL-gated).

Source: lightbulb/client.py:1531

hr_live_cases

def hr_live_cases(**filters: Any) -> Dict[str, Any]

HR case board items from Monday.com.

Source: lightbulb/client.py:1498

hr_live_health

def hr_live_health() -> Dict[str, Any]

Health check for HR connector tokens (BambooHR / Greenhouse / Monday).

Source: lightbulb/client.py:1553

hr_live_leave_balance

def hr_live_leave_balance(bamboo_employee_id: str) -> Dict[str, Any]

BambooHR leave balance for an employee.

Source: lightbulb/client.py:1478

hr_live_monday_onboarding_board

def hr_live_monday_onboarding_board(checklist_id: str) -> Dict[str, Any]

Monday.com board view for an HR onboarding checklist.

Source: lightbulb/client.py:1488

hr_live_recruiting_applications

def hr_live_recruiting_applications(**filters: Any) -> Dict[str, Any]

Greenhouse applications.

Source: lightbulb/client.py:1520

hr_live_recruiting_jobs

def hr_live_recruiting_jobs(**filters: Any) -> Dict[str, Any]

Greenhouse job listings.

Source: lightbulb/client.py:1509

hr_live_reject_application

def hr_live_reject_application(application_id: str, *, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Reject a Greenhouse application (HITL-gated).

Source: lightbulb/client.py:1542

hr_live_whos_out

def hr_live_whos_out(**filters: Any) -> Dict[str, Any]

BambooHR who's-out roster (current and upcoming time-off).

Source: lightbulb/client.py:1467

invoke_tool

def invoke_tool(tool_name: str, arguments: Dict[str, Any]) -> Dict[str, Any]

Invoke a platform tool by name (e.g. connector tools, utility tools).

Invoke a platform tool by name (e.g. connector tools, utility tools).

Posts to ``POST /api/tools/invoke`` with ``toolName`` + ``inputs`` (plus
tenant/company scope from auth so the platform's RBAC + HITL machinery
can resolve the binding without re-reading the JWT for every field).

Source: lightbulb/client.py:1150

it_ops_live_connector

def it_ops_live_connector(connector: str, **filters: Any) -> Dict[str, Any]

Pass-through to a live IT-Ops connector (jira | slack | github | notion).

Source: lightbulb/client.py:2612

it_ops_mcp_manifest

def it_ops_mcp_manifest() -> Dict[str, Any]

Get the IT-Ops workspace MCP manifest.

Source: lightbulb/client.py:2626

list_aoc_decisions

def list_aoc_decisions(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany decisions awaiting or post-resolution.

Source: lightbulb/client.py:2210

list_aoc_runs

def list_aoc_runs(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany cognitive-loop runs.

Source: lightbulb/client.py:2119

list_aoc_task_events

def list_aoc_task_events(task_id: str) -> List[Dict[str, Any]]

List events recorded against an AutoCompany task.

Source: lightbulb/client.py:2188

list_aoc_tasks

def list_aoc_tasks(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany tasks.

Source: lightbulb/client.py:2162

list_aoc_ticks

def list_aoc_ticks(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany cognitive-loop ticks.

Source: lightbulb/client.py:2232

list_approval_preferences

def list_approval_preferences() -> List[Dict[str, Any]]

List the user's HITL auto-accept rules.

Source: lightbulb/client.py:2497

list_artifacts

def list_artifacts(**filters) -> List[Dict[str, Any]]

List artifacts (charts, reports, analyses, etc.).

Source: lightbulb/client.py:993

list_code_workspace_claude_sessions

def list_code_workspace_claude_sessions(workspace_id: str) -> List[Dict[str, Any]]

List Claude SDK sessions associated with a workspace.

Source: lightbulb/client.py:2003

list_code_workspace_codex_threads

def list_code_workspace_codex_threads(workspace_id: str, **filters: Any) -> List[Dict[str, Any]]

List Codex runtime threads attached to a workspace.

Source: lightbulb/client.py:2051

list_code_workspace_proposals

def list_code_workspace_proposals(workspace_id: str) -> List[Dict[str, Any]]

List code-change proposals submitted to the workspace.

Source: lightbulb/client.py:1746

list_code_workspace_runs

def list_code_workspace_runs(workspace_id: str, **filters: Any) -> List[Dict[str, Any]]

List historical coding runs for a workspace.

Source: lightbulb/client.py:1684

list_code_workspaces

def list_code_workspaces() -> List[Dict[str, Any]]

List code workspaces.

Source: lightbulb/client.py:853

list_companies

def list_companies() -> List[Dict[str, Any]]

List companies the user has access to within their tenant.

Source: lightbulb/client.py:253

list_connected_integrations

def list_connected_integrations(company_id: str | None=None) -> List[Dict[str, Any]]

List connected integrations (OAuth connections) for the current company scope.

Source: lightbulb/client.py:237

list_connectors

def list_connectors() -> List[Dict[str, Any]]

List available connectors and their status.

Source: lightbulb/client.py:1142

list_contacts

def list_contacts(**filters) -> List[Dict[str, Any]]

List CRM contacts.

Source: lightbulb/client.py:1175

list_conversations

def list_conversations(domain: str) -> List[Dict[str, Any]]

List all conversations for a domain.

Source: lightbulb/client.py:569

list_crm_tasks

def list_crm_tasks(tenant_id: str | None=None, **filters: Any) -> List[Dict[str, Any]]

List CRM tasks scoped to a tenant (defaults to authed tenant).

Source: lightbulb/client.py:2437

list_deals

def list_deals(**filters) -> List[Dict[str, Any]]

List CRM deals/opportunities.

Source: lightbulb/client.py:1187

list_document_sessions

def list_document_sessions() -> List[Dict[str, Any]]

List document builder sessions.

Source: lightbulb/client.py:620

list_domain_actions

def list_domain_actions(domain: str) -> List[Dict[str, Any]]

List available actions for a specific domain agent.

Source: lightbulb/client.py:1291

list_domains

def list_domains() -> List[Dict[str, Any]]

List all available domain agents and their capabilities.

Source: lightbulb/client.py:1284

list_folder

def list_folder(folder_path: str='', *, source_system: str | None=None, max_items: int=100) -> DispatchResult

List documents in a folder.

Source: lightbulb/client.py:689

list_notifications

def list_notifications(**filters) -> List[Dict[str, Any]]

List notifications (HITL decisions, workflow alerts, system messages).

Source: lightbulb/client.py:1201

list_page_builder_sessions

def list_page_builder_sessions() -> List[Dict[str, Any]]

List page builder sessions.

Source: lightbulb/client.py:771

list_pending_approvals

def list_pending_approvals() -> List[Dict[str, Any]]

List pending HITL approval tasks waiting for your decision.

Source: lightbulb/client.py:1084

list_projects

def list_projects() -> List[Dict[str, Any]]

List the caller's projects (``GET /api/projects``).

Source: lightbulb/client.py:935

list_runtime_actions

def list_runtime_actions(status: str='active') -> Dict[str, Any]

List runtime domain actions by status (``GET /api/domain-agents/runtime-actions?status=``).

List runtime domain actions by status
(``GET /api/domain-agents/runtime-actions?status=``).

Returns the controller's ``{status, count, actions:[...]}`` envelope.

Source: lightbulb/client.py:1365

list_voice_executions

def list_voice_executions(**filters: Any) -> List[Dict[str, Any]]

List voice agent executions (live and historical phone calls).

Source: lightbulb/client.py:1382

list_voice_pending_approvals

def list_voice_pending_approvals() -> List[Dict[str, Any]]

List in-call HITL approvals waiting for caller-side decision.

Source: lightbulb/client.py:1404

list_workflows

def list_workflows() -> List[Dict[str, Any]]

List workflow definitions.

Source: lightbulb/client.py:1057

mark_all_notifications_read

def mark_all_notifications_read() -> Dict[str, Any]

Mark all notifications as read.

Source: lightbulb/client.py:2554

mark_notification_read

def mark_notification_read(notification_id: str) -> Dict[str, Any]

Mark a single notification as read.

Source: lightbulb/client.py:2543

marketing_add_website_analytics_site

def marketing_add_website_analytics_site(body: Dict[str, Any]) -> Dict[str, Any]

Register a website with the analytics setup.

Source: lightbulb/client.py:2832

marketing_content_configure_provider

def marketing_content_configure_provider(provider: str, body: Dict[str, Any]) -> Dict[str, Any]

Configure a marketing-content provider (e.g. ga4, segment, plausible).

Source: lightbulb/client.py:2820

marketing_content_setup

def marketing_content_setup() -> Dict[str, Any]

Get the marketing content connector setup state.

Source: lightbulb/client.py:2810

marketing_install_website_analytics

def marketing_install_website_analytics(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Install website analytics into a code workspace.

Source: lightbulb/client.py:2875

marketing_remove_website_analytics_site

def marketing_remove_website_analytics_site(site_id: str) -> Dict[str, Any]

Remove a registered analytics site.

Source: lightbulb/client.py:2854

marketing_select_website_analytics_site

def marketing_select_website_analytics_site(site_id: str) -> Dict[str, Any]

Activate a registered analytics site.

Source: lightbulb/client.py:2843

marketing_verify_website_analytics

def marketing_verify_website_analytics(body: Dict[str, Any] | None=None) -> Dict[str, Any]

Verify the website analytics setup is wired correctly.

Source: lightbulb/client.py:2864

memory_add_skill

def memory_add_skill(body: Dict[str, Any]) -> Dict[str, Any]

Record a new skill / capability.

Source: lightbulb/client.py:2428

memory_create_entry

def memory_create_entry(body: Dict[str, Any]) -> Dict[str, Any]

Create a structured memory entry.

Source: lightbulb/client.py:2300

memory_create_identity

def memory_create_identity(body: Dict[str, Any]) -> Dict[str, Any]

Create an identity record.

Source: lightbulb/client.py:2365

memory_create_link

def memory_create_link(body: Dict[str, Any]) -> Dict[str, Any]

Create a memory link between two entities.

Source: lightbulb/client.py:2413

memory_get_entry

def memory_get_entry(entry_id: str) -> Dict[str, Any]

Get a specific memory entry.

Source: lightbulb/client.py:2290

memory_get_identity

def memory_get_identity(doc_id: str) -> Dict[str, Any]

Get an identity record by doc id.

Source: lightbulb/client.py:2372

memory_graph

def memory_graph(**filters: Any) -> Dict[str, Any]

Full memory graph (or filtered subgraph).

Source: lightbulb/client.py:2335

memory_graph_node

def memory_graph_node(node_id: str) -> Dict[str, Any]

Get a single node from the memory graph.

Source: lightbulb/client.py:2346

memory_list_entries

def memory_list_entries(**filters: Any) -> List[Dict[str, Any]]

List memory entries (structured records).

Source: lightbulb/client.py:2278

memory_list_events

def memory_list_events(**filters: Any) -> List[Dict[str, Any]]

List memory events (timeline of state changes).

Source: lightbulb/client.py:2382

memory_list_identity

def memory_list_identity() -> List[Dict[str, Any]]

List identity records in the memory graph.

Source: lightbulb/client.py:2357

memory_list_links

def memory_list_links(**filters: Any) -> List[Dict[str, Any]]

List entity links in the memory graph.

Source: lightbulb/client.py:2401

memory_list_skills

def memory_list_skills() -> List[Dict[str, Any]]

List skills/capabilities recorded in memory.

Source: lightbulb/client.py:2420

memory_projection_memory

def memory_projection_memory() -> Dict[str, Any]

Memory-structure projection of the agent.

Source: lightbulb/client.py:2321

memory_projection_soul

def memory_projection_soul() -> Dict[str, Any]

Identity / personality projection of the agent.

Source: lightbulb/client.py:2314

memory_query

def memory_query(body: Dict[str, Any]) -> Dict[str, Any]

Run a structured memory query (filters, time-windows, semantic).

Source: lightbulb/client.py:2307

memory_recall

def memory_recall(key: str, *, namespace: str='default') -> Dict[str, Any]

Recall a value from agent memory.

Source: lightbulb/client.py:1247

memory_record_event

def memory_record_event(body: Dict[str, Any]) -> Dict[str, Any]

Record a memory event.

Source: lightbulb/client.py:2394

memory_search

def memory_search(query: str, *, namespace: str='default', top_k: int=5) -> List[Dict[str, Any]]

Search agent memory semantically (``POST /api/memory/query``).

Search agent memory semantically (``POST /api/memory/query``).

Maps ``{query, namespace, top_k}`` onto the gateway's
``MemoryQueryRequest`` (``query_text``, ``categories=[namespace]``,
``top_k``) and returns the ranked ``entries`` list from the
``MemoryQueryResponse``. (The ``POST /api/memory/search`` route this used
to target has no handler — the semantic route is ``/query``.)

Source: lightbulb/client.py:1257

memory_status

def memory_status() -> Dict[str, Any]

Health / capacity status of the memory subsystem.

Source: lightbulb/client.py:2328

memory_store

def memory_store(key: str, value: str, *, namespace: str='default') -> Dict[str, Any]

Store a value in agent memory.

Store a value in agent memory.

Writes to the memory gateway's durable entry store
(``POST /api/memory/entries`` → ``MemoryEntryCreate``). The simple
``{key, value, namespace}`` triple is mapped onto the entry DTO so it
round-trips with :meth:`memory_search`:

- ``namespace`` → ``category`` (the grouping the search scopes by),
- ``value`` → ``summary`` (the retrievable content),
- ``key`` → preserved in ``tags`` and ``details_json`` for later lookup.

Stored as a durable ``semantic`` entry. (The bare ``POST /api/memory``
route this used to target has no handler — it 404'd.)

Source: lightbulb/client.py:1215

modify_voice_action

def modify_voice_action(execution_id: str, approval_task_id: str, modifications: Dict[str, Any]) -> Dict[str, Any]

Approve a voice action with modifications to the proposed payload.

Source: lightbulb/client.py:1449

page_builder_capabilities

def page_builder_capabilities(session_id: str) -> Dict[str, Any]

List page capabilities (forms, search, auth, etc.).

Source: lightbulb/client.py:2682

page_builder_deploy

def page_builder_deploy(session_id: str, page_key: str='') -> Dict[str, Any]

Deploy a page builder session.

Source: lightbulb/client.py:797

page_builder_get_preview

def page_builder_get_preview(session_id: str) -> Dict[str, Any]

Get the preview URL for a page builder session.

Source: lightbulb/client.py:807

page_builder_get_schemas

def page_builder_get_schemas(session_id: str) -> Dict[str, Any]

Get the current page schemas for a session.

Source: lightbulb/client.py:790

page_builder_install_artifact

def page_builder_install_artifact(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Install a component artifact into the page session.

Source: lightbulb/client.py:2671

page_builder_promote_install_bundle

def page_builder_promote_install_bundle(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Promote an install bundle to the workspace.

Source: lightbulb/client.py:2660

page_builder_promote_section

def page_builder_promote_section(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Promote a section artifact to the install bundle.

Source: lightbulb/client.py:2649

page_builder_save_backend_contract

def page_builder_save_backend_contract(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Define a backend contract for a page (data shape + agent binding).

Source: lightbulb/client.py:2703

page_builder_save_capability

def page_builder_save_capability(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Save a capability to the page session.

Source: lightbulb/client.py:2692

page_builder_send_message

def page_builder_send_message(session_id: str, content: str) -> Dict[str, Any]

Send a message to a page builder session (non-streaming).

Source: lightbulb/client.py:779

page_builder_unpublish

def page_builder_unpublish(session_id: str) -> Dict[str, Any]

Unpublish a deployed page builder session.

Source: lightbulb/client.py:2714

page_builder_workspace_automation

def page_builder_workspace_automation(session_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Run the page-builder workspace automation (auto-wire pages → agents → backend).

Source: lightbulb/client.py:2638

post_aoc_task_event

def post_aoc_task_event(task_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Post a new event onto an AutoCompany task.

Source: lightbulb/client.py:2199

rag_query

def rag_query(question: str, *, top_k: int=5, document_ids: List[str] | None=None) -> Dict[str, Any]

Query the RAG knowledge base directly.

Source: lightbulb/client.py:1122

rag_upload_document

def rag_upload_document(filename: str, content: str, **metadata) -> Dict[str, Any]

Upload a document to the RAG library.

Source: lightbulb/client.py:1132

refresh_auth

def refresh_auth() -> bool

Run the configured ``auth_refresh`` callback and swap in fresh auth.

Run the configured ``auth_refresh`` callback and swap in fresh auth.

Returns ``True`` if a new ``AuthStrategy`` was installed. Callers
typically invoke this after catching :class:`AuthenticationError`,
then retry the failed request:

    try:
        client.dispatch("finance", action="chat", message="...")
    except AuthenticationError:
        if client.refresh_auth():
            client.dispatch("finance", action="chat", message="...")

Source: lightbulb/client.py:286

register_external_artifact

def register_external_artifact(*, type: str, title: str='', summary: str='', uri: str='', content: str='', project_id: Optional[str]=None, source_agent: str='external_agent', metadata: Optional[Dict[str, Any]]=None, attach_workspace: bool=False) -> Dict[str, Any]

Register an external artifact (codebase/document/slide deck/spreadsheet/url) created by a general agent so Lightbulb domain agents can discover and work on it.

Register an external artifact (codebase/document/slide deck/spreadsheet/url) created
by a general agent so Lightbulb domain agents can discover and work on it.

Either ``uri`` or ``content`` must be provided. For a ``codebase`` artifact with a repo
``uri``, set ``attach_workspace=True`` to also clone it into a Code Workspace so Lightbulb
agents can work on it.

Source: lightbulb/client.py:1012

register_runtime_action

def register_runtime_action(domain: str, action: str, *, description: str='', agent_spec: Dict[str, Any] | None=None, component_ids: List[str] | None=None, workflow_type: str='') -> Dict[str, Any]

Author a runtime domain action (``POST /api/domain-agents/runtime-actions``).

Author a runtime domain action (``POST /api/domain-agents/runtime-actions``).

Lands as ``pending_approval`` — not dispatchable until approved. Provide
an ``agent_spec`` to author a brand-new agent (``domain`` may be
``"custom"``); without one, ``domain`` must be an existing contract domain
and this adds an action to it. The request body uses the backend's
camelCase keys (``agentSpec``, ``componentIds``, ``workflowType``).

Source: lightbulb/client.py:1305

reject_code_workspace_proposal

def reject_code_workspace_proposal(workspace_id: str, proposal_id: str, *, reason: str='') -> Dict[str, Any]

Reject a proposal.

Source: lightbulb/client.py:1779

reject_runtime_action

def reject_runtime_action(action_id: str) -> Dict[str, Any]

Reject a pending runtime action — ADMIN/TENANT only (``POST /api/domain-agents/runtime-actions/{id}/reject``).

Reject a pending runtime action — ADMIN/TENANT only
(``POST /api/domain-agents/runtime-actions/{id}/reject``).

Source: lightbulb/client.py:1353

reject_task

def reject_task(task_id: str, *, comments: str='') -> Dict[str, Any]

Reject a pending HITL task.

Source: lightbulb/client.py:1109

reject_voice_action

def reject_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

Reject a pending in-call action.

Source: lightbulb/client.py:1432

search_documents

def search_documents(query: str, *, folder_path: str | None=None, top_k: int=10) -> DispatchResult

Search across all documents using semantic search.

Source: lightbulb/client.py:646

set_approval_preference_state

def set_approval_preference_state(preference_id: str, *, enabled: bool) -> Dict[str, Any]

Enable or disable an auto-accept rule.

Source: lightbulb/client.py:2530

stop_aoc_run

def stop_aoc_run(run_id: str) -> Dict[str, Any]

Stop an in-flight AutoCompany cognitive-loop run.

Source: lightbulb/client.py:2145

stream_chat

def stream_chat(domain: str, *, message: str, action: str | None=None, inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> Generator[SSEEvent, None, None]

Stream a domain agent chat via Server-Sent Events.

Stream a domain agent chat via Server-Sent Events.

Yields SSEEvent objects for each event (status, chat, artifact, complete, error).

Source: lightbulb/client.py:412

stream_code_workspace_chat

def stream_code_workspace_chat(workspace_id: str, message: str, **kwargs: Any) -> Generator[SSEEvent, None, None]

Stream a coding agent chat as Server-Sent Events.

Stream a coding agent chat as Server-Sent Events.

Yields SSEEvent objects (status, token, tool_call, diff, complete, error).
The non-streaming counterpart is :meth:`code_workspace_chat`.

Source: lightbulb/client.py:500

stream_document_builder_message

def stream_document_builder_message(session_id: str, content: str) -> Generator[SSEEvent, None, None]

Stream a document builder message via SSE.

Source: lightbulb/client.py:552

stream_page_builder_message

def stream_page_builder_message(session_id: str, content: str) -> Generator[SSEEvent, None, None]

Stream a page builder message via SSE (token-by-token output).

Source: lightbulb/client.py:523

stream_page_builder_workspace_automation

def stream_page_builder_workspace_automation(session_id: str, body: Dict[str, Any] | None=None) -> Generator[SSEEvent, None, None]

Stream the page-builder workspace automation pipeline.

Source: lightbulb/client.py:538

submit_code_workspace_proposal

def submit_code_workspace_proposal(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Submit a code-change proposal (diff + summary).

Source: lightbulb/client.py:1757

trigger_workflow

def trigger_workflow(workflow_type: str, objective: str, *, inputs: Dict[str, Any] | None=None) -> Dict[str, Any]

Trigger a workflow execution.

Source: lightbulb/client.py:1072

update_crm_task

def update_crm_task(task_id: str, body: Dict[str, Any], tenant_id: str | None=None) -> Dict[str, Any]

Update a CRM task.

Source: lightbulb/client.py:2473

update_product_machine_plan

def update_product_machine_plan(project_id: str, plan: Dict[str, Any]) -> Dict[str, Any]

Replace a project's product-machine plan (``PUT /api/projects/{id}/product-machine/plan``).

Replace a project's product-machine plan
(``PUT /api/projects/{id}/product-machine/plan``).

Source: lightbulb/client.py:964

validate_aoc_run_config

def validate_aoc_run_config(run_id: str) -> Dict[str, Any]

Validate an AutoCompany run's configuration.

Source: lightbulb/client.py:2152

whoami

def whoami() -> Dict[str, Any]

Get the current user's identity, role, tenant, company, and permissions.

Source: lightbulb/client.py:230

workspace_bundle

def workspace_bundle(domain: str) -> Dict[str, Any]

Get a domain workspace data bundle (state, surfaces, recent runs).

Source: lightbulb/client.py:2567

workspace_conversation

def workspace_conversation(domain: str, conversation_id: str) -> Dict[str, Any]

Get a domain workspace conversation.

Source: lightbulb/client.py:2589

workspace_surface

def workspace_surface(domain: str, surface: str, **filters: Any) -> Dict[str, Any]

Read a domain workspace surface (e.g. internal_suite, live connector).

Source: lightbulb/client.py:2600

workspace_trace

def workspace_trace(domain: str, trace_id: str) -> Dict[str, Any]

Get a workspace trace (full agent execution log).

Source: lightbulb/client.py:2578

__aenter__

async def __aenter__() -> 'AsyncLightbulbClient'

Source: lightbulb/async_client.py:95

__aexit__

async def __aexit__(exc_type, exc, tb) -> None

Source: lightbulb/async_client.py:99

active_company_id

@property
def active_company_id() -> str | None

Source: lightbulb/async_client.py:141

active_company_id

@active_company_id.setter
def active_company_id(value: str | None) -> None

Source: lightbulb/async_client.py:145

approve_task

async def approve_task(task_id: str, *, comments: str='') -> Dict[str, Any]

Source: lightbulb/async_client.py:483

approve_voice_action

async def approve_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

Source: lightbulb/async_client.py:526

close

async def close() -> None

Source: lightbulb/async_client.py:114

code_workspace_chat

async def code_workspace_chat(workspace_id: str, message: str, **kwargs: Any) -> Dict[str, Any]

Source: lightbulb/async_client.py:405

dispatch

async def dispatch(domain: str, *, action: str='chat', message: str='', objective: str='', inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> DispatchResult

Source: lightbulb/async_client.py:223

document_builder_get_messages

async def document_builder_get_messages(session_id: str, **filters: Any) -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:461

get_code_workspace_active_run

async def get_code_workspace_active_run(workspace_id: str) -> Dict[str, Any] | None

Source: lightbulb/async_client.py:429

get_code_workspace_run

async def get_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

Source: lightbulb/async_client.py:420

invoke_tool

async def invoke_tool(tool_name: str, arguments: Dict[str, Any]) -> Dict[str, Any]

Invoke a platform tool by name. Mirrors the sync client's wire shape: ``toolName`` + ``inputs`` (plus tenant/company scope from auth).

Invoke a platform tool by name. Mirrors the sync client's wire shape:
``toolName`` + ``inputs`` (plus tenant/company scope from auth).

Source: lightbulb/async_client.py:561

list_aoc_runs

async def list_aoc_runs(**filters: Any) -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:538

list_code_workspaces

async def list_code_workspaces() -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:399

list_companies

async def list_companies() -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:186

list_connected_integrations

async def list_connected_integrations(company_id: str | None=None) -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:206

list_domains

async def list_domains() -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:197

list_pending_approvals

async def list_pending_approvals() -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:474

list_voice_executions

async def list_voice_executions(**filters: Any) -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:505

list_voice_pending_approvals

async def list_voice_pending_approvals() -> List[Dict[str, Any]]

Source: lightbulb/async_client.py:516

page_builder_send_message

async def page_builder_send_message(session_id: str, content: str) -> Dict[str, Any]

Source: lightbulb/async_client.py:451

refresh_auth

async def refresh_auth() -> bool

Async equivalent of :meth:`LightbulbClient.refresh_auth`.

Source: lightbulb/async_client.py:119

reject_task

async def reject_task(task_id: str, *, comments: str='') -> Dict[str, Any]

Source: lightbulb/async_client.py:493

search_documents

async def search_documents(query: str, *, top_k: int=10) -> Dict[str, Any]

Source: lightbulb/async_client.py:442

stop_aoc_run

async def stop_aoc_run(run_id: str) -> Dict[str, Any]

Source: lightbulb/async_client.py:549

stream_chat

async def stream_chat(domain: str, *, message: str, action: str | None=None, inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> AsyncGenerator[SSEEvent, None]

Source: lightbulb/async_client.py:271

stream_code_workspace_chat

async def stream_code_workspace_chat(workspace_id: str, message: str, **kwargs: Any) -> AsyncGenerator[SSEEvent, None]

Source: lightbulb/async_client.py:303

stream_document_builder_message

async def stream_document_builder_message(session_id: str, content: str) -> AsyncGenerator[SSEEvent, None]

Source: lightbulb/async_client.py:332

stream_page_builder_message

async def stream_page_builder_message(session_id: str, content: str) -> AsyncGenerator[SSEEvent, None]

Source: lightbulb/async_client.py:321

whoami

async def whoami() -> Dict[str, Any]

Source: lightbulb/async_client.py:180

lightbulb.async_client.AsyncLightbulbClient

class · lightbulb/async_client.py:50

Async client for the Lightbulb platform API.

Methods

async def __aenter__() -> 'AsyncLightbulbClient'

async def __aexit__(exc_type, exc, tb) -> None

@property
def active_company_id() -> str | None

@active_company_id.setter
def active_company_id(value: str | None) -> None

async def approve_task(task_id: str, *, comments: str='') -> Dict[str, Any]

async def approve_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

async def close() -> None

async def code_workspace_chat(workspace_id: str, message: str, **kwargs: Any) -> Dict[str, Any]

async def dispatch(domain: str, *, action: str='chat', message: str='', objective: str='', inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> DispatchResult

async def document_builder_get_messages(session_id: str, **filters: Any) -> List[Dict[str, Any]]

async def get_code_workspace_active_run(workspace_id: str) -> Dict[str, Any] | None

async def get_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

async def invoke_tool(tool_name: str, arguments: Dict[str, Any]) -> Dict[str, Any]

Invoke a platform tool by name. Mirrors the sync client's wire shape:
``toolName`` + ``inputs`` (plus tenant/company scope from auth).

async def list_aoc_runs(**filters: Any) -> List[Dict[str, Any]]

async def list_code_workspaces() -> List[Dict[str, Any]]

async def list_companies() -> List[Dict[str, Any]]

async def list_connected_integrations(company_id: str | None=None) -> List[Dict[str, Any]]

async def list_domains() -> List[Dict[str, Any]]

async def list_pending_approvals() -> List[Dict[str, Any]]

async def list_voice_executions(**filters: Any) -> List[Dict[str, Any]]

async def list_voice_pending_approvals() -> List[Dict[str, Any]]

async def page_builder_send_message(session_id: str, content: str) -> Dict[str, Any]

async def refresh_auth() -> bool

async def reject_task(task_id: str, *, comments: str='') -> Dict[str, Any]

async def search_documents(query: str, *, top_k: int=10) -> Dict[str, Any]

async def stop_aoc_run(run_id: str) -> Dict[str, Any]

async def stream_chat(domain: str, *, message: str, action: str | None=None, inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> AsyncGenerator[SSEEvent, None]

async def stream_code_workspace_chat(workspace_id: str, message: str, **kwargs: Any) -> AsyncGenerator[SSEEvent, None]

async def stream_document_builder_message(session_id: str, content: str) -> AsyncGenerator[SSEEvent, None]

async def stream_page_builder_message(session_id: str, content: str) -> AsyncGenerator[SSEEvent, None]

async def whoami() -> Dict[str, Any]

lightbulb.auth.ApiKeyAuth

class · lightbulb/auth.py:83

Authenticate with a service API key + tenant context.

Authenticate with a service API key + tenant context.

This is the service-to-service auth path. The key is sent with a tenant
(and optional company) scope header and is only intended for trusted,
loopback/local integration use.

Methods

def apply(headers: Dict[str, str]) -> Dict[str, str]

@property
def company_id() -> str | None

@property
def tenant_id() -> str

lightbulb.auth.JwtAuth

class · lightbulb/auth.py:126

Authenticate with a JWT Bearer token.

Authenticate with a JWT Bearer token.

This is the user-facing auth path.  The JWT must contain tenantId and
userId claims.

Methods

def apply(headers: Dict[str, str]) -> Dict[str, str]

@property
def company_id() -> str | None

@property
def tenant_id() -> str

lightbulb.auth.TwoFactorRequired

class · lightbulb/auth.py:165

Raised by login() when the user has 2FA enabled and no code was provided.

Raised by login() when the user has 2FA enabled and no code was provided.

The caller should prompt for a 6-digit TOTP (or 8-digit backup) code and call
``complete_2fa_login(base_url, email, code)``.

Attributes:
    base_url: The platform URL (so the caller can pass it back).
    email: The email address to use when completing the challenge.
    message: Server-supplied prompt (e.g. "Enter your authenticator code").

lightbulb.auth.login

function · lightbulb/auth.py:184

login(base_url: str, email: str, password: str, *, code: str | None=None, timeout: float=15.0, interactive: bool=False) -> JwtAuth

Authenticate with email/password and return a JwtAuth with the user's real permissions.

Authenticate with email/password and return a JwtAuth with the user's real permissions.

The returned JwtAuth goes through the normal JWT auth path in Spring Boot,
meaning all requests are scoped to the user's actual tenant, company, roles,
and RBAC permissions — no privilege escalation.

2FA handling:
    - If the account has 2FA enabled and ``code`` is provided, the SDK
      performs the two-step flow automatically.
    - If 2FA is enabled and no code is provided, the SDK raises
      :class:`TwoFactorRequired`. Catch it, prompt for the code, then call
      :func:`complete_2fa_login` (or call :func:`login` again with ``code``).
    - Pass ``interactive=True`` to read the code from stdin if the platform
      asks for it (suitable for CLIs).

Args:
    base_url: Platform URL (e.g. "https://agents.lightbulbpartners.com")
    email: User's login email
    password: User's password
    code: Optional 6-digit TOTP or 8-digit backup code. Pass this if you
        already know the user has 2FA enabled.
    interactive: If True and stdin is a TTY, prompt for the 2FA code when
        the server reports requires2FA.

Returns:
    JwtAuth configured with the user's JWT, tenant ID, and company ID.

Raises:
    TwoFactorRequired: If the account has 2FA enabled and no code was
        provided (and interactive=False).
    RuntimeError: If login fails (invalid credentials, server error, etc.)
    ValueError: If the response is missing required fields.

lightbulb.auth.complete_2fa_login

function · lightbulb/auth.py:314

complete_2fa_login(base_url: str, email: str, code: str, *, timeout: float=15.0) -> JwtAuth

Complete a two-factor login challenge.

Complete a two-factor login challenge.

Call this after :func:`login` raises :class:`TwoFactorRequired`, passing the
6-digit TOTP code from the user's authenticator app or an 8-digit backup code.

Args:
    base_url: Platform URL.
    email: The same email used in the initial login call.
    code: 6-digit TOTP code or 8-digit backup code.
    timeout: HTTP timeout.

Returns:
    JwtAuth scoped to the user's permissions.

Raises:
    RuntimeError: If verification fails (bad code, expired, rate-limited).

lightbulb.auth.sso_redirect_url

function · lightbulb/auth.py:550

sso_redirect_url(base_url: str, provider: str='google', *, timeout: float=5.0) -> str

Resolve the OAuth2 SSO start URL for the given provider.

Resolve the OAuth2 SSO start URL for the given provider.

The platform exposes ``GET /api/auth/oauth2/{provider}`` which returns a
JSON envelope ``{"url": "/oauth2/authorization/{provider}"}``. This helper
fetches that envelope, validates it (must be on the same host as
``base_url``, must be http(s), no protocol-relative bypasses), and returns
the absolute URL the caller should redirect to.

Args:
    base_url: Platform base URL.
    provider: Either ``"google"`` or ``"microsoft"``.
    timeout: HTTP timeout.

Returns:
    Fully-qualified SSO start URL on the platform's host.

lightbulb.auth.device_login

function · lightbulb/auth.py:588

device_login(base_url: str, client_id: str='claude-code', *, poll_interval: float=5.0, open_browser: bool=True, timeout: float=15.0) -> tuple[JwtAuth, int]

Authenticate via OAuth2 Device Authorization Grant (RFC 8628).

Authenticate via OAuth2 Device Authorization Grant (RFC 8628).

1. POST /api/auth/device/authorize → device_code + user_code + verification_uri
2. Print instructions, optionally open browser
3. Poll POST /api/auth/device/token until approved/denied/expired
4. Return (JwtAuth, expires_in)

Args:
    base_url: Platform URL
    client_id: Client identifier (default "claude-code")
    poll_interval: Seconds between polls (default 5)
    open_browser: Whether to auto-open the verification URL
    timeout: HTTP request timeout

Returns:
    Tuple of (JwtAuth scoped to user's permissions, expires_in seconds)

Raises:
    RuntimeError: If auth is denied, expired, or fails.

lightbulb.client.LightbulbClient

class · lightbulb/client.py:184

Synchronous client for the Lightbulb platform API.

Methods

@property
def active_company_id() -> str | None

@active_company_id.setter
def active_company_id(value: str | None) -> None

def apply_aoc_tick(tick_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def apply_code_workspace_proposal(workspace_id: str, proposal_id: str) -> Dict[str, Any]

def approve_runtime_action(action_id: str) -> Dict[str, Any]

Approve (activate) a pending runtime action — ADMIN/TENANT only
(``POST /api/domain-agents/runtime-actions/{id}/approve``).

def approve_task(task_id: str, *, comments: str='') -> Dict[str, Any]

def approve_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

def backbone_execute(objective: str, *, inputs: Dict[str, Any] | None=None) -> Dict[str, Any]

def cancel_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

def claude_session_action(workspace_id: str, session_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Perform an action on a Claude SDK session.

action: one of rename, tag, fork, delete, interrupt, mcp/reconnect,
        mcp/toggle, rewind, tasks/stop, compact

def code_workspace_add_collaborator(workspace_id: str, *, email: str | None=None, user_id: str | None=None, role: str='viewer') -> Dict[str, Any]

def code_workspace_add_note(workspace_id: str, content: str) -> Dict[str, Any]

def code_workspace_approve_access_request(workspace_id: str, request_id: str) -> Dict[str, Any]

def code_workspace_chat(workspace_id: str, message: str, **kwargs) -> Dict[str, Any]

def code_workspace_clear_policy(workspace_id: str, request_family: str) -> Dict[str, Any]

def code_workspace_collaboration(workspace_id: str) -> Dict[str, Any]

def code_workspace_create_pull_request(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def code_workspace_create_share_link(workspace_id: str, *, role: str='viewer', expires_in_seconds: int | None=None) -> Dict[str, Any]

def code_workspace_deny_access_request(workspace_id: str, request_id: str) -> Dict[str, Any]

def code_workspace_evals(workspace_id: str) -> Dict[str, Any]

def code_workspace_invoke_tool(workspace_id: str, tool_key: str, arguments: Dict[str, Any] | None=None) -> Dict[str, Any]

Invoke a workspace-scoped tool (read/write files, run commands, git ops).

Tool keys are registered in the workspace's runtime catalog. Common keys:
    - ``files.read`` — read a file by path
    - ``files.write`` — write a file
    - ``files.list`` — list directory contents
    - ``shell.run`` — execute a shell command
    - ``git.status`` — show git working-tree state
    - ``git.diff`` — produce a diff
    - ``git.commit`` — create a commit
Use :meth:`code_workspace_runtime_catalog` to discover what's available
for a specific workspace.

def code_workspace_link_repository(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def code_workspace_policy_replay(workspace_id: str, **filters: Any) -> Dict[str, Any]

def code_workspace_preview(workspace_id: str) -> Dict[str, Any]

def code_workspace_preview_proxy(workspace_id: str, path: str='', *, method: str='GET', body: Any=None, headers: Dict[str, str] | None=None) -> httpx.Response

Proxy an HTTP call through the workspace preview.

Returns the raw httpx.Response so callers can inspect status/headers/body.
Use this for headless e2e tests against in-progress code.

Security: caller-supplied ``headers`` are merged BEFORE auth headers, so
a caller cannot overwrite ``Authorization`` / ``X-Tenant-Id`` /
``X-Internal-API-Key``. ``method`` and ``path`` are validated.

def code_workspace_preview_start(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def code_workspace_preview_stop(workspace_id: str) -> Dict[str, Any]

def code_workspace_promote_policy(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def code_workspace_redeem_share_link(token: str) -> Dict[str, Any]

def code_workspace_register_runtime_tools(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def code_workspace_remove_collaborator(workspace_id: str, collaborator_id: str) -> None

def code_workspace_revoke_share_link(workspace_id: str, link_id: str) -> None

def code_workspace_run_review(workspace_id: str, run_id: str, *, verdict: str, feedback: str='') -> Dict[str, Any]

def code_workspace_run_review_apply(workspace_id: str, run_id: str) -> Dict[str, Any]

def code_workspace_run_telemetry(workspace_id: str, **filters: Any) -> Dict[str, Any]

def code_workspace_runs_insights(workspace_id: str) -> Dict[str, Any]

def code_workspace_runtime_catalog(workspace_id: str) -> Dict[str, Any]

def code_workspace_update_collaborator(workspace_id: str, collaborator_id: str, *, role: str) -> Dict[str, Any]

def codex_thread_action(workspace_id: str, thread_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def codex_turn_action(workspace_id: str, thread_id: str, turn_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def compute_aoc_tick(body: Dict[str, Any] | None=None) -> Dict[str, Any]

def create_aoc_run(body: Dict[str, Any]) -> Dict[str, Any]

def create_aoc_task(body: Dict[str, Any]) -> Dict[str, Any]

def create_approval_auto_accept(task_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def create_code_workspace(*, source: str | None=None, repo_connection_id: str | None=None, branch: str | None=None, depth: int | None=None, label: str | None=None, metadata: Dict[str, Any] | None=None, company_id: str | None=None) -> Dict[str, Any]

def create_conversation(domain: str) -> Dict[str, Any]

def create_crm_task(body: Dict[str, Any], tenant_id: str | None=None) -> Dict[str, Any]

def create_document(title: str, body: str, *, format: str='docx', target_suite: str='internal_library') -> DispatchResult

def create_document_session(*, document_type: str='general', document_title: str='Untitled Document') -> Dict[str, Any]

def create_page_builder_session(brand_name: str='', initial_prompt: str='') -> Dict[str, Any]

def create_project(name: str, *, instructions: str='', workspace_id: str | None=None, repo_connection_id: str | None=None, product_machine_plan: Dict[str, Any] | None=None, idempotency_key: str | None=None) -> Dict[str, Any]

Create a Lightbulb project (``POST /api/projects`` → ``ProjectCreateRequest``).

``name`` is required. Optionally bind a code workspace / repo connection
and seed the product-machine plan. Pass ``idempotency_key`` to make a
retried create return the existing project instead of duplicating it
(sent via the ``Idempotency-Key`` header the controller honours).

def create_slide_deck(title: str, body: str='', *, target_suite: str='internal_library') -> DispatchResult

def create_spreadsheet(title: str, body: str='', *, target_suite: str='internal_library') -> DispatchResult

def delete_approval_preference(preference_id: str) -> Dict[str, Any]

def delete_conversation(domain: str, conversation_id: str) -> None

def delete_crm_task(task_id: str, tenant_id: str | None=None) -> None

def dispatch(domain: str, *, action: str='chat', message: str='', objective: str='', inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> DispatchResult

def document_builder_add_collaborator(session_id: str, *, email: str | None=None, user_id: str | None=None, role: str='viewer') -> Dict[str, Any]

def document_builder_add_note(session_id: str, content: str) -> Dict[str, Any]

def document_builder_collaboration(session_id: str) -> Dict[str, Any]

def document_builder_create_share_link(session_id: str, *, role: str='viewer', expires_in_seconds: int | None=None) -> Dict[str, Any]

def document_builder_get_messages(session_id: str, **filters: Any) -> List[Dict[str, Any]]

def document_builder_redeem_share_link(session_id: str, token: str) -> Dict[str, Any]

def document_builder_save(session_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def get_aoc_decision(decision_id: str) -> Dict[str, Any]

def get_aoc_run(run_id: str) -> Dict[str, Any]

def get_aoc_task(task_id: str) -> Dict[str, Any]

def get_aoc_tick(tick_id: str) -> Dict[str, Any]

def get_approval(task_id: str) -> Dict[str, Any]

def get_artifact(artifact_id: str) -> Dict[str, Any]

def get_code_workspace_active_run(workspace_id: str) -> Dict[str, Any] | None

def get_code_workspace_claude_session(workspace_id: str, session_id: str) -> Dict[str, Any]

def get_code_workspace_codex_thread(workspace_id: str, thread_id: str) -> Dict[str, Any]

def get_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

def get_conversation(domain: str, conversation_id: str) -> Dict[str, Any]

def get_crm_task(task_id: str, tenant_id: str | None=None) -> Dict[str, Any]

def get_document_schemas(session_id: str) -> Dict[str, Any]

def get_document_session(session_id: str) -> Dict[str, Any]

def get_product_machine_plan(project_id: str) -> Dict[str, Any]

Get a project's product-machine plan / deliverables
(``GET /api/projects/{id}/product-machine/plan``).

def get_project(project_id: str) -> Dict[str, Any]

def get_voice_execution(execution_id: str) -> Dict[str, Any]

def get_workflow(workflow_id: str) -> Dict[str, Any]

def grep_documents(pattern: str, *, regex: bool=True, case_sensitive: bool=False, folder_path: str | None=None, top_k: int=20) -> DispatchResult

def hr_live_advance_application(application_id: str, *, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def hr_live_cases(**filters: Any) -> Dict[str, Any]

def hr_live_health() -> Dict[str, Any]

def hr_live_leave_balance(bamboo_employee_id: str) -> Dict[str, Any]

def hr_live_monday_onboarding_board(checklist_id: str) -> Dict[str, Any]

def hr_live_recruiting_applications(**filters: Any) -> Dict[str, Any]

def hr_live_recruiting_jobs(**filters: Any) -> Dict[str, Any]

def hr_live_reject_application(application_id: str, *, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def hr_live_whos_out(**filters: Any) -> Dict[str, Any]

def invoke_tool(tool_name: str, arguments: Dict[str, Any]) -> Dict[str, Any]

Invoke a platform tool by name (e.g. connector tools, utility tools).

Posts to ``POST /api/tools/invoke`` with ``toolName`` + ``inputs`` (plus
tenant/company scope from auth so the platform's RBAC + HITL machinery
can resolve the binding without re-reading the JWT for every field).

def it_ops_live_connector(connector: str, **filters: Any) -> Dict[str, Any]

def it_ops_mcp_manifest() -> Dict[str, Any]

def list_aoc_decisions(**filters: Any) -> List[Dict[str, Any]]

def list_aoc_runs(**filters: Any) -> List[Dict[str, Any]]

def list_aoc_task_events(task_id: str) -> List[Dict[str, Any]]

def list_aoc_tasks(**filters: Any) -> List[Dict[str, Any]]

def list_aoc_ticks(**filters: Any) -> List[Dict[str, Any]]

def list_approval_preferences() -> List[Dict[str, Any]]

def list_artifacts(**filters) -> List[Dict[str, Any]]

def list_code_workspace_claude_sessions(workspace_id: str) -> List[Dict[str, Any]]

def list_code_workspace_codex_threads(workspace_id: str, **filters: Any) -> List[Dict[str, Any]]

def list_code_workspace_proposals(workspace_id: str) -> List[Dict[str, Any]]

def list_code_workspace_runs(workspace_id: str, **filters: Any) -> List[Dict[str, Any]]

def list_code_workspaces() -> List[Dict[str, Any]]

def list_companies() -> List[Dict[str, Any]]

def list_connected_integrations(company_id: str | None=None) -> List[Dict[str, Any]]

def list_connectors() -> List[Dict[str, Any]]

def list_contacts(**filters) -> List[Dict[str, Any]]

def list_conversations(domain: str) -> List[Dict[str, Any]]

def list_crm_tasks(tenant_id: str | None=None, **filters: Any) -> List[Dict[str, Any]]

def list_deals(**filters) -> List[Dict[str, Any]]

def list_document_sessions() -> List[Dict[str, Any]]

def list_domain_actions(domain: str) -> List[Dict[str, Any]]

def list_domains() -> List[Dict[str, Any]]

def list_folder(folder_path: str='', *, source_system: str | None=None, max_items: int=100) -> DispatchResult

def list_notifications(**filters) -> List[Dict[str, Any]]

def list_page_builder_sessions() -> List[Dict[str, Any]]

def list_pending_approvals() -> List[Dict[str, Any]]

def list_projects() -> List[Dict[str, Any]]

def list_runtime_actions(status: str='active') -> Dict[str, Any]

List runtime domain actions by status
(``GET /api/domain-agents/runtime-actions?status=``).

Returns the controller's ``{status, count, actions:[...]}`` envelope.

def list_voice_executions(**filters: Any) -> List[Dict[str, Any]]

def list_voice_pending_approvals() -> List[Dict[str, Any]]

def list_workflows() -> List[Dict[str, Any]]

def mark_all_notifications_read() -> Dict[str, Any]

def mark_notification_read(notification_id: str) -> Dict[str, Any]

def marketing_add_website_analytics_site(body: Dict[str, Any]) -> Dict[str, Any]

def marketing_content_configure_provider(provider: str, body: Dict[str, Any]) -> Dict[str, Any]

def marketing_content_setup() -> Dict[str, Any]

def marketing_install_website_analytics(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def marketing_remove_website_analytics_site(site_id: str) -> Dict[str, Any]

def marketing_select_website_analytics_site(site_id: str) -> Dict[str, Any]

def marketing_verify_website_analytics(body: Dict[str, Any] | None=None) -> Dict[str, Any]

def memory_add_skill(body: Dict[str, Any]) -> Dict[str, Any]

def memory_create_entry(body: Dict[str, Any]) -> Dict[str, Any]

def memory_create_identity(body: Dict[str, Any]) -> Dict[str, Any]

def memory_create_link(body: Dict[str, Any]) -> Dict[str, Any]

def memory_get_entry(entry_id: str) -> Dict[str, Any]

def memory_get_identity(doc_id: str) -> Dict[str, Any]

def memory_graph(**filters: Any) -> Dict[str, Any]

def memory_graph_node(node_id: str) -> Dict[str, Any]

def memory_list_entries(**filters: Any) -> List[Dict[str, Any]]

def memory_list_events(**filters: Any) -> List[Dict[str, Any]]

def memory_list_identity() -> List[Dict[str, Any]]

def memory_list_links(**filters: Any) -> List[Dict[str, Any]]

def memory_list_skills() -> List[Dict[str, Any]]

def memory_projection_memory() -> Dict[str, Any]

def memory_projection_soul() -> Dict[str, Any]

def memory_query(body: Dict[str, Any]) -> Dict[str, Any]

def memory_recall(key: str, *, namespace: str='default') -> Dict[str, Any]

def memory_record_event(body: Dict[str, Any]) -> Dict[str, Any]

def memory_search(query: str, *, namespace: str='default', top_k: int=5) -> List[Dict[str, Any]]

Search agent memory semantically (``POST /api/memory/query``).

Maps ``{query, namespace, top_k}`` onto the gateway's
``MemoryQueryRequest`` (``query_text``, ``categories=[namespace]``,
``top_k``) and returns the ranked ``entries`` list from the
``MemoryQueryResponse``. (The ``POST /api/memory/search`` route this used
to target has no handler — the semantic route is ``/query``.)

def memory_status() -> Dict[str, Any]

def memory_store(key: str, value: str, *, namespace: str='default') -> Dict[str, Any]

Store a value in agent memory.

Writes to the memory gateway's durable entry store
(``POST /api/memory/entries`` → ``MemoryEntryCreate``). The simple
``{key, value, namespace}`` triple is mapped onto the entry DTO so it
round-trips with :meth:`memory_search`:

- ``namespace`` → ``category`` (the grouping the search scopes by),
- ``value`` → ``summary`` (the retrievable content),
- ``key`` → preserved in ``tags`` and ``details_json`` for later lookup.

Stored as a durable ``semantic`` entry. (The bare ``POST /api/memory``
route this used to target has no handler — it 404'd.)

def modify_voice_action(execution_id: str, approval_task_id: str, modifications: Dict[str, Any]) -> Dict[str, Any]

def page_builder_capabilities(session_id: str) -> Dict[str, Any]

def page_builder_deploy(session_id: str, page_key: str='') -> Dict[str, Any]

def page_builder_get_preview(session_id: str) -> Dict[str, Any]

def page_builder_get_schemas(session_id: str) -> Dict[str, Any]

def page_builder_install_artifact(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def page_builder_promote_install_bundle(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def page_builder_promote_section(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def page_builder_save_backend_contract(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def page_builder_save_capability(session_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def page_builder_send_message(session_id: str, content: str) -> Dict[str, Any]

def page_builder_unpublish(session_id: str) -> Dict[str, Any]

def page_builder_workspace_automation(session_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

def post_aoc_task_event(task_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def rag_query(question: str, *, top_k: int=5, document_ids: List[str] | None=None) -> Dict[str, Any]

def rag_upload_document(filename: str, content: str, **metadata) -> Dict[str, Any]

def refresh_auth() -> bool

Run the configured ``auth_refresh`` callback and swap in fresh auth.

Returns ``True`` if a new ``AuthStrategy`` was installed. Callers
typically invoke this after catching :class:`AuthenticationError`,
then retry the failed request:

    try:
        client.dispatch("finance", action="chat", message="...")
    except AuthenticationError:
        if client.refresh_auth():
            client.dispatch("finance", action="chat", message="...")

def register_external_artifact(*, type: str, title: str='', summary: str='', uri: str='', content: str='', project_id: Optional[str]=None, source_agent: str='external_agent', metadata: Optional[Dict[str, Any]]=None, attach_workspace: bool=False) -> Dict[str, Any]

Register an external artifact (codebase/document/slide deck/spreadsheet/url) created
by a general agent so Lightbulb domain agents can discover and work on it.

Either ``uri`` or ``content`` must be provided. For a ``codebase`` artifact with a repo
``uri``, set ``attach_workspace=True`` to also clone it into a Code Workspace so Lightbulb
agents can work on it.

def register_runtime_action(domain: str, action: str, *, description: str='', agent_spec: Dict[str, Any] | None=None, component_ids: List[str] | None=None, workflow_type: str='') -> Dict[str, Any]

Author a runtime domain action (``POST /api/domain-agents/runtime-actions``).

Lands as ``pending_approval`` — not dispatchable until approved. Provide
an ``agent_spec`` to author a brand-new agent (``domain`` may be
``"custom"``); without one, ``domain`` must be an existing contract domain
and this adds an action to it. The request body uses the backend's
camelCase keys (``agentSpec``, ``componentIds``, ``workflowType``).

def reject_code_workspace_proposal(workspace_id: str, proposal_id: str, *, reason: str='') -> Dict[str, Any]

def reject_runtime_action(action_id: str) -> Dict[str, Any]

Reject a pending runtime action — ADMIN/TENANT only
(``POST /api/domain-agents/runtime-actions/{id}/reject``).

def reject_task(task_id: str, *, comments: str='') -> Dict[str, Any]

def reject_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

def search_documents(query: str, *, folder_path: str | None=None, top_k: int=10) -> DispatchResult

def set_approval_preference_state(preference_id: str, *, enabled: bool) -> Dict[str, Any]

def stop_aoc_run(run_id: str) -> Dict[str, Any]

def stream_chat(domain: str, *, message: str, action: str | None=None, inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> Generator[SSEEvent, None, None]

Stream a domain agent chat via Server-Sent Events.

Yields SSEEvent objects for each event (status, chat, artifact, complete, error).

def stream_code_workspace_chat(workspace_id: str, message: str, **kwargs: Any) -> Generator[SSEEvent, None, None]

Stream a coding agent chat as Server-Sent Events.

Yields SSEEvent objects (status, token, tool_call, diff, complete, error).
The non-streaming counterpart is :meth:`code_workspace_chat`.

def stream_document_builder_message(session_id: str, content: str) -> Generator[SSEEvent, None, None]

def stream_page_builder_message(session_id: str, content: str) -> Generator[SSEEvent, None, None]

def stream_page_builder_workspace_automation(session_id: str, body: Dict[str, Any] | None=None) -> Generator[SSEEvent, None, None]

def submit_code_workspace_proposal(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

def trigger_workflow(workflow_type: str, objective: str, *, inputs: Dict[str, Any] | None=None) -> Dict[str, Any]

def update_crm_task(task_id: str, body: Dict[str, Any], tenant_id: str | None=None) -> Dict[str, Any]

def update_product_machine_plan(project_id: str, plan: Dict[str, Any]) -> Dict[str, Any]

Replace a project's product-machine plan
(``PUT /api/projects/{id}/product-machine/plan``).

def validate_aoc_run_config(run_id: str) -> Dict[str, Any]

def whoami() -> Dict[str, Any]

def workspace_bundle(domain: str) -> Dict[str, Any]

def workspace_conversation(domain: str, conversation_id: str) -> Dict[str, Any]

def workspace_surface(domain: str, surface: str, **filters: Any) -> Dict[str, Any]

def workspace_trace(domain: str, trace_id: str) -> Dict[str, Any]

lightbulb.connectors.SlackClient

class · lightbulb/connectors.py:39

Thin wrapper over LightbulbClient for Slack operations.

Thin wrapper over LightbulbClient for Slack operations.

All operations route through the platform's tool surface, which enforces
OAuth scope, rate limits, and audit logging.

Fields

• inner: LightbulbClient

Methods

def add_reaction(*, channel: str, ts: str, name: str) -> Dict[str, Any]

def archive_channel(channel: str) -> Dict[str, Any]

def create_channel(*, name: str, is_private: bool=False) -> Dict[str, Any]

def get_channel_history(channel: str, *, limit: int=100, cursor: str='') -> Dict[str, Any]

def get_thread_replies(*, channel: str, ts: str, limit: int=100) -> Dict[str, Any]

def invite_to_channel(*, channel: str, users: List[str]) -> Dict[str, Any]

def join_channel(channel: str) -> Dict[str, Any]

def list_channels(*, types: str='public_channel,private_channel', limit: int=200) -> Dict[str, Any]

def list_users(*, limit: int=200, cursor: str='') -> Dict[str, Any]

def lookup_user(*, email: str) -> Dict[str, Any]

def post_message(*, channel: str, text: str, thread_ts: Optional[str]=None, blocks: Optional[List[Dict[str, Any]]]=None) -> Dict[str, Any]

def search_messages(query: str, *, count: int=20) -> Dict[str, Any]

def set_channel_topic(*, channel: str, topic: str) -> Dict[str, Any]

def update_message(*, channel: str, ts: str, text: str) -> Dict[str, Any]

lightbulb.connectors.JiraClient

class · lightbulb/connectors.py:122

Thin wrapper over LightbulbClient for Atlassian Jira operations.

Fields

• inner: LightbulbClient

Methods

def add_comment(issue_key: str, body: str) -> Dict[str, Any]

def create_issue(*, project_key: str, summary: str, issue_type: str='Task', description: str='', assignee: Optional[str]=None, labels: Optional[List[str]]=None, priority: Optional[str]=None, custom_fields: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def get_board_sprints(board_id: str, *, state: str='active') -> Dict[str, Any]

def get_issue(issue_key: str) -> Dict[str, Any]

def get_sprint_issues(sprint_id: str) -> Dict[str, Any]

def link_issues(*, inward_key: str, outward_key: str, link_type: str) -> Dict[str, Any]

def search_issues(jql: str, *, max_results: int=50) -> Dict[str, Any]

def transition_issue(issue_key: str, transition: str, *, comment: str='') -> Dict[str, Any]

def update_issue(issue_key: str, fields: Dict[str, Any]) -> Dict[str, Any]

lightbulb.connectors.BambooHRClient

class · lightbulb/connectors.py:191

BambooHR client.

BambooHR client.

Read endpoints route through the platform's HR-live surface (no rebuild of
tokens, scopes, or rate limits). Write operations route through the tool
surface so they pass through HITL approvals where required.

Fields

• inner: LightbulbClient

Methods

def create_leave_request(body: Dict[str, Any]) -> Dict[str, Any]

def get_employee(employee_id: str) -> Dict[str, Any]

def health() -> Dict[str, Any]

def leave_balance(employee_id: str) -> Dict[str, Any]

def list_employees(**filters: Any) -> Dict[str, Any]

def whos_out(**filters: Any) -> Dict[str, Any]

lightbulb.connectors.GreenhouseClient

class · lightbulb/connectors.py:225

Greenhouse ATS client (recruiting).

Fields

• inner: LightbulbClient

Methods

def advance_application(application_id: str, body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def get_candidate(candidate_id: str) -> Dict[str, Any]

def list_applications(**filters: Any) -> Dict[str, Any]

def list_candidates(**filters: Any) -> Dict[str, Any]

def list_jobs(**filters: Any) -> Dict[str, Any]

def reject_application(application_id: str, body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

lightbulb.connectors.MondayClient

class · lightbulb/connectors.py:255

Monday.com client used by the HR engagement and onboarding flows.

Fields

• inner: LightbulbClient

Methods

def cases(**filters: Any) -> Dict[str, Any]

def create_item(*, board_id: str, group_id: str, item_name: str, column_values: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def get_board(board_id: str) -> Dict[str, Any]

def list_boards(**filters: Any) -> Dict[str, Any]

def onboarding_board(checklist_id: str) -> Dict[str, Any]

def update_item(*, item_id: str, column_values: Dict[str, Any]) -> Dict[str, Any]

lightbulb.errors.LightbulbError

class · lightbulb/errors.py:49

Base for all Lightbulb SDK exceptions raised against the platform.

Base for all Lightbulb SDK exceptions raised against the platform.

Attributes:
    status_code: HTTP status (or None for client-side validation errors).
    path: Request path that triggered the error (best-effort).
    request_id: Server-supplied trace ID, if any.

Fields

• status_code: Optional[int] = None

lightbulb.errors.AuthenticationError

class · lightbulb/errors.py:74

401 — credentials missing or invalid (token expired, bad password, etc.).

lightbulb.errors.PermissionDenied

class · lightbulb/errors.py:79

403 — caller is authenticated but lacks permission for the action.

lightbulb.errors.NotFoundError

class · lightbulb/errors.py:84

404 — resource does not exist or is outside the caller's scope.

lightbulb.errors.ValidationError

class · lightbulb/errors.py:89

400 / 422 — request was malformed or rejected by server validation.

400 / 422 — request was malformed or rejected by server validation.

Also raised by client-side validators (``_validate_domain`` etc.) when the
SDK can detect a bad input before hitting the network.

Multiply-inherits from :class:`ValueError` so existing ``except ValueError``
clauses keep working — the rest of the SDK has historically raised
``ValueError`` for input rejection.

lightbulb.errors.RateLimitedError

class · lightbulb/errors.py:102

429 — too many requests. Back off and retry.

lightbulb.errors.ServerError

class · lightbulb/errors.py:117

5xx — the platform itself is unhappy. Usually transient.

lightbulb.errors.from_response

function · lightbulb/errors.py:161

from_response(response: httpx.Response, *, default_message: str='') -> LightbulbError

Map an HTTP response to the matching LightbulbError subclass.

Map an HTTP response to the matching LightbulbError subclass.

The error message is drawn from the server's ``message`` / ``error`` /
``detail`` field when present, NEVER from the raw body.

lightbulb.errors.wrap_http_error

function · lightbulb/errors.py:177

wrap_http_error(exc: httpx.HTTPStatusError) -> LightbulbError

Convert an ``httpx.HTTPStatusError`` to a LightbulbError without leaking the body.

lightbulb.errors.raise_if_error

function · lightbulb/errors.py:182

raise_if_error(response: httpx.Response) -> None

Raise a :class:`LightbulbError` subclass if ``response`` has an error status.

Raise a :class:`LightbulbError` subclass if ``response`` has an error status.

Safe to use on any :class:`~httpx.Response`; does nothing on 2xx/3xx.

lightbulb.stripe.StripeWorkflow

class · lightbulb/stripe.py:32

Names of the high-level composite workflows the orchestrator exposes.

Methods

def all() -> List[str]

lightbulb.stripe.StripeOrchestratorClient

class · lightbulb/stripe.py:51

Thin wrapper over LightbulbClient that drives the Stripe orchestration agent through the platform's standard tool-invocation surface.

Thin wrapper over LightbulbClient that drives the Stripe orchestration
agent through the platform's standard tool-invocation surface.

Fields

• inner: LightbulbClient

Methods

def account_health() -> Dict[str, Any]

def approve(approval_id: str, **extra: Any) -> Dict[str, Any]

def as_agent_toolkit_tools() -> List[Dict[str, Any]]

Return tool descriptors compatible with stripe-agent-toolkit shape.

Each entry has ``name``, ``description``, and a ``call`` callable that
takes a dict and returns a dict. Drop-in for any agent framework that
accepts named tools with a structured schema (OpenAI Agents SDK,
LangChain ``StructuredTool.from_function``, CrewAI ``Tool``, etc.).

def create_refund(charge_id: str, amount: int, **extra: Any) -> Dict[str, Any]

def dispatch(resource: str, verb: str, op_inputs: Optional[Dict[str, Any]]=None, *, stripe_account_id: Optional[str]=None) -> Dict[str, Any]

Send any (resource, verb) combination through the orchestrator.

Examples:
    >>> sd.dispatch("customers", "list", {"limit": 25})
    >>> sd.dispatch("refunds", "create", {"charge": "ch_...", "amount": 500})

def execute(approval_id: str) -> Dict[str, Any]

def forecast_snapshot() -> Dict[str, Any]

def list_customers(**filters: Any) -> Dict[str, Any]

def list_pending_approvals() -> Dict[str, Any]

def list_subscriptions(**filters: Any) -> Dict[str, Any]

def mcp_invoke(tool: str, arguments: Optional[Dict[str, Any]]=None, *, stripe_account_id: Optional[str]=None) -> Dict[str, Any]

def raw_api_request(api_path: str, *, method: str='GET', params: Optional[Dict[str, Any]]=None, stripe_account_id: Optional[str]=None, base_address: Optional[str]=None) -> Dict[str, Any]

Governed long-tail Stripe API request.

The backend only accepts Stripe API paths beginning with ``/v1/`` or
``/v2/`` and routes non-GET calls through the normal simulator, audit,
idempotency, and HITL approval path.

def reject(approval_id: str, reason: str='') -> Dict[str, Any]

def retrieve_charge(charge_id: str) -> Dict[str, Any]

def run_preference_learner() -> Dict[str, Any]

def run_workflow(workflow: str) -> Dict[str, Any]

def twin_list(resource_kind: str, *, limit: int=50) -> Dict[str, Any]

def twin_retrieve(*, stripe_account_id: str, resource_kind: str, external_id: str) -> Dict[str, Any]

lightbulb.xero.XeroPlaybook

class · lightbulb/xero.py:35

Well-known Xero playbook IDs.

Methods

def all() -> List[str]

lightbulb.xero.XeroAgentClient

class · lightbulb/xero.py:60

Thin wrapper over LightbulbClient that targets ``/api/finance/xero``.

Fields

• inner: LightbulbClient

Methods

def approve_proposal(proposal_id: str, body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def create_proposal(body: Dict[str, Any]) -> Dict[str, Any]

def org_profile(xero_tenant_id: str) -> Dict[str, Any]

def proposals(body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def propose_bill(body: Dict[str, Any]) -> Dict[str, Any]

def propose_invoice(body: Dict[str, Any]) -> Dict[str, Any]

def propose_journal(body: Dict[str, Any]) -> Dict[str, Any]

def propose_payroll_trueup(body: Dict[str, Any]) -> Dict[str, Any]

def reject_proposal(proposal_id: str, *, reason: str='') -> Dict[str, Any]

def run_playbook(playbook_id: str, body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def run_sync(body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

def snapshot(body: Optional[Dict[str, Any]]=None) -> Dict[str, Any]

__enter__

def __enter__() -> 'LightbulbClient'

Open the persistent HTTP session and return this client.

Source: lightbulb/client.py:2668

__exit__

def __exit__(exc_type: Any, exc: Any, tb: Any) -> None

Source: lightbulb/client.py:2673

activate_marketplace_action

def activate_marketplace_action(installation_id: str, *, idempotency_key: str) -> Dict[str, Any]

Activate an installed action; this never approves execution policy.

Source: lightbulb/client.py:8262

active_company_id

@property
def active_company_id() -> str | None

The currently selected company context (needed for write operations).

Source: lightbulb/client.py:2684

active_company_id

@active_company_id.setter
def active_company_id(value: str | None) -> None

Source: lightbulb/client.py:2689

add_project_coding_harness

def add_project_coding_harness(project_id: str, harness: str, *, make_primary: bool=False) -> Dict[str, Any]

Attach another harness without removing any existing project harness.

Source: lightbulb/client.py:2793

admit_project_learning_run

def admit_project_learning_run(project_id: str, learning_run_id: str, *, runtime: str, capacity_admission: Mapping[str, Any], operator_approved: bool=False, confirm_admission: bool=False, idempotency_key: str | None=None) -> Dict[str, Any]

Reserve budget and admit a queued run; this still executes no training.

Source: lightbulb/client.py:4080

apply_aoc_tick

def apply_aoc_tick(tick_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Apply a previously-computed AutoCompany tick (committing its decisions).

Source: lightbulb/client.py:9570

apply_code_workspace_proposal

def apply_code_workspace_proposal(workspace_id: str, proposal_id: str) -> Dict[str, Any]

Apply a previously-submitted proposal to the workspace files.

Source: lightbulb/client.py:8998

approve_runtime_domain_action

def approve_runtime_domain_action(runtime_action_id: str, *, project_id: str, company_id: str | None=None) -> Dict[str, Any]

Approve a reviewed action and return its governed recursive reference.

Source: lightbulb/client.py:7923

approve_task

def approve_task(task_id: str, *, comments: str='') -> Dict[str, Any]

Approve a pending HITL task.

Source: lightbulb/client.py:6961

approve_voice_action

def approve_voice_action(execution_id: str, approval_task_id: str, *, comments: str='') -> Dict[str, Any]

Approve a pending in-call action (e.g. transfer, wire info, commit booking).

Source: lightbulb/client.py:8613

archive_marketplace_action

def archive_marketplace_action(listing_id: str, *, idempotency_key: str, reason: str='') -> Dict[str, Any]

Archive a publisher-owned listing with a replay-safe mutation.

Source: lightbulb/client.py:8173

author_agentic_workflow

def author_agentic_workflow(prompt: str, *, name: str | None=None, workflow_type: str | None=None, preferred_domains: List[str] | None=None, include_approval_gates: bool=True, publish: bool=True, company_id: str | None=None, site_project_id: str | None=None, definition: Mapping[str, Any] | None=None) -> Dict[str, Any]

Compile once, then publish its exact executable projection through governance.

Source: lightbulb/client.py:6772

author_workflow_definition

def author_workflow_definition(definition: Mapping[str, Any], *, prompt: str='', name: str | None=None, workflow_type: str | None=None, site_project_id: str | None=None, category: str | None=None, change_notes: str | None=None, company_id: str | None=None) -> Dict[str, Any]

Publish one exact executable workflow projection through governance.

Source: lightbulb/client.py:6624

author_workflow_trigger

def author_workflow_trigger(workflow_definition_id: str, *, trigger_type: str='schedule', schedule: str | None=None, event_type: str | None=None, event_filter: Mapping[str, Any] | None=None, name: str | None=None, description: str | None=None, site_project_id: str | None=None, configuration: Mapping[str, Any] | None=None, enabled: bool=False, company_id: str | None=None) -> Dict[str, Any]

Create a principal-scoped schedule or event trigger for a workflow.

Source: lightbulb/client.py:6679

backbone_execute

def backbone_execute(objective: str, *, inputs: Dict[str, Any] | None=None) -> Dict[str, Any]

Execute a task through the backbone agent (research, analysis, code generation).

Source: lightbulb/client.py:5125

bind_project_mission_action

def bind_project_mission_action(project_id: str, mission_run_receipt_id: Any, action_event_id: Any, *, confirm_bind: bool=False, binding_id: Any=None, note: Any=None, idempotency_key: str | None=None) -> Dict[str, Any]

Bind a later event to a mission; this proves timing and scope only.

Source: lightbulb/client.py:3915

build_durable_project_runtime

def build_durable_project_runtime(project: Any, *, registry: Any=None, checkpoint_store: Any=None) -> Any

Build a durable runtime, using hosted checkpoints when possible.

Source: lightbulb/client.py:5258

build_dynamic_workflow_runtime

def build_dynamic_workflow_runtime(*, project_ref: str, hosted_project_id: str | None=None, hosted_company_id: str | None=None, checkpoint_store: Any=None) -> Any

Build the local planner/builder/evaluator state-machine runtime.

Source: lightbulb/client.py:5611

build_project_runtime

def build_project_runtime(project: Any, *, registry: Any=None) -> Any

Build a runtime using authenticated reads and safe connector previews.

Source: lightbulb/client.py:5239

cancel_code_workspace_run

def cancel_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

Cancel an in-flight coding run.

Source: lightbulb/client.py:9050

cancel_codex_account_link

def cancel_codex_account_link(session_id: str) -> Dict[str, Any]

Cancel a Codex device-auth session.

Source: lightbulb/client.py:3214

cancel_recursive_agent_execution

def cancel_recursive_agent_execution(execution_id: str) -> Dict[str, Any]

Cancel one exact user-owned recursive execution tree.

Source: lightbulb/client.py:6599

cancel_workflow_instance

def cancel_workflow_instance(trace_id: str, *, company_id: str | None=None) -> Dict[str, Any]

Cancel a scoped workflow run, including one waiting for approval.

Source: lightbulb/client.py:6557

claim_project_coding_handoff

def claim_project_coding_handoff(project_id: str, *, harness: str, handoff_payload_id: str, host_session_ref: str | None=None) -> Dict[str, Any]

Record routing of an approved handoff to the user's selected harness.

Source: lightbulb/client.py:2837

claim_sdk_project_checkpoint

def claim_sdk_project_checkpoint(project_id: str, *, worker_ref: str, ready_at: str, lease_seconds: int=60, company_id: str | None=None) -> Dict[str, Any] | None

Source: lightbulb/client.py:5723

claude_session_action

def claude_session_action(workspace_id: str, session_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Perform an action on a Claude SDK session.

Source: lightbulb/client.py:9286

close

def close() -> None

Close the persistent HTTP session, if one is open.

Source: lightbulb/client.py:2676

code_workspace_add_collaborator

def code_workspace_add_collaborator(workspace_id: str, *, email: str | None=None, user_id: str | None=None, role: str='viewer') -> Dict[str, Any]

Add a collaborator to a code workspace (role: viewer | editor | admin).

Source: lightbulb/client.py:8776

code_workspace_add_note

def code_workspace_add_note(workspace_id: str, content: str) -> Dict[str, Any]

Append a workspace note (visible to collaborators).

Source: lightbulb/client.py:8889

code_workspace_approve_access_request

def code_workspace_approve_access_request(workspace_id: str, request_id: str) -> Dict[str, Any]

Approve a pending workspace access request.

Source: lightbulb/client.py:8863

code_workspace_chat

def code_workspace_chat(workspace_id: str, message: str, **kwargs) -> Dict[str, Any]

Send a chat message to a code workspace.

Source: lightbulb/client.py:5083

code_workspace_clear_policy

def code_workspace_clear_policy(workspace_id: str, request_family: str) -> Dict[str, Any]

Clear cached policy decisions for a request family.

Source: lightbulb/client.py:9229

code_workspace_collaboration

def code_workspace_collaboration(workspace_id: str) -> Dict[str, Any]

Get collaboration info (members, share links, pending requests).

Source: lightbulb/client.py:8766

code_workspace_create_pull_request

def code_workspace_create_pull_request(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Open a GitHub pull request from the workspace branch.

Source: lightbulb/client.py:9024

code_workspace_create_share_link

def code_workspace_create_share_link(workspace_id: str, *, role: str='viewer', expires_in_seconds: int | None=None) -> Dict[str, Any]

Create a share-link token granting access to the workspace.

Source: lightbulb/client.py:8823

code_workspace_deny_access_request

def code_workspace_deny_access_request(workspace_id: str, request_id: str) -> Dict[str, Any]

Deny a pending workspace access request.

Source: lightbulb/client.py:8876

code_workspace_evals

def code_workspace_evals(workspace_id: str) -> Dict[str, Any]

Get accumulated eval rollups for a workspace's runs.

Source: lightbulb/client.py:9206

code_workspace_invoke_tool

def code_workspace_invoke_tool(workspace_id: str, tool_key: str, arguments: Dict[str, Any] | None=None) -> Dict[str, Any]

Invoke a workspace-scoped tool (read/write files, run commands, git ops).

Source: lightbulb/client.py:9065

code_workspace_link_repository

def code_workspace_link_repository(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Link a GitHub repository to the workspace.

Source: lightbulb/client.py:9037

code_workspace_policy_replay

def code_workspace_policy_replay(workspace_id: str, **filters: Any) -> Dict[str, Any]

Replay a policy decision over historical runs (debug helper).

Source: lightbulb/client.py:9216

code_workspace_preview

def code_workspace_preview(workspace_id: str) -> Dict[str, Any]

Get the current preview state (URL, status, last build).

Source: lightbulb/client.py:9139

code_workspace_preview_proxy

def code_workspace_preview_proxy(workspace_id: str, path: str='', *, method: str='GET', body: Any=None, headers: Dict[str, str] | None=None) -> httpx.Response

Proxy an HTTP call through the workspace preview.

Source: lightbulb/client.py:9160

code_workspace_preview_start

def code_workspace_preview_start(workspace_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Start the workspace preview server (renders the in-progress code).

Source: lightbulb/client.py:9124

code_workspace_preview_stop

def code_workspace_preview_stop(workspace_id: str) -> Dict[str, Any]

Stop the workspace preview server.

Source: lightbulb/client.py:9149

code_workspace_promote_policy

def code_workspace_promote_policy(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Promote workspace-scoped policy to a higher scope (company/tenant).

Source: lightbulb/client.py:9242

code_workspace_redeem_share_link

def code_workspace_redeem_share_link(token: str) -> Dict[str, Any]

Redeem a workspace share-link token to gain access.

Source: lightbulb/client.py:8852

code_workspace_register_runtime_tools

def code_workspace_register_runtime_tools(workspace_id: str, body: Dict[str, Any]) -> Dict[str, Any]

Register or update workspace runtime tools.

Source: lightbulb/client.py:9107

code_workspace_remove_collaborator

def code_workspace_remove_collaborator(workspace_id: str, collaborator_id: str) -> None

Revoke a collaborator's access.

Source: lightbulb/client.py:8812

code_workspace_revoke_share_link

def code_workspace_revoke_share_link(workspace_id: str, link_id: str) -> None

Revoke a share link.

Source: lightbulb/client.py:8843

code_workspace_run_review

def code_workspace_run_review(workspace_id: str, run_id: str, *, verdict: str, feedback: str='') -> Dict[str, Any]

Submit a human review verdict (accept | reject | request_changes) for a run.

Source: lightbulb/client.py:8943

code_workspace_run_review_apply

def code_workspace_run_review_apply(workspace_id: str, run_id: str) -> Dict[str, Any]

Apply review-suggested changes to the workspace.

Source: lightbulb/client.py:8961

code_workspace_run_telemetry

def code_workspace_run_telemetry(workspace_id: str, **filters: Any) -> Dict[str, Any]

Raw telemetry rows for a workspace's runs.

Source: lightbulb/client.py:8930

code_workspace_runs_insights

def code_workspace_runs_insights(workspace_id: str) -> Dict[str, Any]

Aggregate run-quality insights for a workspace (cost, latency, success rate).

Source: lightbulb/client.py:8920

code_workspace_runtime_catalog

def code_workspace_runtime_catalog(workspace_id: str) -> Dict[str, Any]

Read the workspace's runtime tool catalog (which tool keys are available).

Source: lightbulb/client.py:9097

code_workspace_update_collaborator

def code_workspace_update_collaborator(workspace_id: str, collaborator_id: str, *, role: str) -> Dict[str, Any]

Change a collaborator's role.

Source: lightbulb/client.py:8799

codex_thread_action

def codex_thread_action(workspace_id: str, thread_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Perform a thread-level action (rename | archive | unarchive | compact | rollback).

Source: lightbulb/client.py:9346

codex_turn_action

def codex_turn_action(workspace_id: str, thread_id: str, turn_id: str, action: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Steer or interrupt a specific Codex turn (action: steer | interrupt).

Source: lightbulb/client.py:9370

compile_business_workflow

def compile_business_workflow(objective: str, *, primitive_ids: List[str] | None=None, inputs: Dict[str, Any] | None=None, workflow_name: str | None=None, workflow_type: str | None=None, trigger_event: str | None=None, owner_role: str='workflow_owner', loop: bool=False, max_iterations: int | None=None, source: str='sdk') -> Dict[str, Any]

Compile a portable, governed workflow draft without network calls.

Source: lightbulb/client.py:5892

compose_business_workflow

def compose_business_workflow(objective: str, *, primitive_ids: List[str] | None=None, inputs: Dict[str, Any] | None=None, loop: bool=False, max_iterations: int | None=None, workflow_name: str | None=None, workflow_type: str | None=None, trigger_event: str | None=None, owner_role: str='workflow_owner', publish: bool=False, source: str='sdk') -> Dict[str, Any]

Draft an Agent Builder workflow from business primitive blocks.

Source: lightbulb/client.py:5859

compute_aoc_tick

def compute_aoc_tick(body: Dict[str, Any] | None=None) -> Dict[str, Any]

Run a one-shot AutoCompany tick computation.

Source: lightbulb/client.py:9559

configure_backbone_agent_surface

def configure_backbone_agent_surface(backbone_surface: str, *, model_provider: str | None=None, model_id: str | None=None, provider_connection_id: str | None=None, scope: str='USER', company_id: str | None=None, request_overrides: Dict[str, Any] | None=None) -> Dict[str, Any]

Configure the preferred Backbone host surface, such as ChatGPT MCP.

Source: lightbulb/client.py:3119

configure_coding_agent_runtime

def configure_coding_agent_runtime(runtime_backend: str, *, model_provider: str | None=None, model_id: str | None=None, provider_connection_id: str | None=None, use_codex_account: bool | None=None, scope: str='USER', company_id: str | None=None, request_overrides: Dict[str, Any] | None=None) -> Dict[str, Any]

Configure Codex, Claude Code, or another coding harness for this account.

Source: lightbulb/client.py:3078

context_archive

def context_archive(context_ref: str, *, project_id: str | None=None, company_id: str | None=None) -> Dict[str, Any]

Archive a private Context Space and close its host bindings.

Source: lightbulb/client.py:7607

context_checkpoint

def context_checkpoint(context_ref: str, *, binding_ref: str, base_revision: int, idempotency_key: str, events: Sequence[Mapping[str, Any]] | None=None, state: Mapping[str, Any] | None=None, project_id: str | None=None, company_id: str | None=None) -> Dict[str, Any]

Append host deltas and structured state with optimistic concurrency.

Source: lightbulb/client.py:7474

context_company_id

@property
def context_company_id() -> str | None

Company used only by Context Broker calls; defaults to the active company.

Source: lightbulb/client.py:2695

context_company_id

@context_company_id.setter
def context_company_id(value: str | None) -> None

Source: lightbulb/client.py:2704

context_delete

def context_delete(context_ref: str, *, project_id: str | None=None, company_id: str | None=None) -> Dict[str, Any]

Request scoped physical deletion after the server's grace period.

Source: lightbulb/client.py:7630

context_export

def context_export(context_ref: str, *, project_id: str | None=None, company_id: str | None=None, event_after_sequence: int=0, checkpoint_after_revision: int=0, limit: int=50, max_bytes: int=1048576) -> Dict[str, Any]

Export a bounded page from a private Context Space for user custody.

Source: lightbulb/client.py:7552

context_open

def context_open(host: str, *, host_session_ref: str | None=None, model: str | None=None, context_ref: str | None=None, project_id: str | None=None, company_id: str | None=None, token_budget: int=_CONTEXT_TOKEN_BUDGET_DEFAULT, query: str | None=None, repository: Mapping[str, Any] | None=None) -> Dict[str, Any]

Open or resume a private cross-host context binding.

Source: lightbulb/client.py:7289

context_pack

def context_pack(context_ref: str, *, binding_ref: str | None=None, query: str | None=None, project_id: str | None=None, company_id: str | None=None, token_budget: int=_CONTEXT_TOKEN_BUDGET_DEFAULT, max_items: int=12) -> Dict[str, Any]

Build a bounded, prompt-aware working pack from durable context.

Source: lightbulb/client.py:7345

context_read

def context_read(context_ref: str, refs: Sequence[str], *, project_id: str | None=None, company_id: str | None=None, token_budget: int=_CONTEXT_TOKEN_BUDGET_DEFAULT) -> Dict[str, Any]

Read exact opaque context items under a bounded token budget.

Source: lightbulb/client.py:7434

context_search

def context_search(context_ref: str, query: str, *, project_id: str | None=None, company_id: str | None=None, token_budget: int=_CONTEXT_TOKEN_BUDGET_DEFAULT, max_items: int=10, kinds: Sequence[str] | None=None) -> Dict[str, Any]

Search a Context Space without placing its full corpus in-model.

Source: lightbulb/client.py:7384

context_status

def context_status(context_ref: str, *, binding_ref: str | None=None, project_id: str | None=None, company_id: str | None=None) -> Dict[str, Any]

Inspect one Context Space or one exact host-session binding.

Source: lightbulb/client.py:7523

create_account_shell_customization_draft

def create_account_shell_customization_draft(document: Mapping[str, Any], *, base_revision_id: str | None) -> Dict[str, Any]

Create an immutable draft from one exact base revision.

Source: lightbulb/client.py:7726

create_aoc_run

def create_aoc_run(body: Dict[str, Any]) -> Dict[str, Any]

Create a new AutoCompany run.

Source: lightbulb/client.py:9412

create_aoc_task

def create_aoc_task(body: Dict[str, Any]) -> Dict[str, Any]

Create an AutoCompany task.

Source: lightbulb/client.py:9465

create_approval_auto_accept

def create_approval_auto_accept(task_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Create an auto-accept rule keyed off the shape of an existing approval task.

Source: lightbulb/client.py:9920

create_code_workspace

def create_code_workspace(*, source: str | None=None, repo_connection_id: str | None=None, branch: str | None=None, depth: int | None=None, label: str | None=None, metadata: Dict[str, Any] | None=None, company_id: str | None=None) -> Dict[str, Any]

Create a code workspace.

Source: lightbulb/client.py:5037

create_conversation

def create_conversation(domain: str) -> Dict[str, Any]

Create a new conversation for a domain.

Source: lightbulb/client.py:4790

create_crm_task

def create_crm_task(body: Dict[str, Any], tenant_id: str | None=None) -> Dict[str, Any]

Create a CRM task.

Source: lightbulb/client.py:9869

create_document

def create_document(title: str, body: str, *, format: str='docx', target_suite: str='internal_library') -> DispatchResult

Create a new document.

Source: lightbulb/client.py:4909

create_document_session

def create_document_session(*, document_type: str='general', document_title: str='Untitled Document') -> Dict[str, Any]

Create a new document builder session.

Source: lightbulb/client.py:4809

create_page_builder_session

def create_page_builder_session(brand_name: str='', initial_prompt: str='') -> Dict[str, Any]

Create a new page builder session.

Source: lightbulb/client.py:4962

create_project_from_preflight

def create_project_from_preflight(receipt: ProjectCreationPreflightReceipt, *, coding_harness: str, confirm_create: bool=False, confirm_open_questions: bool=False, workspace_id: str | None=None, repo_connection_id: str | None=None, idempotency_key: str | None=None, play_style: str | None=None) -> Dict[str, Any]

Create exactly the draft bound to a validated preflight receipt.

Source: lightbulb/client.py:4516

create_server_workflow_improvement_packet

def create_server_workflow_improvement_packet(packet: Dict[str, Any], *, source_run_id: str | None=None) -> Dict[str, Any]

Source: lightbulb/client.py:6147

create_slide_deck

def create_slide_deck(title: str, body: str='', *, target_suite: str='internal_library') -> DispatchResult

Create a new slide deck.

Source: lightbulb/client.py:4945

create_spreadsheet

def create_spreadsheet(title: str, body: str='', *, target_suite: str='internal_library') -> DispatchResult

Create a new spreadsheet.

Source: lightbulb/client.py:4930

decide_project_learning_result_admission

def decide_project_learning_result_admission(project_id: str, evaluation_receipt_id: str, *, decision: Any, rationale: Any, confirm_admission: bool=False, idempotency_key: str | None=None) -> Dict[str, Any]

Human admit/reject; never apply or promote the candidate.

Source: lightbulb/client.py:4137

decide_workflow_improvement_packet

def decide_workflow_improvement_packet(packet_id: str, *, approval_scope: str, decision: str, rationale: str='', evidence: Dict[str, Any] | None=None) -> Dict[str, Any]

Source: lightbulb/client.py:6214

delete_approval_preference

def delete_approval_preference(preference_id: str) -> Dict[str, Any]

Remove an auto-accept rule.

Source: lightbulb/client.py:9933

delete_conversation

def delete_conversation(domain: str, conversation_id: str) -> None

Delete a conversation.

Source: lightbulb/client.py:4799

delete_crm_task

def delete_crm_task(task_id: str, tenant_id: str | None=None) -> None

Delete a CRM task.

Source: lightbulb/client.py:9897

delete_workflow

def delete_workflow(workflow_id: str, *, company_id: str | None=None) -> None

Soft-delete a workflow through the authenticated designer API.

Source: lightbulb/client.py:6541

dispatch

def dispatch(domain: str, *, action: str='chat', message: str='', objective: str='', inputs: Dict[str, Any] | None=None, conversation_id: str | None=None, company_id: str | None=None) -> DispatchResult

Dispatch a one-shot action to a domain agent and wait for the result.

Source: lightbulb/client.py:3512

document_builder_add_collaborator

def document_builder_add_collaborator(session_id: str, *, email: str | None=None, user_id: str | None=None, role: str='viewer') -> Dict[str, Any]

Add a collaborator to a document builder session.

Source: lightbulb/client.py:10169

document_builder_add_note

def document_builder_add_note(session_id: str, content: str) -> Dict[str, Any]

Add a note to a document builder session.

Source: lightbulb/client.py:10342

document_builder_collaboration

def document_builder_collaboration(session_id: str) -> Dict[str, Any]

Collaboration info for a document builder session.

Source: lightbulb/client.py:10159

document_builder_create_share_link

def document_builder_create_share_link(session_id: str, *, role: str='viewer', expires_in_seconds: int | None=None) -> Dict[str, Any]

Create a share-link token for a document builder session.

Source: lightbulb/client.py:10192

document_builder_get_messages

def document_builder_get_messages(session_id: str, **filters: Any) -> List[Dict[str, Any]]

Get the message history for a document builder session.

Source: lightbulb/client.py:10225

document_builder_redeem_share_link

def document_builder_redeem_share_link(session_id: str, token: str) -> Dict[str, Any]

Redeem a document builder share link.

Source: lightbulb/client.py:10212

document_builder_save

def document_builder_save(session_id: str, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Save a document builder session's current state.

Source: lightbulb/client.py:10243

drain_runtime_outcomes

def drain_runtime_outcomes() -> List[Dict[str, Any]]

Atomically consume outcomes in improvement-loop wire format.

Source: lightbulb/client.py:5975

dynamic_workflow_attach

def dynamic_workflow_attach(*, company_ref: str, project_ref: str, run_ref: str, host: str, host_session_ref: str, host_role: str, expected_revision: int, idempotency_key: str) -> Dict[str, Any]

Attach fresh role custody to an existing authoritative run.

Source: lightbulb/client.py:5382

dynamic_workflow_cancel

def dynamic_workflow_cancel(*, company_ref: str, project_ref: str, run_ref: str, host_binding_ref: str, session_receipt: str, host_role: str, expected_revision: int, idempotency_key: str, reason: str) -> Dict[str, Any]

Cancel a non-terminal workflow using exact optimistic concurrency.

Source: lightbulb/client.py:5582

dynamic_workflow_next_assignment

def dynamic_workflow_next_assignment(*, company_ref: str, project_ref: str, run_ref: str, host_binding_ref: str, session_receipt: str, host_role: str, expected_revision: int, idempotency_key: str) -> Dict[str, Any]

Lease the next assignment from the dedicated workflow authority.

Source: lightbulb/client.py:5432

dynamic_workflow_start

def dynamic_workflow_start(*, company_ref: str, project_ref: str, objective: str, acceptance_criteria: Sequence[Mapping[str, Any]], host: str, expected_revision: int, idempotency_key: str, host_session_ref: str | None=None, acceptance_policy: str='distinct_binding', workflow_spec: Mapping[str, Any] | None=None, inputs: Mapping[str, Any] | None=None) -> Dict[str, Any]

Start an authoritative planner/builder/evaluator workflow.

Source: lightbulb/client.py:5348

dynamic_workflow_status

def dynamic_workflow_status(*, company_ref: str, project_ref: str, run_ref: str, host_binding_ref: str, session_receipt: str, host_role: str) -> Dict[str, Any]

Read bounded status using a role-bound continuation receipt.

Source: lightbulb/client.py:5409

dynamic_workflow_submit_builder_result

def dynamic_workflow_submit_builder_result(*, company_ref: str, project_ref: str, run_ref: str, host_binding_ref: str, session_receipt: str, host_role: str, assignment_ref: str, assignment_receipt: str, expected_revision: int, idempotency_key: str, outcome: str, summary: str, plan_digest: str, iteration: int, evidence_refs: Sequence[Mapping[str, Any]], progress_digest: str) -> Dict[str, Any]

Submit content-addressed builder evidence under its assignment lease.

Source: lightbulb/client.py:5494

dynamic_workflow_submit_evaluator_verdict

def dynamic_workflow_submit_evaluator_verdict(*, company_ref: str, project_ref: str, run_ref: str, host_binding_ref: str, session_receipt: str, host_role: str, assignment_ref: str, assignment_receipt: str, expected_revision: int, idempotency_key: str, decision: str, accepted: bool, summary: str, plan_digest: str, builder_result_digest: str, required_criterion_ids: Sequence[str], criterion_results: Sequence[Mapping[str, Any]]) -> Dict[str, Any]

Submit a default-fail evaluator verdict under fresh role custody.

Source: lightbulb/client.py:5537

dynamic_workflow_submit_plan

def dynamic_workflow_submit_plan(*, company_ref: str, project_ref: str, run_ref: str, host_binding_ref: str, session_receipt: str, host_role: str, assignment_ref: str, assignment_receipt: str, expected_revision: int, idempotency_key: str, required_criterion_ids: Sequence[str], plan: Mapping[str, Any]) -> Dict[str, Any]

Submit a planner result under its exact assignment lease.

Source: lightbulb/client.py:5459

evaluate_project_offline_policy

def evaluate_project_offline_policy(project_id: str, *, behavior_policy_id: Any, candidate_policy_id: Any, metric_id: Any, pairs: Sequence[Mapping[str, Any]], confirm_evaluate: bool=False, evaluation_id: Any=None, note: Any=None, idempotency_key: str | None=None) -> Dict[str, Any]

Estimate a candidate from verified receipts; never admit learning.

Source: lightbulb/client.py:4414

flush_runtime_outcomes

def flush_runtime_outcomes(*, idempotency_key: str | None=None) -> Dict[str, Any]

Upload queued outcomes, restoring them locally when upload fails.

Source: lightbulb/client.py:6001

from_verified_envelope

def from_verified_envelope(base_url: str, envelope: Any, *, enforce_https: bool=True, connect_timeout: float=_CONNECT_TIMEOUT, read_timeout: float=_READ_TIMEOUT, outcome_recorder: Any=None) -> 'LightbulbClient'

Build a worker-only client without a JWT or shared API credential.

Source: lightbulb/client.py:2609

get_account_shell_customization

def get_account_shell_customization() -> Dict[str, Any]

Read the effective governed account-shell customization.

Source: lightbulb/client.py:7716

get_agent_runtime_config

def get_agent_runtime_config(agent_type: str='coding', *, company_id: str | None=None) -> Dict[str, Any]

Get the effective Codex/Claude Code/Backbone runtime config for this account.

Source: lightbulb/client.py:3055

get_aoc_decision

def get_aoc_decision(decision_id: str) -> Dict[str, Any]

Get a specific AutoCompany decision.

Source: lightbulb/client.py:9525

get_aoc_run

def get_aoc_run(run_id: str) -> Dict[str, Any]

Get an AutoCompany run detail.

Source: lightbulb/client.py:9421

get_aoc_task

def get_aoc_task(task_id: str) -> Dict[str, Any]

Get an AutoCompany task detail.

Source: lightbulb/client.py:9474

get_aoc_tick

def get_aoc_tick(tick_id: str) -> Dict[str, Any]

Get a single AutoCompany tick.

Source: lightbulb/client.py:9549

get_approval

def get_approval(task_id: str) -> Dict[str, Any]

Get full details of an approval task.

Source: lightbulb/client.py:6951

get_artifact

def get_artifact(artifact_id: str) -> Dict[str, Any]

Get a specific artifact by ID.

Source: lightbulb/client.py:6408

get_code_workspace_active_run

def get_code_workspace_active_run(workspace_id: str) -> Dict[str, Any] | None

Get the currently active run for a code workspace, if one exists.

Source: lightbulb/client.py:5101

get_code_workspace_claude_session

def get_code_workspace_claude_session(workspace_id: str, session_id: str) -> Dict[str, Any]

Get a single Claude SDK session.

Source: lightbulb/client.py:9274

get_code_workspace_codex_thread

def get_code_workspace_codex_thread(workspace_id: str, thread_id: str) -> Dict[str, Any]

Get a Codex thread (turns, status, metadata).

Source: lightbulb/client.py:9334

get_code_workspace_run

def get_code_workspace_run(workspace_id: str, run_id: str) -> Dict[str, Any]

Get a specific code workspace run.

Source: lightbulb/client.py:5113

get_codex_account_link_status

def get_codex_account_link_status(session_id: str) -> Dict[str, Any]

Poll a Codex device-auth session.

Source: lightbulb/client.py:3203

get_conversation

def get_conversation(domain: str, conversation_id: str) -> Dict[str, Any]

Get conversation history.

Source: lightbulb/client.py:4781

get_crm_task

def get_crm_task(task_id: str, tenant_id: str | None=None) -> Dict[str, Any]

Get a single CRM task.

Source: lightbulb/client.py:9856

get_document_schemas

def get_document_schemas(session_id: str) -> Dict[str, Any]

Get the document schemas for a session.

Source: lightbulb/client.py:4839

get_document_session

def get_document_session(session_id: str) -> Dict[str, Any]

Get a document builder session.

Source: lightbulb/client.py:4831

get_finance_reconciliation_run

def get_finance_reconciliation_run(run_id: str, *, company_id: str | None=None) -> FinanceReconciliationRunDetails

Get one exact reconciliation run and validate its stored envelope.

Source: lightbulb/client.py:3490

get_marketplace_action_publication

def get_marketplace_action_publication(publication_id: str) -> Dict[str, Any]

Get governed publication and security-scan status by publication UUID.

Source: lightbulb/client.py:8131

get_marketplace_installation

def get_marketplace_installation(installation_id: str) -> Dict[str, Any]

Get one marketplace installation for the selected active company.

Source: lightbulb/client.py:8222

get_marketplace_invocation_receipt

def get_marketplace_invocation_receipt(invocation_id: str) -> Dict[str, Any]

Get the immutable audit receipt for one marketplace invocation.

Source: lightbulb/client.py:8399

get_marketplace_invocation_status

def get_marketplace_invocation_status(invocation_id: str) -> Dict[str, Any]

Get current invocation state for the selected company.

Source: lightbulb/client.py:8387

get_marketplace_listing

def get_marketplace_listing(listing_id: str, *, revision_id: str | None=None, include_inputs: bool=True) -> Dict[str, Any]

Get one persisted marketplace listing and optional immutable revision.

Source: lightbulb/client.py:8037

get_project_coding_handoff

def get_project_coding_handoff(project_id: str, harness: str) -> Dict[str, Any]

Read the selected Project Agent handoff for a connected harness.

Source: lightbulb/client.py:2818

get_project_coding_harnesses

def get_project_coding_harnesses(project_id: str) -> Dict[str, Any]

Read the durable additive harness selection for one project.

Source: lightbulb/client.py:2780

get_project_connector_route_descriptor

def get_project_connector_route_descriptor(project_id: str, connector_account_ref: str, tool_name: str, *, company_id: str | None=None) -> Dict[str, Any]

Resolve exact governed execution coordinates for one project account Tool.

Source: lightbulb/client.py:3001

get_project_game_snapshot

def get_project_game_snapshot(project_id: str) -> Dict[str, Any]

Fetch one server-owned, exact-scoped project snapshot.

Source: lightbulb/client.py:3714

get_recursive_agent_execution_status

def get_recursive_agent_execution_status(execution_id: str) -> Dict[str, Any]

Read privacy-minimized status for one exact user-owned recursive tree.

Source: lightbulb/client.py:6610

get_runtime_domain_action

def get_runtime_domain_action(runtime_action_id: str, *, project_id: str, company_id: str | None=None) -> Dict[str, Any]

Review one exact-scope registration without changing its lifecycle.

Source: lightbulb/client.py:7905

get_sdk_project_checkpoint

def get_sdk_project_checkpoint(project_id: str, run_ref: str, *, company_id: str | None=None) -> Dict[str, Any] | None

Source: lightbulb/client.py:5690

get_server_workflow_improvement_packet

def get_server_workflow_improvement_packet(packet_id: str) -> Dict[str, Any]

Read one exact tenant/company-scoped workflow improvement packet.

Source: lightbulb/client.py:6204

get_server_workflow_improvement_status

def get_server_workflow_improvement_status() -> Dict[str, Any]

Source: lightbulb/client.py:6178

get_training_pair_status

def get_training_pair_status(pair_handle: str, *, project_id: str | None=None) -> Dict[str, Any]

Read the privacy-minimized status for one exact owned pair handle.

Source: lightbulb/client.py:8547

get_voice_execution

def get_voice_execution(execution_id: str) -> Dict[str, Any]

Get a voice execution detail (transcripts, status, agent decisions).

Source: lightbulb/client.py:8592

get_workflow

def get_workflow(workflow_id: str) -> Dict[str, Any]

Get a workflow by ID.

Source: lightbulb/client.py:6475

get_workflow_improvement_audit

def get_workflow_improvement_audit(packet_id: str) -> List[Dict[str, Any]]

Source: lightbulb/client.py:6239

get_workflow_improvement_delivery

def get_workflow_improvement_delivery(delivery_id: str) -> Dict[str, Any]

Source: lightbulb/client.py:6294

get_workflow_improvement_status

def get_workflow_improvement_status(output_dir: str | os.PathLike[str] | None=None) -> Dict[str, Any]

Read local continuous-improvement state without network calls.

Source: lightbulb/client.py:6033

get_workflow_instance

def get_workflow_instance(trace_id: str, *, company_id: str | None=None) -> Dict[str, Any]

Get a workflow instance through the authenticated public API.

Source: lightbulb/client.py:3564

get_workflow_trigger_catalog

def get_workflow_trigger_catalog() -> Dict[str, Any]

List the schedule literals and event types accepted by authoring.

Source: lightbulb/client.py:6759

grep_documents

def grep_documents(pattern: str, *, regex: bool=True, case_sensitive: bool=False, folder_path: str | None=None, top_k: int=20) -> DispatchResult

Grep across document content using pattern matching.

Source: lightbulb/client.py:4867

hr_live_advance_application

def hr_live_advance_application(application_id: str, *, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Advance a Greenhouse candidate to the next stage (HITL-gated).

Source: lightbulb/client.py:8729

hr_live_cases

def hr_live_cases(**filters: Any) -> Dict[str, Any]

HR case board items from Monday.com.

Source: lightbulb/client.py:8696

hr_live_health

def hr_live_health() -> Dict[str, Any]

Health check for HR connector tokens (BambooHR / Greenhouse / Monday).

Source: lightbulb/client.py:8755

hr_live_leave_balance

def hr_live_leave_balance(bamboo_employee_id: str) -> Dict[str, Any]

BambooHR leave balance for an employee.

Source: lightbulb/client.py:8676

hr_live_monday_onboarding_board

def hr_live_monday_onboarding_board(checklist_id: str) -> Dict[str, Any]

Monday.com board view for an HR onboarding checklist.

Source: lightbulb/client.py:8686

hr_live_recruiting_applications

def hr_live_recruiting_applications(**filters: Any) -> Dict[str, Any]

Greenhouse applications.

Source: lightbulb/client.py:8718

hr_live_recruiting_jobs

def hr_live_recruiting_jobs(**filters: Any) -> Dict[str, Any]

Greenhouse job listings.

Source: lightbulb/client.py:8707

hr_live_reject_application

def hr_live_reject_application(application_id: str, *, body: Dict[str, Any] | None=None) -> Dict[str, Any]

Reject a Greenhouse application (HITL-gated).

Source: lightbulb/client.py:8742

hr_live_whos_out

def hr_live_whos_out(**filters: Any) -> Dict[str, Any]

BambooHR who's-out roster (current and upcoming time-off).

Source: lightbulb/client.py:8665

ingest_sdk_project_event

def ingest_sdk_project_event(project_id: str, event: Dict[str, Any], *, company_id: str | None=None) -> Dict[str, Any]

Source: lightbulb/client.py:5768

inspect_project_creation_world_ready

def inspect_project_creation_world_ready(name: str, instructions: str='', *, participant_role: str='agent_worker', experience_lens: str='agent_protocol', play_style: str='guided_human_in_the_loop') -> dict[str, Any]

Inspect project-review readiness locally without network activity.

Source: lightbulb/client.py:4454

inspect_project_game_campaign

def inspect_project_game_campaign(*, project: dict[str, Any] | None=None, plan: dict[str, Any] | None=None, business_cockpit: dict[str, Any] | None=None) -> dict[str, Any]

Inspect the human/agent project campaign locally without network activity.

Source: lightbulb/client.py:3761

inspect_training_pair_input_custody

def inspect_training_pair_input_custody(installation_id: str, revision_id: str, *, project_id: str | None=None) -> Dict[str, Any]

Inspect exact-owner input custody without returning raw evidence.

Source: lightbulb/client.py:8445

inspect_training_pair_readiness

def inspect_training_pair_readiness(installation_id: str, revision_id: str, *, project_id: str | None=None) -> Dict[str, Any]

Inspect structured source, authority, stage, and lane readiness.

Source: lightbulb/client.py:8413

inspect_workflow_learning_candidate_attestation

def inspect_workflow_learning_candidate_attestation(delivery_id: str) -> Dict[str, Any]

Revalidate the exact candidate producer attestation using current keys.

Source: lightbulb/client.py:6303

install_marketplace_action

def install_marketplace_action(listing_id: str, revision_id: str, *, idempotency_key: str, deployment_targets: Sequence[str] | None=None) -> Dict[str, Any]

Install a pinned revision and bind its explicit agent targets.

Source: lightbulb/client.py:8234

invoke_marketplace_action

def invoke_marketplace_action(installation_id: str, inputs: Dict[str, Any] | None=None, *, idempotency_key: str, message: str='', objective: str='', dry_run: bool=True, preview_invocation_id: str | None=None, confirm_live: bool=False) -> Dict[str, Any]

Preview an installed action, or explicitly confirm an exact preview for live use.

Source: lightbulb/client.py:8340

invoke_tool

def invoke_tool(tool_name: str, arguments: Dict[str, Any], *, project_id: str | None=None, project_ref: str | None=None, connector_account_ref: str | None=None, idempotency_key: str | None=None, approval_ref: str | None=None, workflow_id: str | None=None, step_id: str | None=None, workflow_instance_id: str | None=None, workflow_step_generation: int | None=None, runtime_context: Dict[str, Any] | None=None, effect: str | None=None, _runtime_authority: Any=None) -> Dict[str, Any]

Invoke a platform tool by name (e.g. connector tools, utility tools).

Source: lightbulb/client.py:7045

it_ops_live_connector

def it_ops_live_connector(connector: str, **filters: Any) -> Dict[str, Any]

Pass-through to a live IT-Ops connector (jira | slack | github | notion).

Source: lightbulb/client.py:10032

it_ops_mcp_manifest

def it_ops_mcp_manifest() -> Dict[str, Any]

Get the IT-Ops workspace MCP manifest.

Source: lightbulb/client.py:10046

list_agent_runtime_options

def list_agent_runtime_options(agent_type: str | None=None) -> Dict[str, Any]

List coding-agent runtimes and Backbone host surfaces available to the account.

Source: lightbulb/client.py:3039

list_aoc_decisions

def list_aoc_decisions(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany decisions awaiting or post-resolution.

Source: lightbulb/client.py:9509

list_aoc_runs

def list_aoc_runs(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany cognitive-loop runs.

Source: lightbulb/client.py:9398

list_aoc_task_events

def list_aoc_task_events(task_id: str) -> List[Dict[str, Any]]

List events recorded against an AutoCompany task.

Source: lightbulb/client.py:9483

list_aoc_tasks

def list_aoc_tasks(**filters: Any) -> List[Dict[str, Any]]

List AutoCompany tasks.

Source: lightbulb/client.py:9451

list_aoc_ticks