API - Corsair

Every googlemeet.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Conference Records

get

conferenceRecords.get Get a conference record Risk: read

await corsair.googlemeet.api.conferenceRecords.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`space`	`string`	No	—
`fixedExternalMeetingId`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—
`expireTime`	`string`	No	—

list

conferenceRecords.list List conference records Risk: read

await corsair.googlemeet.api.conferenceRecords.list({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—
`filter`	`string`	No	—

Output

Name	Type	Required	Description
`conferenceRecords`	`object[]`	No	—
`nextPageToken`	`string`	No	—

conferenceRecords full type

{
  name?: string,
  space?: string,
  fixedExternalMeetingId?: string,
  startTime?: string,
  endTime?: string,
  expireTime?: string
}[]

Participants

get

participants.get Get a participant Risk: read

await corsair.googlemeet.api.participants.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`signedInUser`	`object`	No	—
`anonymousUser`	`object`	No	—
`phoneUser`	`object`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—

signedInUser full type

{
  user?: string,
  displayName?: string
}

anonymousUser full type

{
  displayName?: string
}

phoneUser full type

{
  displayName?: string
}

list

participants.list List participants Risk: read

await corsair.googlemeet.api.participants.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`participants`	`object[]`	No	—
`nextPageToken`	`string`	No	—

participants full type

{
  name?: string,
  signedInUser?: {
    user?: string,
    displayName?: string
  },
  anonymousUser?: {
    displayName?: string
  },
  phoneUser?: {
    displayName?: string
  },
  startTime?: string,
  endTime?: string
}[]

Participant Sessions

get

participantSessions.get Get a participant session Risk: read

await corsair.googlemeet.api.participantSessions.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—

list

participantSessions.list List participant sessions Risk: read

await corsair.googlemeet.api.participantSessions.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`participantSessions`	`object[]`	No	—
`nextPageToken`	`string`	No	—

participantSessions full type

{
  name?: string,
  startTime?: string,
  endTime?: string
}[]

Recordings

get

recordings.get Get a recording Risk: read

await corsair.googlemeet.api.recordings.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—
`state`	`STATE_UNSPECIFIED \| STARTED \| ENDED \| FILE_GENERATED`	No	—
`driveDestination`	`object`	No	—

driveDestination full type

{
  file?: string,
  exportUri?: string
}

list

recordings.list List recordings Risk: read

await corsair.googlemeet.api.recordings.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`recordings`	`object[]`	No	—
`nextPageToken`	`string`	No	—

recordings full type

{
  name?: string,
  startTime?: string,
  endTime?: string,
  state?: STATE_UNSPECIFIED | STARTED | ENDED | FILE_GENERATED,
  driveDestination?: {
    file?: string,
    exportUri?: string
  }
}[]

Smart Notes

get

smartNotes.get Get smart notes Risk: read

await corsair.googlemeet.api.smartNotes.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—
`state`	`STATE_UNSPECIFIED \| STARTED \| ENDED \| FILE_GENERATED`	No	—
`docsDestination`	`object`	No	—

docsDestination full type

{
  document?: string,
  exportUri?: string
}

list

smartNotes.list List smart notes Risk: read

await corsair.googlemeet.api.smartNotes.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`smartNotes`	`object[]`	No	—
`nextPageToken`	`string`	No	—

smartNotes full type

{
  name?: string,
  startTime?: string,
  endTime?: string,
  state?: STATE_UNSPECIFIED | STARTED | ENDED | FILE_GENERATED,
  docsDestination?: {
    document?: string,
    exportUri?: string
  }
}[]

Spaces

create

spaces.create Create a new meeting space Risk: write

await corsair.googlemeet.api.spaces.create({});

Input

Name	Type	Required	Description
`space`	`object`	No	—
`requestId`	`string`	No	—

space full type

{
  config?: {
    accessType?: ACCESS_TYPE_UNSPECIFIED | OPEN | TRUSTED | RESTRICTED,
    entryPointAccess?: ENTRY_POINT_ACCESS_UNSPECIFIED | CREATOR_APP_ONLY | ALL,
    moderation?: MODERATION_UNSPECIFIED | OFF | ON,
    moderationRestrictions?: {
      chatRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
      reactionRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
      presentRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
      defaultJoinAsViewerType?: DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED | ON | OFF
    },
    attendanceReportGenerationType?: ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED | DO_NOT_GENERATE | GENERATE_REPORT,
    artifactConfig?: {
      recordingConfig?: {
        autoRecordingGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
      },
      transcriptionConfig?: {
        autoTranscriptionGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
      },
      smartNotesConfig?: {
        autoSmartNotesGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
      }
    }
  }
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`meetingUri`	`string`	No	—
`meetingCode`	`string`	No	—
`config`	`object`	No	—
`activeConference`	`object`	No	—
`phoneAccess`	`object[]`	No	—
`gatewaySipAccess`	`object[]`	No	—

config full type

{
  accessType?: ACCESS_TYPE_UNSPECIFIED | OPEN | TRUSTED | RESTRICTED,
  entryPointAccess?: ENTRY_POINT_ACCESS_UNSPECIFIED | CREATOR_APP_ONLY | ALL,
  moderation?: MODERATION_UNSPECIFIED | OFF | ON,
  moderationRestrictions?: {
    chatRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    reactionRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    presentRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    defaultJoinAsViewerType?: DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED | ON | OFF
  },
  attendanceReportGenerationType?: ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED | DO_NOT_GENERATE | GENERATE_REPORT,
  artifactConfig?: {
    recordingConfig?: {
      autoRecordingGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    },
    transcriptionConfig?: {
      autoTranscriptionGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    },
    smartNotesConfig?: {
      autoSmartNotesGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    }
  }
}

activeConference full type

{
  conferenceRecord?: string
}

phoneAccess full type

{
  languageCode?: string,
  phoneNumber?: string,
  pin?: string,
  regionCode?: string
}[]

gatewaySipAccess full type

{
  uri?: string,
  sipAccessCode?: string
}[]

endActiveConference

spaces.endActiveConference End an active conference [DESTRUCTIVE] Risk: destructive · Irreversible

await corsair.googlemeet.api.spaces.endActiveConference({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output: void

get

spaces.get Get a meeting space Risk: read

await corsair.googlemeet.api.spaces.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`meetingUri`	`string`	No	—
`meetingCode`	`string`	No	—
`config`	`object`	No	—
`activeConference`	`object`	No	—
`phoneAccess`	`object[]`	No	—
`gatewaySipAccess`	`object[]`	No	—

config full type

{
  accessType?: ACCESS_TYPE_UNSPECIFIED | OPEN | TRUSTED | RESTRICTED,
  entryPointAccess?: ENTRY_POINT_ACCESS_UNSPECIFIED | CREATOR_APP_ONLY | ALL,
  moderation?: MODERATION_UNSPECIFIED | OFF | ON,
  moderationRestrictions?: {
    chatRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    reactionRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    presentRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    defaultJoinAsViewerType?: DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED | ON | OFF
  },
  attendanceReportGenerationType?: ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED | DO_NOT_GENERATE | GENERATE_REPORT,
  artifactConfig?: {
    recordingConfig?: {
      autoRecordingGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    },
    transcriptionConfig?: {
      autoTranscriptionGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    },
    smartNotesConfig?: {
      autoSmartNotesGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    }
  }
}

activeConference full type

{
  conferenceRecord?: string
}

phoneAccess full type

{
  languageCode?: string,
  phoneNumber?: string,
  pin?: string,
  regionCode?: string
}[]

gatewaySipAccess full type

{
  uri?: string,
  sipAccessCode?: string
}[]

patch

spaces.patch Update a meeting space Risk: write

await corsair.googlemeet.api.spaces.patch({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`updateMask`	`string`	No	—
`space`	`object`	No	—

space full type

{
  config?: {
    accessType?: ACCESS_TYPE_UNSPECIFIED | OPEN | TRUSTED | RESTRICTED,
    entryPointAccess?: ENTRY_POINT_ACCESS_UNSPECIFIED | CREATOR_APP_ONLY | ALL,
    moderation?: MODERATION_UNSPECIFIED | OFF | ON,
    moderationRestrictions?: {
      chatRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
      reactionRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
      presentRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
      defaultJoinAsViewerType?: DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED | ON | OFF
    },
    attendanceReportGenerationType?: ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED | DO_NOT_GENERATE | GENERATE_REPORT,
    artifactConfig?: {
      recordingConfig?: {
        autoRecordingGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
      },
      transcriptionConfig?: {
        autoTranscriptionGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
      },
      smartNotesConfig?: {
        autoSmartNotesGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
      }
    }
  }
}

Output

Name	Type	Required	Description
`name`	`string`	No	—
`meetingUri`	`string`	No	—
`meetingCode`	`string`	No	—
`config`	`object`	No	—
`activeConference`	`object`	No	—
`phoneAccess`	`object[]`	No	—
`gatewaySipAccess`	`object[]`	No	—

config full type

{
  accessType?: ACCESS_TYPE_UNSPECIFIED | OPEN | TRUSTED | RESTRICTED,
  entryPointAccess?: ENTRY_POINT_ACCESS_UNSPECIFIED | CREATOR_APP_ONLY | ALL,
  moderation?: MODERATION_UNSPECIFIED | OFF | ON,
  moderationRestrictions?: {
    chatRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    reactionRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    presentRestriction?: RESTRICTION_TYPE_UNSPECIFIED | HOSTS_ONLY | NO_RESTRICTION,
    defaultJoinAsViewerType?: DEFAULT_JOIN_AS_VIEWER_TYPE_UNSPECIFIED | ON | OFF
  },
  attendanceReportGenerationType?: ATTENDANCE_REPORT_GENERATION_TYPE_UNSPECIFIED | DO_NOT_GENERATE | GENERATE_REPORT,
  artifactConfig?: {
    recordingConfig?: {
      autoRecordingGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    },
    transcriptionConfig?: {
      autoTranscriptionGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    },
    smartNotesConfig?: {
      autoSmartNotesGeneration?: AUTO_GENERATION_TYPE_UNSPECIFIED | ON | OFF
    }
  }
}

activeConference full type

{
  conferenceRecord?: string
}

phoneAccess full type

{
  languageCode?: string,
  phoneNumber?: string,
  pin?: string,
  regionCode?: string
}[]

gatewaySipAccess full type

{
  uri?: string,
  sipAccessCode?: string
}[]

Transcript Entries

get

transcriptEntries.get Get a transcript entry Risk: read

await corsair.googlemeet.api.transcriptEntries.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`participant`	`string`	No	—
`text`	`string`	No	—
`languageCode`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—

list

transcriptEntries.list List transcript entries Risk: read

await corsair.googlemeet.api.transcriptEntries.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`transcriptEntries`	`object[]`	No	—
`nextPageToken`	`string`	No	—

transcriptEntries full type

{
  name?: string,
  participant?: string,
  text?: string,
  languageCode?: string,
  startTime?: string,
  endTime?: string
}[]

Transcripts

get

transcripts.get Get a transcript Risk: read

await corsair.googlemeet.api.transcripts.get({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—
`state`	`STATE_UNSPECIFIED \| STARTED \| ENDED \| FILE_GENERATED`	No	—
`docsDestination`	`object`	No	—

docsDestination full type

{
  document?: string,
  exportUri?: string
}

list

transcripts.list List transcripts Risk: read

await corsair.googlemeet.api.transcripts.list({});

Input

Name	Type	Required	Description
`parent`	`string`	Yes	—
`pageSize`	`number`	No	—
`pageToken`	`string`	No	—

Output

Name	Type	Required	Description
`transcripts`	`object[]`	No	—
`nextPageToken`	`string`	No	—

transcripts full type

{
  name?: string,
  startTime?: string,
  endTime?: string,
  state?: STATE_UNSPECIFIED | STARTED | ENDED | FILE_GENERATED,
  docsDestination?: {
    document?: string,
    exportUri?: string
  }
}[]

​Conference Records

​get

​list

​Participants

​get

​list

​Participant Sessions

​get

​list

​Recordings

​get

​list

​Smart Notes

​get

​list

​Spaces

​create

​endActiveConference

​get

​patch

​Transcript Entries

​get

​list

​Transcripts

​get

​list

Conference Records

get

list

Participants

get

list

Participant Sessions

get

list

Recordings

get

list

Smart Notes

get

list

Spaces

create

endActiveConference

get

patch

Transcript Entries

get

list

Transcripts

get

list