Welcome
The Documents Open API allows developers to build applications connected with the Documents feature. You can use these APIs for following use cases:
- Build a fully customized website by yourself, embedding the articles and other resources managed from Channel Talk Documents.
- Export articles from Channel Talk Documents (HTML format is available for now)
- (TBD) Import external documents into Channel Talk Documents
Get Started
New to Documents?
Browse our Documents main website or our user guide for more information about this feature.
Documents allows you to manage articles and documents in your knowledge base, such as: user guide, blogs, release notes, and developer documentation.
- Step 1: Follow our guide to create a new space in your workspace.
- Step 2: Issue an API Key in the space settings. This key is used for authentication into our Open API. Refer to our user guide for details.
- Step 3: Build your app using the Documents Open API.
Documentation
For general information about the Documents feature, please refer to the user guide. For resources related to development or Open APIs, you may refer to this documentation.
REST API
Documents Open API is provided as REST APIs and accessible from https://document-api.channel.io.
| Category | Description |
|---|---|
| Versioning | The current version of REST API is v1, and the REST API is served under the path /open/v1. If breaking changes were to be made, future versions will be served from /open/v2, /open/v3, and so on. |
| Authentication | Basic authentication using the issued API Key. Refer to the Authentication page for details. |
| Rate Limiting | Clients using Documents REST API should follow the rate limiting constraints. By default, all requests to a space is throttled by 10 requests per second. Requests exceeding the rate limit will receive HTTP status 429 (Too Many Requests). |
| Format | All request and response data are formatted by JSON. |
| Errors | Appropriate HTTP status codes (4xx or 5xx) and error messages are available by HTTP response body. |
Inquiries
Please create an inquiry to our customer support for any questions.
Updated about 1 month ago