Documents
Read the API Overview to get started and learn more.
Create document
Create a new document.
POST
/
guilds
/
guildId
/
documents
Request body
| Field | Type | Description |
|---|---|---|
| project_id | string | Project to create the document in |
| title | string | Title of the document |
| content | string | Content of the document |
| topic_id (optional) | string | The topic the document should be placed in |
| in_bin (optional) | boolean | Whether the document should be in bin |
Response body
Returns a Document Entity
Returns a 200 status
Delete document
Delete a document
DELETE
/
guilds
/
guildId
/
documents
Request body -
Response body -
Returns a 204 status
Update document
Update the data of a document
PUT
/
guilds
/
guildId
/
documents
/
documentId
Request body
| Field | Type | Description |
|---|---|---|
| project_id (optional) | string | Project the document should be in |
| title (optional) | string | Title of the document |
| content (optional) | string | Content of the document |
| topic_id (optional) | string | The topic the document should be placed in |
| in_bin (optional) | boolean | Whether the document should be in bin |
Response body
Returns a Document Entity
Returns a 200 status
Get a single document
Returns the data of a single document.
GET
/
guilds
/
guildId
/
documents
/
documentId
Request body -
Response body
Returns a Document Entity
Returns a 200 status
Get documents
Returns the data of a multiple documents.
GET
/
guilds
/
guildId
/
documents
Query parameters
| Field | Type | Description |
|---|---|---|
| project_id (optional) | string | Returns only documents in this project. |
| limit (optional) | number | The max number of documents to return. Defaults to 100 |
Request body -
Response body
Returns a list of Document Entities
Returns a 200 status
Document Entity
| Field | Type | Description |
|---|---|---|
| id | string | The topic ID |
| title | string | Title of the document |
| content | string | The content of the document |
| topic_id (optional) | string | Id of the topic the document is in |
| in_bin | boolean | Whether the topic is in bin |
| delete_date (optional) | string | The deletion date of the topic |
