Official TypeScript/JavaScript SDK for FlowUs API - Create, manage, and interact with FlowUs pages, databases, and blocks
npm install flowus-api-sdkOfficial TypeScript/JavaScript SDK for the FlowUs API. Create, manage, and interact with FlowUs pages, databases, and blocks programmatically.
``bash`
npm install flowus-api-sdk
`typescript
import { DefaultApi, Configuration } from 'flowus-api-sdk';
// Initialize the API client
const config = new Configuration({
basePath: 'https://api.flowus.cn',
headers: {
'Authorization': 'Bearer YOUR_API_TOKEN'
}
});
const api = new DefaultApi(config);
// Create a new page
const newPage = await api.createPage({
parent: {
type: 'page_id',
page_id: 'parent-page-id'
},
properties: {
title: {
type: 'title',
title: [{
type: 'text',
text: { content: 'My New Page' }
}]
}
}
});
console.log('Created page:', newPage.id);
`
To use the FlowUs API, you need to obtain an API token:
1. Log in to your FlowUs account
2. Go to Settings → Integrations
3. Create a new integration and copy the token
4. Use the token in your API requests
- Create a new page
- updatePage() - Update an existing page
- queryDatabase() - Query a database$3
- getBlockChildren() - Get child blocks of a page/block
- appendBlockChildren() - Add child blocks to a page/block
- updateBlock() - Update a block
- deleteBlock() - Delete a block$3
- createDatabase() - Create a new database
- updateDatabase() - Update database properties$3
- search() - Search for pages and databasesTypeScript Support
This SDK is written in TypeScript and includes full type definitions for all API methods and response objects.
`typescript
import { Block, Page, Database } from 'flowus-api-sdk';// All types are fully typed
const page: Page = await api.getPage('page-id');
const blocks: Block[] = await api.getBlockChildren('block-id');
`Error Handling
typescript
try {
const page = await api.createPage(pageData);
console.log('Page created successfully');
} catch (error) {
if (error.status === 401) {
console.error('Invalid API token');
} else if (error.status === 404) {
console.error('Resource not found');
} else {
console.error('API error:', error.message);
}
}
``Check out the examples directory for complete usage examples including:
- Creating and managing pages
- Working with databases
- Adding and updating blocks
- Searching content
For detailed API documentation, visit: FlowUs API Documentation
We welcome contributions! Please see our Contributing Guide for details.
This project is licensed under the MIT License - see the LICENSE file for details.
- 📧 Email: support@flowus.cn
- 📚 Documentation: https://flowus.cn/share/df7cd54f-1c21-4fc1-9fd8-ce81be1918a5
- 🐛 Issues: https://github.com/next-space/flowus-api-sdk/issues