Discourse API Documentation: This page contains the documentation on how to use Discourse through API calls.
Note: For any endpoints not listed you can follow the reverse engineer the Discourse API guide to figure out how to use an API endpoint.
The Content-Type for POST and PUT requests can be set to application/x-www-form-urlencoded
,
multipart/form-data
, or application/json
.
Most API endpoints provide the same content as their HTML counterparts. For example
the URL /categories
serves a list of categories, the /categories.json
API provides the
same information in JSON format.
Instead of sending API requests to /categories.json
you may also send them to /categories
and add an Accept: application/json
header to the request to get the JSON response.
Sending requests with the Accept
header is necessary if you want to use URLs
for related endpoints returned by the API, such as pagination URLs.
These URLs are returned without the .json
prefix so you need to add the header in
order to get the correct response format.
Some endpoints do not require any authentication, pretty much anything else will require you to be authenticated.
To become authenticated you will need to create an API Key from the admin panel.
Once you have your API Key you can pass it in along with your API Username as an HTTP header like this:
curl -X GET "http://127.0.0.1:3000/admin/users/list/active.json" \
-H "Api-Key: 714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19" \
-H "Api-Username: system"
and this is how POST requests will look:
curl -X POST "http://127.0.0.1:3000/categories" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: 714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19" \
-H "Api-Username: system" \
-F "name=89853c20-4409-e91a-a8ea-f6cdff96aaaa" \
-F "color=49d9e9" \
-F "text_color=f0fcfd"
If an endpoint accepts a boolean be sure to specify it as a lowercase
true
or false
value unless noted otherwise.
- SDK Installation
- Requirements
- SDK Example Usage
- Available Resources and Operations
- Standalone functions
- File uploads
- Retries
- Error Handling
- Server Selection
- Custom HTTP Client
- Debugging
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @lukehagar/discoursejs
pnpm add @lukehagar/discoursejs
bun add @lukehagar/discoursejs
yarn add @lukehagar/discoursejs zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK();
async function run() {
const result = await sdk.backups.createBackup();
// Handle the result
console.log(result);
}
run();
Available methods
- activateUser - Activate a user
- adminGetUser - Get a user by id
- adminListUsers - Get a list of users
- anonymizeUser - Anonymize a user
- deactivateUser - Deactivate a user
- deleteUser - Delete a user
- logOutUser - Log a user out
- refreshGravatar - Refresh gravatar
- silenceUser - Silence a user
- suspendUser - Suspend a user
- createBackup - Create backup
- downloadBackup - Download backup
- getBackups - List backups
- sendDownloadBackupEmail - Send download backup email
- adminListBadges - List badges
- createBadge - Create badge
- deleteBadge - Delete badge
- listUserBadges - List badges for a user
- updateBadge - Update badge
- createCategory - Creates a category
- getCategory - Show category
- getSite - Get site info
- listCategories - Retrieves a list of categories
- listCategoryTopics - List topics
- updateCategory - Updates a category
- addGroupMembers - Add group members
- createGroup - Create a group
- deleteGroup - Delete a group
- getGroup - Get a group
- listGroupMembers - List group members
- listGroups - List groups
- removeGroupMembers - Remove group members
- updateGroup - Update a group
- createInvite - Create an invite
- inviteToTopic - Invite to topic
- getNotifications - Get the notifications that belong to the current user
- markNotificationsAsRead - Mark notifications as read
- createTopicPostPM - Creates a new topic, a new post, or a private message
- deletePost - delete a single post
- getPost - Retrieve a single post
- listPosts - List latest posts across topics
- lockPost - Lock a post from being edited
- performPostAction - Like a post and other actions
- postReplies - List replies to a post
- updatePost - Update a single post
- createTopicPostPM - Creates a new topic, a new post, or a private message
- getUserSentPrivateMessages - Get a list of private messages sent for a user
- listUserPrivateMessages - Get a list of private messages for a user
- search - Search for a term
- getSite - Get site info
- createTagGroup - Creates a tag group
- getTag - Get a specific tag
- getTagGroup - Get a single tag group
- listTagGroups - Get a list of tag groups
- listTags - Get a list of tags
- updateTagGroup - Update tag group
- bookmarkTopic - Bookmark topic
- createTopicPostPM - Creates a new topic, a new post, or a private message
- createTopicTimer - Create topic timer
- getTopic - Get a single topic
- getTopicByExternalId - Get topic by external_id
- inviteToTopic - Invite to topic
- listLatestTopics - Get the latest topics
- listTopTopics - Get the top topics filtered by period
- removeTopic - Remove a topic
- setNotificationLevel - Set notification level
- updateTopic - Update a topic
- updateTopicStatus - Update the status of a topic
- updateTopicTimestamp - Update topic timestamp
- abortMultipart - Abort multipart upload
- batchPresignMultipartParts - Generates batches of presigned URLs for multipart parts
- completeExternalUpload - Completes a direct external upload
- completeMultipart - Complete multipart upload
- createMultipartUpload - Creates a multipart external upload
- createUpload - Creates an upload
- generatePresignedPut - Initiates a direct external upload
- activateUser - Activate a user
- adminGetUser - Get a user by id
- adminListUsers - Get a list of users
- anonymizeUser - Anonymize a user
- changePassword - Change password
- createUser - Creates a user
- deactivateUser - Deactivate a user
- deleteUser - Delete a user
- getUser - Get a single user by username
- getUserEmails - Get email addresses belonging to a user
- getUserExternalId - Get a user by external_id
- getUserIdentiyProviderExternalId - Get a user by identity provider external ID
- listUserActions - Get a list of user actions
- listUserBadges - List badges for a user
- listUsersPublic - Get a public list of users
- logOutUser - Log a user out
- refreshGravatar - Refresh gravatar
- sendPasswordResetEmail - Send password reset email
- silenceUser - Silence a user
- suspendUser - Suspend a user
- updateAvatar - Update avatar
- updateEmail - Update email
- updateUser - Update a user
- updateUsername - Update username
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError
that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue
. Additionally, a pretty()
method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { SDK } from "@lukehagar/discoursejs";
import { SDKValidationError } from "@lukehagar/discoursejs/sdk/models/errors";
const sdk = new SDK();
async function run() {
let result;
try {
result = await sdk.backups.createBackup();
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
default: {
throw err;
}
}
}
}
run();
You can override the default server globally by passing a server index to the serverIdx
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://{defaultHost} |
defaultHost (default is discourse.example.com ) |
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK({
serverIdx: 0,
});
async function run() {
const result = await sdk.backups.createBackup();
// Handle the result
console.log(result);
}
run();
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
defaultHost: string
The default server can also be overridden globally by passing a URL to the serverURL
optional parameter when initializing the SDK client instance. For example:
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK({
serverURL: "https://{defaultHost}",
});
async function run() {
const result = await sdk.backups.createBackup();
// Handle the result
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient
that wraps the native
Fetch API. This
client is a thin wrapper around fetch
and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient
constructor takes an optional fetcher
argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest"
hook to to add a
custom header and a timeout to requests and how to use the "requestError"
hook
to log errors:
import { SDK } from "@lukehagar/discoursejs";
import { HTTPClient } from "@lukehagar/discoursejs/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new SDK({ httpClient });
For supported JavaScript runtimes, please consult RUNTIMES.md.
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
Tip
Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
- Node.js v20+: Since v20, Node.js comes with a native
openAsBlob
function innode:fs
. - Bun: The native
Bun.file
function produces a file handle that can be used for streaming file uploads. - Browsers: All supported browsers return an instance to a
File
when reading the value from an<input type="file">
element. - Node.js v18: A file stream can be created using the
fileFrom
helper fromfetch-blob/from.js
.
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK();
async function run() {
const result = await sdk.uploads.createUpload();
// Handle the result
console.log(result);
}
run();
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK();
async function run() {
const result = await sdk.backups.createBackup({
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
async function run() {
const result = await sdk.backups.createBackup();
// Handle the result
console.log(result);
}
run();
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console
's interface as an SDK option.
Warning
Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { SDK } from "@lukehagar/discoursejs";
const sdk = new SDK({ debugLogger: console });
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
Available standalone functions
- adminActivateUser
- adminAdminGetUser
- adminAdminListUsers
- adminAnonymizeUser
- adminDeactivateUser
- adminDeleteUser
- adminLogOutUser
- adminRefreshGravatar
- adminSilenceUser
- adminSuspendUser
- backupsCreateBackup
- backupsDownloadBackup
- backupsGetBackups
- backupsSendDownloadBackupEmail
- badgesAdminListBadges
- badgesCreateBadge
- badgesDeleteBadge
- badgesListUserBadges
- badgesUpdateBadge
- categoriesCreateCategory
- categoriesGetCategory
- categoriesGetSite
- categoriesListCategories
- categoriesListCategoryTopics
- categoriesUpdateCategory
- groupsAddGroupMembers
- groupsCreateGroup
- groupsDeleteGroup
- groupsGetGroup
- groupsListGroupMembers
- groupsListGroups
- groupsRemoveGroupMembers
- groupsUpdateGroup
- invitesCreateInvite
- invitesInviteToTopic
- notificationsGetNotifications
- notificationsMarkNotificationsAsRead
- postsCreateTopicPostPM
- postsDeletePost
- postsGetPost
- postsListPosts
- postsLockPost
- postsPerformPostAction
- postsPostReplies
- postsUpdatePost
- privateMessagesCreateTopicPostPM
- privateMessagesGetUserSentPrivateMessages
- privateMessagesListUserPrivateMessages
- searchSearch
- siteGetSite
- tagsCreateTagGroup
- tagsGetTagGroup
- tagsGetTag
- tagsListTagGroups
- tagsListTags
- tagsUpdateTagGroup
- topicsBookmarkTopic
- topicsCreateTopicPostPM
- topicsCreateTopicTimer
- topicsGetTopicByExternalId
- topicsGetTopic
- topicsInviteToTopic
- topicsListLatestTopics
- topicsListTopTopics
- topicsRemoveTopic
- topicsSetNotificationLevel
- topicsUpdateTopicStatus
- topicsUpdateTopicTimestamp
- topicsUpdateTopic
- uploadsAbortMultipart
- uploadsBatchPresignMultipartParts
- uploadsCompleteExternalUpload
- uploadsCompleteMultipart
- uploadsCreateMultipartUpload
- uploadsCreateUpload
- uploadsGeneratePresignedPut
- usersActivateUser
- usersAdminGetUser
- usersAdminListUsers
- usersAnonymizeUser
- usersChangePassword
- usersCreateUser
- usersDeactivateUser
- usersDeleteUser
- usersGetUserEmails
- usersGetUserExternalId
- usersGetUserIdentiyProviderExternalId
- usersGetUser
- usersListUserActions
- usersListUserBadges
- usersListUsersPublic
- usersLogOutUser
- usersRefreshGravatar
- usersSendPasswordResetEmail
- usersSilenceUser
- usersSuspendUser
- usersUpdateAvatar
- usersUpdateEmail
- usersUpdateUser
- usersUpdateUsername
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!