Skip to main content
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 and the token exchange needs a Bearer token. Most operations act on a workspace and need a workspaceToken; see Authentication to create an API key and exchange it for a token.
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.

​
Operations

health

Unauthenticated liveness check for the API and its services.

me

Identify the caller: a User (userToken) or WorkspaceUser (workspaceToken).

Clients

Create clients, list and fetch them, and add documents to a binder.

Tasks

List background tasks and check a single task’s status.

Conventions

Scalars, IDs, pagination, sorting, and filtering.

​
Guides

Authentication

Create an API key and exchange it for an access token.

Making requests

Request shape, variables, and the error model.

Quickstart

Zero to a processed client in five steps.

Uploading documents

Stage files through the resumable upload endpoint, then attach them.

​
A first request

Confirm your token works with me:
cURL
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 } } } }" }'