Skip to main content
GET
ListArtifacts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

conversationId
string

Unset lists every artifact in the caller's organization.

pageSize
integer<int64>
pageToken
string
filter
string

A Common Expression Language (CEL) filter string. Available fields are artifact_id, organization_id, created_by_user_id, storage_class, created_via, title, file_name, file_type, version, created_date, version_created_date (last updated), archived_date, the include_archived directive, and metadata through metadata["<key>"]. File type is the lowercase extension or MIME subtype; images use "image", structured artifacts use "json", and artifacts without a file use "file". Links can be filtered with a comprehension such as links.exists(l, l.relation == "ATTACHED_TO" && l.entity_type == "CONVERSATION" && l.entity_id == "<id>"). Link sub-fields are relation, entity_type, entity_id, and artifact_version_id. Enum fields compare against proto value names without the prefix, for example storage_class == "STRUCTURED", relation == "ATTACHED_TO", and entity_type == "CONVERSATION". The conversation_id field on this message combines with filter.

Archived artifacts are excluded unless the query says otherwise, either through include_archived == true or by filtering on archived_date, which governs archival on its own.

orderBy
string

A comma-separated AIP-132 ordering string over created_date, version_created_date (last updated), archived_date, title, version, and file_type. Fields sort ascending by default and support a desc suffix. The default is created_date ascending.

Response

A successful response.

artifacts
object[]
read-only
nextPageToken
string
read-only