> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/platform/library/files-and-embeds.md).

# Files and embeds

File and media items let you add existing learning resources to the Library without recreating them as Synap notes.

| Item type      | Use it for                                                                                         |
| -------------- | -------------------------------------------------------------------------------------------------- |
| **Document**   | Documents students should read, preview or download, such as a PDF workbook.                       |
| **Video**      | Video learning material students watch within the supported player.                                |
| **Audio file** | Recordings, podcasts or listening exercises.                                                       |
| **ZIP file**   | A downloadable archive of supporting files. Use a SCORM item instead for a SCORM learning package. |
| **Embed**      | A page or interactive resource hosted elsewhere and displayed through an embed.                    |

Create or upload the item from the Library, then check its title, preview and access settings before making it available to students.

### Choose the item by student activity

A PDF that students read should normally be a Document. A web simulation that they interact with should normally be an Embed. A collection of source files that they download for offline work can be a ZIP file. If students need to submit something in return, deliver the resource through an Assignment with the appropriate submission item.

### Documents

Supported documents can be previewed in the student experience, while others may be downloaded or opened by the browser. Check page orientation, selectable text, links and any annotations you expect students to use. Provide an accessible alternative where a scanned or image-only document cannot be read by assistive technology.

Replacing a document changes the resource students open from future views of the shared Library item. Check active delivery before replacing assessed material.

### Video and audio

Preview playback from the same type of network and device students will use. Large media can work well on a fast office connection but poorly for remote learners. Include captions or a transcript where appropriate, and avoid placing essential instructions only in audio or video.

### Embeds

An embed keeps externally hosted content inside the learning experience. The external provider must permit its pages to be displayed in an embedded frame; sign-in rules, cookie restrictions or security headers can prevent it.

Check the resource while signed in as a student. Confirm that it loads over Hypertext Transfer Protocol Secure (HTTPS), fits on supported screen sizes, handles any sign-in or consent prompt, remains keyboard-accessible and does not depend on completion data Synap cannot receive.

{% hint style="warning" %}
Embedded content depends on the external provider remaining available and permitting embedding. Test it in the learner experience, not only in the editor.
{% endhint %}

### ZIP downloads

A standard ZIP item is a download, not an interactive course. Tell students what software they need and what to do after downloading it. Upload SCORM through its dedicated workflow so Synap can launch and track it correctly.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://synap.ac/docs/platform/library/files-and-embeds.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.