List source materials

GEThttps://api.examplary.ai/source-materials

Returns a list of source materials the current user has access to.

Query parameters

externalIdstring

Filter by externalId

Responses

`200`

Array of object

orgstringrequired

idstringrequired

typestring

createdBystringrequired

createdAtstring· date-time· pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

updatedAtstring· date-time· pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

deletedAtstring· date-time· pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

expiresAtnumber

namestring

originalSourceobjectrequired

externalIdstring

parentSourceMaterialIdstring

summarystring

factsCountnumber

processingStatusstring

Allowed values:pendingconvertingsummarizingextracting_topicsextracting_factscompletedfailed

numberOfPagesnumber

tagsarray string[]

metadataobject

chapterMarkersarray object[]

convertedSourceV2object

geminiSourceobject

topicsany

cacheNamestring

`400` — Validation Error

successbooleanrequired

Allowed values:false

errorarray any[]required

dataanyrequired

Requirements

User roles

This endpoint requires the teacher, admin, or owner role to be present.

OAuth scopes

This endpoint requires the source-materials:read scope to be present.