> ## Documentation Index
> Fetch the complete documentation index at: https://docs.edpire.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started (Schools)

> A step-by-step guide for school administrators — no development team required.

This guide is for school administrators who want to use Edpire to create, share, and review assessments. No technical knowledge required.

## Creating your account

1. Go to [edpire.com](https://edpire.com) and click **Sign Up**
2. Create your personal account first (email and password, or continue with Google)
3. On the **Welcome** screen, choose **Set up my organization** (the other options are
   *Teach on my own* for a private workspace, and *Join my organization* if a colleague
   already created one and gave you its URL)
4. Enter your organization's name and details

Depending on how your organization was set up, you may land in your dashboard immediately or
see a short "pending approval" screen while we activate the account. If you are still waiting
after one business day, email [support@edpire.com](mailto:support@edpire.com).

<Tip>
  If a colleague has already created your organization, do not create a second one. Choose
  **Join my organization** and enter the organization URL they give you.
</Tip>

## Creating an assessment

1. Go to **My Assessments** in the sidebar
2. Navigate into the folder you want it in, or stay at the top level
3. Click **New Assessment** and give it a title
4. The builder opens straight away

Everything else — time limit, passing score, attempts — is set in the builder's **Settings**
panel once you are in, so you can start writing questions immediately.

### Adding exercises and questions

In the builder:

1. Click **Add Exercise** to create a new exercise block
2. Within each exercise, click **Add Question**
3. Choose a question type (multiple choice, fill-in-the-blank, open answer, etc.)
4. Write your question content in the editor
5. Add answer keys and set point values
6. Click **Save**

### Assessment settings

In the **Settings** panel:

* **Time limit** — set a countdown timer (leave blank for untimed)
* **Passing score** — minimum percentage to pass (default 50%)
* **Allowed attempts** — how many times a learner can retry (0 = unlimited)
* **Show solutions** — when to reveal correct answers (never / after due date / immediately)

## Publishing and sharing

Once your assessment is ready:

1. Click **Publish** in the top bar
2. Your assessment receives a **share code** (e.g., `ABC123`)
3. Share the assessment link with learners:

```
https://your-org.edpire.com/take/ABC123
```

<Tip>
  Learners do not need an Edpire account to take the assessment — just the link.
</Tip>

### Sharing options

* **Direct link** — paste in email, LMS, or classroom chat
* **Share code** — learners enter it at `your-org.edpire.com`
* **Embed** — if your LMS supports iframe embeds (contact your tech team)

## Viewing results

After learners complete the assessment:

1. Go to **My Assessments** in the sidebar
2. Click on the assessment name
3. Click **Results** to see all submissions

For each submission you'll see:

* Learner identifier
* Score and percentage
* Pass / Fail status
* Time taken
* Per-question breakdown (click to expand)

### Exporting results

Click **Export** on the results page to download a CSV with all submissions. Useful for grade books and reports.

## Organizing your assessments

**My Assessments** is where your assessments live. It works like a file browser: create folders, nest
them, drag assessments between them, and search across everything. Use it to organize by
subject, level, or term.

An assessment lives in exactly one folder, the same way a file lives in one directory.

<Note>
  **Collections** are a separate, ordered grouping used mainly by platform integrations, where
  the same assessment can appear in several sequences. They are managed through the REST API
  rather than the dashboard. If you are connecting Edpire to another platform, your developer
  will find them in the [API reference](/api-reference/collections/list-collections).
</Note>

## Managing API Keys

If you're working with a development team to connect Edpire to another platform:

1. Go to **Integrations** in the sidebar
2. Click **Create API Key**
3. Give it a name (e.g., "LMS Integration")
4. Select the required scopes (your developer will tell you which ones)
5. Copy the key — **it is shown only once**
6. Share it with your developer via a secure channel (not email or chat)

Your developer will also need to register your site's domain under **Integrations → Security**.
There are two separate lists there, and putting a domain in the wrong one is the most common
setup mistake:

| List                               | Used for                                                               |
| ---------------------------------- | ---------------------------------------------------------------------- |
| **Allowed API & Redirect Origins** | Server-to-server calls, and the `return_url` learners are sent back to |
| **Allowed Embed Origins**          | Pages that embed the assessment player with our JavaScript SDK         |

<Warning>
  API keys give access to your org's assessment data. Never share them publicly or put them in code repositories.
</Warning>

## Quick reference

| Action                            | Where to find it                   |
| --------------------------------- | ---------------------------------- |
| Create assessment                 | My Assessments → New Assessment    |
| Organize assessments              | My Assessments → New Folder        |
| View results                      | My Assessments → \[name] → Results |
| Share link                        | My Assessments → \[name] → Share   |
| Manage teachers and learners      | People                             |
| Manage classes                    | Classes                            |
| Create API key                    | Integrations                       |
| Register embed / redirect domains | Integrations → Security            |
| Change org settings               | Org Settings                       |
