> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowra.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# SDK method examples
> Copy-paste TypeScript and Python examples for every Flowra SDK facade method.
Examples for **every** product-facade method on [`@flowra/sdk`](https://www.npmjs.com/package/@flowra/sdk) and `flowra` ([`flowra-sdk` on PyPI](https://pypi.org/project/flowra-sdk/)). Bodies use placeholders — full schemas: [API reference](/api-reference). Method map: [SDK namespaces](/guides/sdk-namespaces). Source: [github.com/flowradev/sdk](https://github.com/flowradev/sdk).
Assume a client is already constructed:
```ts theme={null}
import { Flowra } from '@flowra/sdk';
const flowra = new Flowra({ apiKey: process.env.FLOWRA_API_KEY! });
```
```python theme={null}
from flowra import Flowra
flowra = Flowra(api_key="YOUR_API_KEY")
```
Ids like `toolId`, `workflowId`, and `threadId` are placeholders from list/create responses. Chat threads use `thread_id` (snake\_case) from Graphify.
## Root
### `getProfile` / `get_profile`
```ts theme={null}
const result = await flowra.getProfile();
```
```python theme={null}
result = flowra.get_profile()
```
### `asUser` / `as_user`
Returns a scoped client.
```ts theme={null}
const alice = flowra.asUser('customer_alice');
```
```python theme={null}
alice = flowra.as_user('customer_alice')
```
### `flowra.raw` (example)
Escape hatch.
```ts theme={null}
const result = await flowra.raw.toolsControllerGetTools({ client: flowra.client, query: { limit: 5 } });
```
```python theme={null}
result = flowra.request('GET', '/api/v1/tools', query={'limit': 5})
```
## `tools`
### `list`
```ts theme={null}
const result = await flowra.tools.list({ limit: 10, toolkitSlug: 'slack' });
```
```python theme={null}
result = flowra.tools.list(limit=10, toolkitSlug='slack')
```
### `get`
```ts theme={null}
const result = await flowra.tools.get(toolId);
```
```python theme={null}
result = flowra.tools.get(tool_id)
```
### `create`
```ts theme={null}
const result = await flowra.tools.create({ /* CreateToolDto */ });
```
```python theme={null}
result = flowra.tools.create({...})
```
### `update`
```ts theme={null}
const result = await flowra.tools.update(toolId, { /* patch */ });
```
```python theme={null}
result = flowra.tools.update(tool_id, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.tools.remove(toolId);
```
```python theme={null}
result = flowra.tools.remove(tool_id)
```
### `setActive`
```ts theme={null}
const result = await flowra.tools.setActive(toolId);
```
```python theme={null}
result = flowra.tools.set_active(tool_id)
```
### `execute`
```ts theme={null}
const result = await flowra.tools.execute('SLACK_SEND_MESSAGE', { arguments: { /* ... */ } });
```
```python theme={null}
result = flowra.tools.execute('SLACK_SEND_MESSAGE', {'arguments': {}})
```
### `executionLogs`
```ts theme={null}
const result = await flowra.tools.executionLogs({ limit: 20 });
```
```python theme={null}
result = flowra.tools.execution_logs(limit=20)
```
## `toolkits`
### `list`
```ts theme={null}
const result = await flowra.toolkits.list({ limit: 20 });
```
```python theme={null}
result = flowra.toolkits.list(limit=20)
```
### `listWithTools`
```ts theme={null}
const result = await flowra.toolkits.listWithTools({ q: 'gmail' });
```
```python theme={null}
result = flowra.toolkits.list_with_tools(q='gmail')
```
### `get`
```ts theme={null}
const result = await flowra.toolkits.get(toolkitId);
```
```python theme={null}
result = flowra.toolkits.get(toolkit_id)
```
### `create`
```ts theme={null}
const result = await flowra.toolkits.create({ /* CreateToolkitDto */ });
```
```python theme={null}
result = flowra.toolkits.create({...})
```
### `update`
```ts theme={null}
const result = await flowra.toolkits.update(toolkitId, { /* patch */ });
```
```python theme={null}
result = flowra.toolkits.update(toolkit_id, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.toolkits.remove(toolkitId);
```
```python theme={null}
result = flowra.toolkits.remove(toolkit_id)
```
### `setActive`
```ts theme={null}
const result = await flowra.toolkits.setActive(toolkitId);
```
```python theme={null}
result = flowra.toolkits.set_active(toolkit_id)
```
### `messagingChannels`
```ts theme={null}
const result = await flowra.toolkits.messagingChannels();
```
```python theme={null}
result = flowra.toolkits.messaging_channels()
```
### `listCategories`
```ts theme={null}
const result = await flowra.toolkits.listCategories();
```
```python theme={null}
result = flowra.toolkits.list_categories()
```
## `skills`
### `list`
```ts theme={null}
const result = await flowra.skills.list({ limit: 20 });
```
```python theme={null}
result = flowra.skills.list(limit=20)
```
### `get`
```ts theme={null}
const result = await flowra.skills.get(skillId);
```
```python theme={null}
result = flowra.skills.get(skill_id)
```
### `create`
```ts theme={null}
const result = await flowra.skills.create({ /* CreateSkillDto */ });
```
```python theme={null}
result = flowra.skills.create({...})
```
### `update`
```ts theme={null}
const result = await flowra.skills.update(skillId, { /* UpdateSkillDto */ });
```
```python theme={null}
result = flowra.skills.update(skill_id, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.skills.remove(skillId);
```
```python theme={null}
result = flowra.skills.remove(skill_id)
```
### `addToLibrary`
```ts theme={null}
const result = await flowra.skills.addToLibrary(skillId);
```
```python theme={null}
result = flowra.skills.add_to_library(skill_id)
```
### `catalogBrowse`
```ts theme={null}
const result = await flowra.skills.catalogBrowse({ limit: 20 });
```
```python theme={null}
result = flowra.skills.catalog_browse(limit=20)
```
### `importGithub`
```ts theme={null}
const result = await flowra.skills.importGithub({ /* ImportGithub body */ });
```
```python theme={null}
result = flowra.skills.import_github({...})
```
### `registryInstall`
```ts theme={null}
const result = await flowra.skills.registryInstall({ /* RegistryInstall body */ });
```
```python theme={null}
result = flowra.skills.registry_install({...})
```
### `registryList`
```ts theme={null}
const result = await flowra.skills.registryList({ limit: 20 });
```
```python theme={null}
result = flowra.skills.registry_list(limit=20)
```
### `registrySearch`
```ts theme={null}
const result = await flowra.skills.registrySearch({ q: 'pdf' });
```
```python theme={null}
result = flowra.skills.registry_search(q='pdf')
```
## `workflows`
### `list`
```ts theme={null}
const result = await flowra.workflows.list({ limit: 10 });
```
```python theme={null}
result = flowra.workflows.list(limit=10)
```
### `get`
```ts theme={null}
const result = await flowra.workflows.get(workflowId);
```
```python theme={null}
result = flowra.workflows.get(workflow_id)
```
### `create`
```ts theme={null}
const result = await flowra.workflows.create({ /* CreateAgentDto */ });
```
```python theme={null}
result = flowra.workflows.create({...})
```
### `update`
```ts theme={null}
const result = await flowra.workflows.update(workflowId, { /* patch */ });
```
```python theme={null}
result = flowra.workflows.update(workflow_id, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.workflows.remove(workflowId);
```
```python theme={null}
result = flowra.workflows.remove(workflow_id)
```
### `setActive`
```ts theme={null}
const result = await flowra.workflows.setActive(workflowId, { activeStatus: true });
```
```python theme={null}
result = flowra.workflows.set_active(workflow_id, True)
```
### `run`
```ts theme={null}
const result = await flowra.workflows.run(workflowId, { input: { message: 'hi' } });
```
```python theme={null}
result = flowra.workflows.run(workflow_id, {'input': {'message': 'hi'}})
```
### `status`
```ts theme={null}
const result = await flowra.workflows.status(threadId);
```
```python theme={null}
result = flowra.workflows.status(thread_id)
```
### `resume`
```ts theme={null}
const result = await flowra.workflows.resume(threadId, { resumeValue: { approved: true } });
```
```python theme={null}
result = flowra.workflows.resume(thread_id, {'resumeValue': {'approved': True}})
```
### `executions`
```ts theme={null}
const result = await flowra.workflows.executions({ limit: 20 });
```
```python theme={null}
result = flowra.workflows.executions(limit=20)
```
### `execution`
```ts theme={null}
const result = await flowra.workflows.execution(executionId);
```
```python theme={null}
result = flowra.workflows.execution(execution_id)
```
### `statistics`
```ts theme={null}
const result = await flowra.workflows.statistics(workflowId);
```
```python theme={null}
result = flowra.workflows.statistics(workflow_id)
```
### `executionsFor`
```ts theme={null}
const result = await flowra.workflows.executionsFor(workflowId, { limit: 20 });
```
```python theme={null}
result = flowra.workflows.executions_for(workflow_id, limit=20)
```
### `addConnection`
```ts theme={null}
const result = await flowra.workflows.addConnection({ /* body */ });
```
```python theme={null}
result = flowra.workflows.add_connection({...})
```
### `changeConnection`
```ts theme={null}
const result = await flowra.workflows.changeConnection(workflowId, { /* body */ });
```
```python theme={null}
result = flowra.workflows.change_connection(workflow_id, {...})
```
### `setAuthConfig`
```ts theme={null}
const result = await flowra.workflows.setAuthConfig(workflowId, { /* body */ });
```
```python theme={null}
result = flowra.workflows.set_auth_config(workflow_id, {...})
```
### `clearAuthConfig`
```ts theme={null}
const result = await flowra.workflows.clearAuthConfig(workflowId, { /* body */ });
```
```python theme={null}
result = flowra.workflows.clear_auth_config(workflow_id, {...})
```
### `clearConnection`
```ts theme={null}
const result = await flowra.workflows.clearConnection(workflowId, { /* body */ });
```
```python theme={null}
result = flowra.workflows.clear_connection(workflow_id, {...})
```
## `connections`
### `list`
```ts theme={null}
const result = await flowra.connections.list();
```
```python theme={null}
result = flowra.connections.list()
```
### `listGrouped`
```ts theme={null}
const result = await flowra.connections.listGrouped();
```
```python theme={null}
result = flowra.connections.list_grouped()
```
### `create`
```ts theme={null}
const result = await flowra.connections.create({ /* body */ });
```
```python theme={null}
result = flowra.connections.create({...})
```
### `createLink`
```ts theme={null}
const result = await flowra.connections.createLink({ toolkitSlug: 'slack', authConfigId });
```
```python theme={null}
result = flowra.connections.create_link({'toolkitSlug': 'slack', 'authConfigId': auth_config_id})
```
### `update`
```ts theme={null}
const result = await flowra.connections.update(connectionId, { /* patch */ });
```
```python theme={null}
result = flowra.connections.update(connection_id, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.connections.remove(connectionId);
```
```python theme={null}
result = flowra.connections.remove(connection_id)
```
## `authConfigs` / `auth_configs`
### `list`
```ts theme={null}
const result = await flowra.authConfigs.list({ toolkitSlug: 'slack' });
```
```python theme={null}
result = flowra.auth_configs.list(toolkitSlug='slack')
```
### `get`
```ts theme={null}
const result = await flowra.authConfigs.get(authConfigId);
```
```python theme={null}
result = flowra.auth_configs.get(auth_config_id)
```
### `create`
```ts theme={null}
const result = await flowra.authConfigs.create({ /* CreateAuthConfigDto */ });
```
```python theme={null}
result = flowra.auth_configs.create({...})
```
### `remove`
```ts theme={null}
const result = await flowra.authConfigs.remove(authConfigId);
```
```python theme={null}
result = flowra.auth_configs.remove(auth_config_id)
```
## `users`
### `list`
```ts theme={null}
const result = await flowra.users.list();
```
```python theme={null}
result = flowra.users.list()
```
### `create`
```ts theme={null}
const result = await flowra.users.create({ username: 'customer_alice' });
```
```python theme={null}
result = flowra.users.create({'username': 'customer_alice'})
```
### `getByUsername`
```ts theme={null}
const result = await flowra.users.getByUsername('customer_alice');
```
```python theme={null}
result = flowra.users.get_by_username('customer_alice')
```
### `toggleActive`
```ts theme={null}
const result = await flowra.users.toggleActive(userId);
```
```python theme={null}
result = flowra.users.toggle_active(user_id)
```
### `refreshAvatar`
```ts theme={null}
const result = await flowra.users.refreshAvatar(userId);
```
```python theme={null}
result = flowra.users.refresh_avatar(user_id)
```
## `triggers`
### `list`
```ts theme={null}
const result = await flowra.triggers.list();
```
```python theme={null}
result = flowra.triggers.list()
```
### `upsert`
```ts theme={null}
const result = await flowra.triggers.upsert(slug, { /* UpsertTriggerInstanceDto */ });
```
```python theme={null}
result = flowra.triggers.upsert(slug, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.triggers.remove(triggerId);
```
```python theme={null}
result = flowra.triggers.remove(trigger_id)
```
### `setStatus`
```ts theme={null}
const result = await flowra.triggers.setStatus(triggerId);
```
```python theme={null}
result = flowra.triggers.set_status(trigger_id)
```
### `invocationLogs`
```ts theme={null}
const result = await flowra.triggers.invocationLogs({ limit: 20 });
```
```python theme={null}
result = flowra.triggers.invocation_logs(limit=20)
```
### `replayWebhook`
```ts theme={null}
const result = await flowra.triggers.replayWebhook(logId);
```
```python theme={null}
result = flowra.triggers.replay_webhook(log_id)
```
## `chat`
### `createThread`
```ts theme={null}
const result = await flowra.chat.createThread({ metadata: { ticketId: 'T-1' } });
```
```python theme={null}
result = flowra.chat.create_thread({'metadata': {'ticketId': 'T-1'}})
```
### `getThread`
```ts theme={null}
const result = await flowra.chat.getThread(threadId);
```
```python theme={null}
result = flowra.chat.get_thread(thread_id)
```
### `updateThread`
```ts theme={null}
const result = await flowra.chat.updateThread(threadId, { metadata: { title: 'Support' } });
```
```python theme={null}
result = flowra.chat.update_thread(thread_id, {'metadata': {'title': 'Support'}})
```
### `deleteThread`
```ts theme={null}
const result = await flowra.chat.deleteThread(threadId);
```
```python theme={null}
result = flowra.chat.delete_thread(thread_id)
```
### `searchThreads`
```ts theme={null}
const result = await flowra.chat.searchThreads({ /* SearchThreadsDto */ });
```
```python theme={null}
result = flowra.chat.search_threads({...})
```
### `history`
```ts theme={null}
const result = await flowra.chat.history(threadId, {});
```
```python theme={null}
result = flowra.chat.history(thread_id, {})
```
### `state`
```ts theme={null}
const result = await flowra.chat.state(threadId);
```
```python theme={null}
result = flowra.chat.state(thread_id)
```
### `stream`
```ts theme={null}
const result = await flowra.chat.stream(threadId, { input: { messages: [{ role: 'user', content: 'Hi' }] } });
```
```python theme={null}
result = flowra.chat.stream(thread_id, {'input': {'messages': [{'role': 'user', 'content': 'Hi'}]}}, as_events=True)
```
### `listRuns`
```ts theme={null}
const result = await flowra.chat.listRuns(threadId);
```
```python theme={null}
result = flowra.chat.list_runs(thread_id)
```
### `cancelRun`
```ts theme={null}
const result = await flowra.chat.cancelRun(threadId, runId);
```
```python theme={null}
result = flowra.chat.cancel_run(thread_id, run_id)
```
### `generateTitle`
```ts theme={null}
const result = await flowra.chat.generateTitle(threadId);
```
```python theme={null}
result = flowra.chat.generate_title(thread_id)
```
### `sendOperatorReply`
```ts theme={null}
const result = await flowra.chat.sendOperatorReply(threadId, { /* body */ });
```
```python theme={null}
result = flowra.chat.send_operator_reply(thread_id, {...})
```
### `setReplyMode`
```ts theme={null}
const result = await flowra.chat.setReplyMode(threadId, { /* body */ });
```
```python theme={null}
result = flowra.chat.set_reply_mode(thread_id, {...})
```
### `joinStream`
```ts theme={null}
const result = await flowra.chat.joinStream(threadId, runId);
```
```python theme={null}
result = flowra.chat.join_stream(thread_id, run_id, as_events=True)
```
## `files`
### `list`
```ts theme={null}
const result = await flowra.files.list({ limit: 20 });
```
```python theme={null}
result = flowra.files.list(limit=20)
```
### `upload`
TS: multipart body for generated client; PY: path, bytes, or file object.
```ts theme={null}
const result = await flowra.files.upload('document', formDataBody as never);
```
```python theme={null}
result = flowra.files.upload('document', '/path/to/file.pdf')
```
### `remove`
```ts theme={null}
const result = await flowra.files.remove(fileId);
```
```python theme={null}
result = flowra.files.remove(file_id)
```
### `download`
Returns file bytes / content.
```ts theme={null}
const result = await flowra.files.download(fileId);
```
```python theme={null}
result = flowra.files.download(file_id)
```
### `storageBreakdown`
```ts theme={null}
const result = await flowra.files.storageBreakdown();
```
```python theme={null}
result = flowra.files.storage_breakdown()
```
### `serveByFilename`
```ts theme={null}
const result = await flowra.files.serveByFilename(filename);
```
```python theme={null}
result = flowra.files.serve_by_filename(filename)
```
### `deleteMany`
```ts theme={null}
const result = await flowra.files.deleteMany({ /* body */ });
```
```python theme={null}
result = flowra.files.delete_many({...})
```
### `fileType`
```ts theme={null}
const result = await flowra.files.fileType(fileType);
```
```python theme={null}
result = flowra.files.file_type(file_type)
```
### `fileTypes`
```ts theme={null}
const result = await flowra.files.fileTypes();
```
```python theme={null}
result = flowra.files.file_types()
```
### `pruneOldest`
```ts theme={null}
const result = await flowra.files.pruneOldest({ /* body */ });
```
```python theme={null}
result = flowra.files.prune_oldest({...})
```
## `knowledge`
### `list`
```ts theme={null}
const result = await flowra.knowledge.list();
```
```python theme={null}
result = flowra.knowledge.list()
```
### `create`
```ts theme={null}
const result = await flowra.knowledge.create({ name: 'Help center' });
```
```python theme={null}
result = flowra.knowledge.create({'name': 'Help center'})
```
### `get`
```ts theme={null}
const result = await flowra.knowledge.get(collectionId);
```
```python theme={null}
result = flowra.knowledge.get(collection_id)
```
### `rename`
```ts theme={null}
const result = await flowra.knowledge.rename(collectionId, { name: 'Support FAQ' });
```
```python theme={null}
result = flowra.knowledge.rename(collection_id, {'name': 'Support FAQ'})
```
### `remove`
```ts theme={null}
const result = await flowra.knowledge.remove(collectionId);
```
```python theme={null}
result = flowra.knowledge.remove(collection_id)
```
### `chunks`
```ts theme={null}
const result = await flowra.knowledge.chunks(collectionId, { limit: 20 });
```
```python theme={null}
result = flowra.knowledge.chunks(collection_id, limit=20)
```
### `sources`
```ts theme={null}
const result = await flowra.knowledge.sources(collectionId);
```
```python theme={null}
result = flowra.knowledge.sources(collection_id)
```
### `deleteSource`
```ts theme={null}
const result = await flowra.knowledge.deleteSource(collectionId, { /* body */ });
```
```python theme={null}
result = flowra.knowledge.delete_source(collection_id, {...})
```
### `ingestFile`
```ts theme={null}
const result = await flowra.knowledge.ingestFile(collectionId, { /* body */ });
```
```python theme={null}
result = flowra.knowledge.ingest_file(collection_id, {...})
```
### `ingestText`
```ts theme={null}
const result = await flowra.knowledge.ingestText(collectionId, { /* body */ });
```
```python theme={null}
result = flowra.knowledge.ingest_text(collection_id, {...})
```
### `ingestUrl`
```ts theme={null}
const result = await flowra.knowledge.ingestUrl(collectionId, { url: 'https://docs.yoursite.com/faq' });
```
```python theme={null}
result = flowra.knowledge.ingest_url(collection_id, {'url': 'https://docs.yoursite.com/faq'})
```
### `search`
```ts theme={null}
const result = await flowra.knowledge.search(collectionId, { query: 'refund policy' });
```
```python theme={null}
result = flowra.knowledge.search(collection_id, {'query': 'refund policy'})
```
### `setExposeViaMcp`
```ts theme={null}
const result = await flowra.knowledge.setExposeViaMcp(collectionId, { /* body */ });
```
```python theme={null}
result = flowra.knowledge.set_expose_via_mcp(collection_id, {...})
```
## `database`
### `list`
```ts theme={null}
const result = await flowra.database.list();
```
```python theme={null}
result = flowra.database.list()
```
### `get`
```ts theme={null}
const result = await flowra.database.get(collectionId);
```
```python theme={null}
result = flowra.database.get(collection_id)
```
### `remove`
```ts theme={null}
const result = await flowra.database.remove(collectionId);
```
```python theme={null}
result = flowra.database.remove(collection_id)
```
### `documents`
```ts theme={null}
const result = await flowra.database.documents(collectionId, { limit: 50 });
```
```python theme={null}
result = flowra.database.documents(collection_id, limit=50)
```
### `createDocument`
```ts theme={null}
const result = await flowra.database.createDocument(collectionId, { /* fields */ });
```
```python theme={null}
result = flowra.database.create_document(collection_id, {...})
```
### `updateDocument`
```ts theme={null}
const result = await flowra.database.updateDocument(collectionId, documentId, { /* fields */ });
```
```python theme={null}
result = flowra.database.update_document(collection_id, document_id, {...})
```
### `deleteDocument`
```ts theme={null}
const result = await flowra.database.deleteDocument(collectionId, documentId);
```
```python theme={null}
result = flowra.database.delete_document(collection_id, document_id)
```
### `setExposeViaMcp`
```ts theme={null}
const result = await flowra.database.setExposeViaMcp(collectionId, { /* body */ });
```
```python theme={null}
result = flowra.database.set_expose_via_mcp(collection_id, {...})
```
## `sandbox`
### `runEphemeral`
```ts theme={null}
const result = await flowra.sandbox.runEphemeral({ language: 'javascript', source: 'return 1 + 1;' });
```
```python theme={null}
result = flowra.sandbox.run_ephemeral({'language': 'javascript', 'source': 'return 1 + 1;'})
```
### `createSession`
```ts theme={null}
const result = await flowra.sandbox.createSession({});
```
```python theme={null}
result = flowra.sandbox.create_session({})
```
### `getSession`
```ts theme={null}
const result = await flowra.sandbox.getSession(sessionId);
```
```python theme={null}
result = flowra.sandbox.get_session(session_id)
```
### `execute`
```ts theme={null}
const result = await flowra.sandbox.execute(sessionId, { language: 'python', source: 'print(2)' });
```
```python theme={null}
result = flowra.sandbox.execute(session_id, {'language': 'python', 'source': 'print(2)'})
```
### `releaseSession`
```ts theme={null}
const result = await flowra.sandbox.releaseSession(sessionId);
```
```python theme={null}
result = flowra.sandbox.release_session(session_id)
```
### `startThreadComputer`
```ts theme={null}
const result = await flowra.sandbox.startThreadComputer(threadId);
```
```python theme={null}
result = flowra.sandbox.start_thread_computer(thread_id)
```
### `getThreadComputer`
```ts theme={null}
const result = await flowra.sandbox.getThreadComputer(threadId);
```
```python theme={null}
result = flowra.sandbox.get_thread_computer(thread_id)
```
### `releaseThreadComputer`
```ts theme={null}
const result = await flowra.sandbox.releaseThreadComputer(threadId);
```
```python theme={null}
result = flowra.sandbox.release_thread_computer(thread_id)
```
## `mcp`
### `list`
```ts theme={null}
const result = await flowra.mcp.list();
```
```python theme={null}
result = flowra.mcp.list()
```
### `get`
```ts theme={null}
const result = await flowra.mcp.get(serverId);
```
```python theme={null}
result = flowra.mcp.get(server_id)
```
### `create`
```ts theme={null}
const result = await flowra.mcp.create({ /* CreateMcpServerDto */ });
```
```python theme={null}
result = flowra.mcp.create({...})
```
### `update`
```ts theme={null}
const result = await flowra.mcp.update(serverId, { /* patch */ });
```
```python theme={null}
result = flowra.mcp.update(server_id, {...})
```
### `remove`
```ts theme={null}
const result = await flowra.mcp.remove(serverId);
```
```python theme={null}
result = flowra.mcp.remove(server_id)
```
### `config`
```ts theme={null}
const result = await flowra.mcp.config(serverId);
```
```python theme={null}
result = flowra.mcp.config(server_id)
```
### `setAuthConfig`
```ts theme={null}
const result = await flowra.mcp.setAuthConfig(serverId, { toolkitSlug: 'gmail', authConfigId });
```
```python theme={null}
result = flowra.mcp.set_auth_config(server_id, {'toolkitSlug': 'gmail', 'authConfigId': auth_config_id})
```
### `clearAuthConfig`
```ts theme={null}
const result = await flowra.mcp.clearAuthConfig(serverId, { toolkitSlug: 'gmail' });
```
```python theme={null}
result = flowra.mcp.clear_auth_config(server_id, {'toolkitSlug': 'gmail'})
```
### `hostedSse`
```ts theme={null}
const result = await flowra.mcp.hostedSse();
```
```python theme={null}
result = flowra.mcp.hosted_sse()
```
### `hostedPost`
```ts theme={null}
const result = await flowra.mcp.hostedPost({ /* MCP JSON-RPC body */ });
```
```python theme={null}
result = flowra.mcp.hosted_post({...})
```
### `handleSse`
```ts theme={null}
const result = await flowra.mcp.handleSse(serverId);
```
```python theme={null}
result = flowra.mcp.handle_sse(server_id)
```
### `handlePost`
```ts theme={null}
const result = await flowra.mcp.handlePost(serverId, { /* MCP JSON-RPC body */ });
```
```python theme={null}
result = flowra.mcp.handle_post(server_id, {...})
```
## `llm`
### `models`
```ts theme={null}
const result = await flowra.llm.models();
```
```python theme={null}
result = flowra.llm.models()
```
### `chat`
```ts theme={null}
const result = await flowra.llm.chat({ messages: [{ role: 'user', content: 'Hello' }] });
```
```python theme={null}
result = flowra.llm.chat({'messages': [{'role': 'user', 'content': 'Hello'}]})
```
### `generate`
```ts theme={null}
const result = await flowra.llm.generate({ /* GenerateDto */ });
```
```python theme={null}
result = flowra.llm.generate({...})
```
## `browser`
### `status`
```ts theme={null}
const result = await flowra.browser.status(sessionId);
```
```python theme={null}
result = flowra.browser.status(session_id)
```
### `touch`
```ts theme={null}
const result = await flowra.browser.touch(sessionId);
```
```python theme={null}
result = flowra.browser.touch(session_id)
```
### `close`
```ts theme={null}
const result = await flowra.browser.close(sessionId);
```
```python theme={null}
result = flowra.browser.close(session_id)
```
### `view`
```ts theme={null}
const result = await flowra.browser.view(sessionId, { /* query */ });
```
```python theme={null}
result = flowra.browser.view(session_id)
```
### `completeConnection`
```ts theme={null}
const result = await flowra.browser.completeConnection(sessionId);
```
```python theme={null}
result = flowra.browser.complete_connection(session_id)
```
## `usage`
### `list`
```ts theme={null}
const result = await flowra.usage.list({ threadId });
```
```python theme={null}
result = flowra.usage.list(threadId=thread_id)
```
### `balance`
```ts theme={null}
const result = await flowra.usage.balance();
```
```python theme={null}
result = flowra.usage.balance()
```
### `forExecution`
```ts theme={null}
const result = await flowra.usage.forExecution(executionId);
```
```python theme={null}
result = flowra.usage.for_execution(execution_id)
```
## Related
* [SDKs](/guides/sdk)
* [TypeScript SDK](/guides/sdk-typescript)
* [Python SDK](/guides/sdk-python)
* [SDK namespaces](/guides/sdk-namespaces)
* [Chat streaming](/guides/sdk-chat-streaming)
* [Usage and credits](/guides/usage-and-credits)
* [API reference](/api-reference)