API
Read and change your Solid data with REST or GraphQL endpoints generated from your own data model.
Solid generates its API from your data model. Custom objects get the same endpoints as the standard ones, named after your own objects and fields.
Two APIs
| API | Path | Use it to |
|---|---|---|
| Core | /rest/ or /graphql/ | Create, read, update and delete records |
| Metadata | /rest/metadata/ or /metadata/ | Manage objects, fields and workspace settings |
REST and GraphQL reach the same data. GraphQL also fetches related records in one call and supports batch upserts.
Authentication
Send an API key with every request:
Authorization: Bearer YOUR_API_KEYTo create a key:
- Go to Settings → APIs & Webhooks.
- Click + Create key, give it a name and an expiry date.
- Copy the key right away. It is shown only once.
An API key gives access to your data. Assign it a limited role in Settings → Members → Roles, and delete it as soon as it is no longer needed.
A first request
List companies with REST:
curl https://YOUR_SOLID_URL/rest/companies \
-H "Authorization: Bearer YOUR_API_KEY"Create a record in a custom object named Contracts:
curl -X POST https://YOUR_SOLID_URL/rest/contracts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Acme 2026 renewal"}'Replace YOUR_SOLID_URL with your workspace address.
Your workspace's reference
Because the API follows your data model, its full reference is generated per workspace. Open Settings → APIs & Webhooks, create a key, and choose REST API or GraphQL API to browse and try every endpoint in the playground.