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

# Introduction

> Reference for the Filed GraphQL API: endpoint, authentication, and operations

The Filed API is a single GraphQL endpoint. You send queries and mutations to one
URL and request exactly the fields you need.

```
https://router.apps.filed.com/graphql
```

Every request except [`health`](/apis/health) and the token exchange needs a
`Bearer` token. Most operations act on a workspace and need a **`workspaceToken`**;
see [Authentication](/guides/authentication) to create an API key and exchange it
for a token.

<Note>
  Clients and tasks are **not** top-level queries. They belong to a workspace and
  are reached through `me`, resolved as a `WorkspaceUser`:
  `me { ... on WorkspaceUser { workspace { clients { ... } tasks { ... } } } }`.
  The `workspaceToken` identifies the workspace, so you never pass a workspace ID.
</Note>

## Operations

<CardGroup cols={2}>
  <Card title="health" icon="heart-pulse" href="/apis/health">
    Unauthenticated liveness check for the API and its services.
  </Card>

  <Card title="me" icon="user" href="/apis/me">
    Identify the caller: a `User` (userToken) or `WorkspaceUser` (workspaceToken).
  </Card>

  <Card title="Clients" icon="users" href="/apis/clients">
    Create clients, list and fetch them, and add documents to a binder.
  </Card>

  <Card title="Tasks" icon="list-check" href="/apis/tasks">
    List background tasks and check a single task's status.
  </Card>

  <Card title="Conventions" icon="ruler" href="/apis/conventions">
    Scalars, IDs, pagination, sorting, and filtering.
  </Card>
</CardGroup>

## Guides

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/guides/authentication">
    Create an API key and exchange it for an access token.
  </Card>

  <Card title="Making requests" icon="code" href="/guides/making-requests">
    Request shape, variables, and the error model.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/guides/quickstart">
    Zero to a processed client in five steps.
  </Card>

  <Card title="Uploading documents" icon="upload" href="/guides/uploading-documents">
    Stage files through the resumable upload endpoint, then attach them.
  </Card>
</CardGroup>

## A first request

Confirm your token works with [`me`](/apis/me):

```bash cURL theme={null}
curl -X POST https://router.apps.filed.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_WORKSPACE_TOKEN" \
  -d '{ "query": "query { me { __typename ... on WorkspaceUser { workspace { id name } } } }" }'
```