> For the complete documentation index, see [llms.txt](https://docs.uptiq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uptiq.ai/document-ai/document-ai-1/workspace.md).

# Workspace

Workspace combines two areas, both reachable from the sidebar:

* **Home** (`/dashboard`), a dashboard of processing metrics and quick actions
* **Gallery** (`/gallery`), a tool for organizing documents into named collections.

<figure><img src="/files/YuUHj1Z8wzLFKMhMJ3NC" alt=""><figcaption></figcaption></figure>

### Navigate Document AI

* **Process documents** — use [Document Classification](/document-ai/document-ai-1/document-classification.md), [Document Extraction](/document-ai/document-ai-1/document-extraction.md), and [Fraud Detection](/document-ai/document-ai-1/fraud-detection.md).
* **Validate and deliver results** — use [Test Dashboard](/document-ai/document-ai-1/test-dashboard.md), [Document Generation](/document-ai/document-ai-1/document-generation.md), and [Webhooks & Integrations](/document-ai/document-ai-1/webhooks-and-integrations.md).
* **Administer the platform** — use [Document Types](/document-ai/document-ai-1/document-types.md) to understand supported schemas and [User Management](/document-ai/document-ai-1/user-management.md) to manage access, API keys, and account settings.
* **Look up terminology** — use [Glossary](/document-ai/document-ai-1/glossary.md) for shared Document AI terms, roles, statuses, and workflow language.

| Capability                    | Description                                                                                                           |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Home metrics                  | Docs processed, In-flight, Batch runs, Failed (24h), Avg time, LLM tokens, Webhooks, Judge accuracy                   |
| Credit balance                | Available balance and a warning when jobs will be blocked for insufficient credit                                     |
| Quick actions                 | Launch Extract, Generate/Fill, Analyze, or Search gallery directly from Home's "Start something" panel                |
| Quick links                   | Separate shortcuts to Extractions, Webhooks, Test Dashboard, and Gallery                                              |
| Active runs / Recent activity | Live view of in-progress runs and recent account activity                                                             |
| Pipeline health               | Processed/Processing/Pending/Failed counts, extraction queue and webhook progress, processor status                   |
| Collection creation           | Create a named collection with an optional description and one of 6 colors (Violet, Blue, Green, Orange, Pink, Slate) |
| Collection hierarchy          | Organize a collection into nested directories or books                                                                |
| Document tagging              | Tag extraction documents into a collection from the Extractions page                                                  |
| Search                        | Search collections by name                                                                                            |

### Workflow

**Home**

1. **Land on Home** — see processing metrics, credit balance, active runs, recent activity, and pipeline health for the account.
2. **Jump in** — use the "Start something" tiles (Extract, Generate/Fill, Analyze, Search gallery) to launch a capability, or use Quick links to jump to Extractions, Webhooks, Test Dashboard, or Gallery.

{% hint style="warning" %} <mark style="color:$warning;">Two Home controls don't currently do anything when clicked: the</mark> <mark style="color:$warning;">**Last 7 days**</mark> <mark style="color:$warning;">date-range dropdown, and the sidebar's</mark> <mark style="color:$warning;">**Search**</mark> <mark style="color:$warning;">box (including its ⌘K shortcut). Both appear to be placeholders in this build rather than a live filter or command palette.</mark>
{% endhint %}

**Gallery**

1. **Create a collection** — from Gallery, click **New Collection**. Name it (required), and optionally add a description and pick a color.
2. **Organize** (optional) — open the collection and click **New directory or book** to add a nested Directory or Book, each with its own name, description, and color.
3. **Tag documents** — collections don't have an upload or attach control of their own; documents are tagged into a collection from the Extractions page.
4. **Browse** — view a collection's contents, filtered by **All descendants** or **Direct only**. Each collection card shows its document count and creation date.
5. **Edit a collection** — open it and click **Edit** to change its name, description, or color.
6. **Remove a collection** — open it and click **Delete**. This deletes immediately with no confirmation prompt.

<figure><img src="/files/lt8OkUdZKcWuLihyKnnc" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %} <mark style="color:$warning;">The Gallery page and its</mark> <mark style="color:$warning;">**New Collection**</mark> <mark style="color:$warning;">/</mark> <mark style="color:$warning;">**Edit**</mark> <mark style="color:$warning;">/</mark> <mark style="color:$warning;">**Delete**</mark> <mark style="color:$warning;">controls render the same way regardless of role, but they aren't all functionally available to every role — see Roles below.</mark>
{% endhint %}

### Roles

Workspace itself has no role-specific views on Home — the dashboard is identical for Owner, Admin, Member, and Viewer. Gallery's controls render identically for every role too, but functional access differs:

| Role       | Access                                                                                                                                                                                                                                                                                                               |
| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Owner**  | Full create, edit, and delete access to collections                                                                                                                                                                                                                                                                  |
| **Admin**  | Same as Owner — confirmed by directly creating and deleting a collection                                                                                                                                                                                                                                             |
| **Member** | Can view collections and **confirmed can create one** — a real collection was created and persisted after a hard reload; <mark style="color:$warning;">**Delete does not work**</mark> <mark style="color:$warning;">— the button is present and clickable, but the action fails silently with no error shown</mark> |
| **Viewer** | Can view collections; **Create is rejected server-side** — the New Collection dialog opens, accepts input, and can be submitted, but clicking Create returns an explicit "Access Denied — You do not have permission to perform this action" toast, and a reload confirms no collection is created                   |

### Related pages

* [Document Extraction](/document-ai/document-ai-1/document-extraction.md) — process documents and send them into collections.
* [Test Dashboard](/document-ai/document-ai-1/test-dashboard.md) — review runs and validate output quality.
* [Webhooks & Integrations](/document-ai/document-ai-1/webhooks-and-integrations.md) — push results into downstream systems.


---

# 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://docs.uptiq.ai/document-ai/document-ai-1/workspace.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.