The Jams API allows you to interact with VRChat Jams—events or competitions where users can submit content like worlds or avatars.

1. getJamsList - Retrieve a list of Jams, optionally filtered by active status and type.

2. getJamInfo - Get detailed information about a specific Jam.

3. getJamSubmissions - Retrieve a list of submissions for a specific Jam.

Retrieve a list of Jams, optionally filtered by active status and type.

getJamsList(options: { isActive?: boolean; type?: 'world' | 'avatar' }): Promise<Jam[]>

• options (object, optional):
  • isActive (optional): boolean
    Filter Jams by active status.
    • true: Returns only active Jams.
    • false: Returns only inactive Jams.
  • type (optional): 'world' or 'avatar'
    Filter Jams by type.

• Promise<Jam[]>: A promise that resolves to an array of Jam objects.

// Example: Get all active world Jams
const activeWorldJams = await vrchatApi.jamApi.getJamsList({ isActive: true, type: 'world' });
console.log(activeWorldJams);

// Example: Get all Jams regardless of status or type
const allJams = await vrchatApi.jamApi.getJamsList({});
console.log(allJams);

Get detailed information about a specific Jam.

getJamInfo(jamId: string): Promise<Jam>

• jamId (string): The unique identifier of the Jam.

• Promise<Jam>: A promise that resolves to a Jam object containing detailed information.

// Example: Get information about a specific Jam
const jamId = 'your-jam-id';
const jamInfo = await vrchatApi.jamApi.getJamInfo(jamId);
console.log(jamInfo);

Retrieve a list of submissions for a specific Jam.

getJamSubmissions(jamId: string): Promise<JamSubmission[]>

• jamId (string): The unique identifier of the Jam.

• Promise<JamSubmission[]>: A promise that resolves to an array of JamSubmission objects.

// Example: Get submissions for a specific Jam
const jamId = 'your-jam-id';
const submissions = await vrchatApi.jamApi.getJamSubmissions(jamId);
console.log(submissions);

Note: Replace 'your-jam-id' with the actual Jam ID you want to query.

These endpoints allow you to list Jams, get detailed information about a specific Jam, and retrieve submissions for a Jam. They require authentication and are useful for interacting with VRChat's community events programmatically.