Getting started

Here's a guide to Fabric's REST API.

Fabric's API endpoint

https://api.fabric.so

Authentication

Fabric supports personal API keys and OAuth 2.0 authentication method. We will allow creation of OAuth 2.0 clients in the future.

OAuth 2.0 (coming soon)

If you’re building an application for others to use, we recommend you use OAuth2 authentication. Once you complete the authentication flow and acquire an access token, pass it with the header Authorization: Bearer <ACCESS_TOKEN>.

Example OAuth token usage:

curl https://api.fabric.so/v2/<endpoint> \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{}'

Personal API key

For personal usage, API keys are the easiest way to access and use the Fabric API. Visit your Settings create and manage them.

To authenticate your requests, you need to pass the API key with the header: X-Api-Key: <API_KEY>.

Developer API key

For developers a developer account needs to be created. The developer API key can create and manage delegated workspaces which can be used, for example, to store memories and notes for a specific user.

To authenticate your requests, you need to pass the API key with the header: X-Api-Key: <API_KEY>.

To query a specific delegated workspace, you need to pass the workspace ID with the header: X-Fabric- Workspace-Id: <WORKSPACE_ID>.

More on how to manage workspaces can be found here.

Example API key usage:

curl https://api.fabric.so/v2/<endpoint> \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN' \
  --data '{}'

Available API endpoints

You can find documented endpoints under the API reference.

You can select your desired method of authentication and the client code language/library you're intending to use to get better code examples.