The Deepgram.projects object provides access to manage projects associated with the API key you provided when instantiating the Deepgram client.

List Projects

Retrieve all projects your API key has access to manage.

List Project Example Request

projects = await deepgram.projects.list()

List Projects Response

{
  projects: [
    {
      project_id: String,
      name: String,
    },
  ],
}

Get a Project

Retrieves a project based on the provided project id.

Get a Project Parameters

ParameterTypeDescription
project_idStringA unique identifier for the project to retrieve

Get a Project Example Request

project = await deepgram.projects.get(PROJECT_ID)

Get a Project Response

{
  project_id: String,
  name: String,
}

Update a Project

Updates a project based on a provided project object.

Update Project Parameters

ParameterTypeDescription
projectObjectObject representing a project. Must contain project_id and name properties.

ℹ️

Note

The project object must contain project_id and name properties.

Update a Project Example Request

updateResponse = await deepgram.projects.update(project)

Update a Project Response

{
	message: String;
}