Skip to main content

Fetch Artifacts

Endpoint: /artifact/fetch

This endpoint allows you to retrieve a paginated list of all generated meeting artifacts. You can filter the results by room, session, or artifact type.

Request Parameters​

FieldTypeRequiredDescription
room_idsarray of stringsNoAn array of one or more room_ids to filter the results.
room_sidstringNoFilter artifacts from a specific room session by providing its sid.
typestring or numberNoFilter by a specific artifact type. You can use either the string name (e.g., MEETING_ANALYTICS) or its corresponding integer value. See Artifact Types below.
fromnumberNoThe starting offset for pagination. Default: 0.
limitnumberNoThe maximum number of artifacts to return. Default: 20, Maximum: 100.
order_bystringNoThe sort order for the results. Can be ASC or DESC. Default: DESC.

Example Request​

{
"room_ids": ["room01", "room02"],
"type": "MEETING_ANALYTICS",
"limit": 10
}

Response​

FieldTypeDescription
statusbooleanIndicates if the request was successful.
msgstringResponse message.
status_codestringResponse status code.
resultResultThe object containing the list of artifacts.

Result​

FieldTypeDescription
total_artifactsnumberThe total number of artifacts matching the query.
fromnumberThe pagination offset of the current result set.
limitnumberThe pagination limit of the current result set.
order_bystringThe sorting order of the result set.
typestringThe artifact type that was filtered for.
artifacts_listarray of ArtifactInfoThe list of artifact objects. See the Get Artifact Info page for the detailed structure of the ArtifactInfo object.

Artifact Types​

The type field identifies the kind of artifact. You can use either the string name (e.g., MEETING_ANALYTICS) or its corresponding integer value when filtering.

A few common examples include:

  • MEETING_SUMMARY
  • SPEECH_TRANSCRIPTION
  • MEETING_ANALYTICS
  • MEETING_SUMMARY_USAGE

For a complete and up-to-date list of all available artifact types, please refer to the official plugnmeet_room_artifacts.proto file.

Working with meeting analytics?

To list and download MEETING_ANALYTICS files and turn the raw JSON into attendance, engagement, and classroom performance reports, see the Meeting Analytics & Reports guide.