Next to syncing audiotool document, the package provides bindings to a subset of APIs from the audiotool platform. The APIs are auto generated from our proto files, wrapped in our own client called RetryingClient. The apis can be found at the field AudiotoolClient.api, which is of type AudiotoolAPI:

const client = await createAudiotoolClient({ ... })
const projects = await client.api.projectService.listProjects({})
Copy

Since the types are auto-generated, they're a bit hard to read. The type:

createProject: {
  I: typeof CreateProjectRequest
  kind: Unary
  name: "CreateProject"
  O: typeof CreateProjectResponse
}
Copy

denotes a method taking CreateProjectRequest and returning CreateProjectResponse, simple objects. Your editor will help.

Cheat sheet

ProjectService:

• list projects
• create, update and delete projects
• list "collab sessions" (i.e. DAW clients) connect to a project

SampleService:

• create, update, delete sample objects (sample metadata)
• download a sample using the name in the Sample entity
• upload new samples to the backend

ProjectRoleService:

• list, add, remove users to your project as collaborators

UserService:

• list, delete, update users
• upload user avatars

AudiographService

• get audio graphs (vector graphics used in the sample browser)

PresetUtil:

A wrapper around the preset's API. Presets are device configurations that can be applied to existing devices to create a specific sound/effect. You can copy preset ids in the preset browser in the DAW: