{"id":20471305,"url":"https://github.com/flowiseai/flowisesdk","last_synced_at":"2025-07-21T04:07:57.346Z","repository":{"id":255778740,"uuid":"852536589","full_name":"FlowiseAI/FlowiseSDK","owner":"FlowiseAI","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-23T12:44:24.000Z","size":11,"stargazers_count":13,"open_issues_count":2,"forks_count":13,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-19T05:45:39.047Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FlowiseAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-05T01:23:02.000Z","updated_at":"2025-06-02T15:35:58.000Z","dependencies_parsed_at":"2024-09-07T04:16:47.724Z","dependency_job_id":"f75fa304-8058-42b5-95bb-7f04bcb04744","html_url":"https://github.com/FlowiseAI/FlowiseSDK","commit_stats":null,"previous_names":["flowiseai/flowisesdk"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/FlowiseAI/FlowiseSDK","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlowiseAI%2FFlowiseSDK","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlowiseAI%2FFlowiseSDK/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlowiseAI%2FFlowiseSDK/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlowiseAI%2FFlowiseSDK/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlowiseAI","download_url":"https://codeload.github.com/FlowiseAI/FlowiseSDK/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlowiseAI%2FFlowiseSDK/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266236930,"owners_count":23897289,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T14:15:44.821Z","updated_at":"2025-07-21T04:07:57.319Z","avatar_url":"https://github.com/FlowiseAI.png","language":"TypeScript","readme":"# Flowise SDK\n\nA TypeScript SDK for interacting with the Flowise API.\n\n## Installation\n\n```bash\nnpm install flowise-sdk\n```\n\n## Usage\n\n```typescript\nimport { FlowiseClient } from 'flowise-sdk';\n\nconst flowise = new FlowiseClient({ baseUrl: 'http://localhost:3000' });\n\nasync function main() {\n  const completion = await flowise.createPrediction({\n    chatflowId: '\u003cid\u003e',\n    question: \"hello\",\n    streaming: true\n  });\n\n  for await (const chunk of completion) {\n    console.log(chunk);\n  }\n}\n\nmain();\n```\n\n## API Reference\n\n### `FlowiseClient`\n\nThe main class for interacting with the Flowise API.\n\n#### Constructor\n\n```typescript\nnew FlowiseClient(baseUrl?: \u003cyour-base-url\u003e, apiKey: \u003cchatflow-apikey\u003e)\n```\n\n- `baseUrl`: Optional. The base URL for the Flowise API. Defaults to 'http://localhost:3000'\n- `apiKey`: Optional. The API Key used to access the chatflow\n\n#### Methods\n\n##### `createPrediction(params: PredictionParams)`\n\nCreates a new prediction.\n\n- `params`: An object containing the following properties:\n  - `chatflowId`: string - Chatflow ID to execute prediction\n  - `question`: string - The question to ask.\n  - `streaming`: boolean (optional) - Whether to stream the response.\n  - `chatId`: string (optional) - Chat ID of the session\n  - `overrideConfig`: object (optional) - Override configuration\n  - `history`: array (optional) - Array of prepended messages\n\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowiseai%2Fflowisesdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflowiseai%2Fflowisesdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflowiseai%2Fflowisesdk/lists"}