import Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
const experience = await client.experiences.create({
app_id: 'app_xxxxxxxxxxxxxx',
company_id: 'biz_xxxxxxxxxxxxxx',
});
console.log(experience.id);{
"id": "exp_xxxxxxxxxxxxxx",
"name": "Trading Signals Chat",
"order": "123.45",
"is_public": true,
"created_at": "2023-12-01T05:00:00.401Z",
"app": {
"id": "app_xxxxxxxxxxxxxx",
"name": "Courses",
"icon": {
"url": "https://media.whop.com/abc123/optimized.jpg"
}
},
"image": {
"url": "https://media.whop.com/abc123/optimized.jpg"
},
"company": {
"id": "biz_xxxxxxxxxxxxxx",
"title": "Pickaxe",
"route": "pickaxe"
},
"products": [
{
"id": "prod_xxxxxxxxxxxxx",
"route": "pickaxe-analytics",
"title": "Pickaxe Analytics"
}
]
}Required permissions:
experience:createimport Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
const experience = await client.experiences.create({
app_id: 'app_xxxxxxxxxxxxxx',
company_id: 'biz_xxxxxxxxxxxxxx',
});
console.log(experience.id);{
"id": "exp_xxxxxxxxxxxxxx",
"name": "Trading Signals Chat",
"order": "123.45",
"is_public": true,
"created_at": "2023-12-01T05:00:00.401Z",
"app": {
"id": "app_xxxxxxxxxxxxxx",
"name": "Courses",
"icon": {
"url": "https://media.whop.com/abc123/optimized.jpg"
}
},
"image": {
"url": "https://media.whop.com/abc123/optimized.jpg"
},
"company": {
"id": "biz_xxxxxxxxxxxxxx",
"title": "Pickaxe",
"route": "pickaxe"
},
"products": [
{
"id": "prod_xxxxxxxxxxxxx",
"route": "pickaxe-analytics",
"title": "Pickaxe Analytics"
}
]
}A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Parameters for CreateExperience
The unique identifier of the app that powers this experience.
"app_xxxxxxxxxxxxxx"
The unique identifier of the company to create this experience for.
"biz_xxxxxxxxxxxxxx"
Whether the experience is publicly accessible without a membership.
A logo image displayed alongside the experience name.
Show child attributes
The display name of the experience. Defaults to the app's name if not provided.
The unique identifier of the section to place the experience in.
A successful response
An experience is a feature or content module within a product, such as a chat, course, or custom app.
The unique identifier for the experience.
"exp_xxxxxxxxxxxxxx"
The display name of this experience shown to users in the product navigation. Maximum 255 characters.
"Trading Signals Chat"
The sort position of this experience within its section. Lower values appear first. Null if no position has been set.
"123.45"
Whether this experience is publicly visible to all users, including those without a membership.
The datetime the experience was created.
"2023-12-01T05:00:00.401Z"
The app that powers this experience, defining its interface and behavior.
Show child attributes
The custom logo image for this experience. Null if no custom logo has been uploaded.
Show child attributes
The company that owns this experience.
Show child attributes
The list of products this experience is attached to, which determines which customers have access. Empty if the experience is only visible to authorized company team members.
Show child attributes
Was this page helpful?