Invitations

The deepgram.invitation object provides access to the invites endpoints of the Deepgram API. Each request is project based and will require a project_id.

List Project Invitations

You can retrieve all active invitations on a given project using the invitation.list function.

List Project Invitations Parameters

Parameter	Type	Description
project_id	String	A unique identifier for the project you wish to see the invitations of

List Project Invitations Example Request

const response = await deepgram.invitation.list(PROJECT_ID);

List Project Invitations Response

{
    members: [
        {
            email: string,
            scope: string,
        },
    ];
}

Send Project Invitation

You can send an invitation to a given email address to join a given project using the invitation.send function.

Send Project Invitation Parameters

Parameter	Type	Description
project_id	String	A unique identifier for the project you wish to send an invitation from
option	Object	An object containing the email address of the person you wish to send an invite to, and the scope you want them to have in the project

Send Project Invitation Example Request

const response = await deepgram.invitation.send(PROJECT_ID, {
    email: "[email protected]",
    scope: "member",
});

Send Project Invitation Response

{
    message: string;
}

Leave Project

Removes the authenticated account from the specified project.

Leave Project Parameters

Parameter	Type	Description
project_id	String	A unique identifier for the project you wish to leave

Leave Project Example Request

const response = await deepgram.invitation.leave(PROJECT_ID);

Leave Project Response

{
    message: string;
}

Remove Invitation from Project

Removes the invitation of the specified email from the specified project.

Remove Invitation from Project Parameters

Parameter	Type	Description
project_id	String	A unique identifier for the project you wish to remove the invite from
email	String	The email address of the invitee

Remove Invitation from Project Example Request

const response = await deepgram.invitation.leave(PROJECT_ID, "[email protected]");

Remove Invitation from Project Response

{
    message: string;
}