A few words come up on every page of these docs.
| Term | Meaning |
|---|---|
| Organization | The account that owns the plan, the billing and the workspaces. Pro, Agency and lifetime plans belong to the organization. |
| Workspace | A place where a team keeps its files and pages. It has a library, members, transfers, requests and brands. A workspace has no plan of its own. |
| Workspace key | The permanent 8-character code that names a workspace in the API. GET /workspaces lists the keys you can use. |
| Library | The files and folders of a workspace. Some folders are protected (File requests, team folders, transfer folders) and the API cannot change them. |
| Token | A secret that proves who is calling. It belongs to a person. |
| Scope | What a token may do, such as files:read. See Authentication. |
| Role | What a person may do in a workspace: owner, admin or member. A token never goes beyond its creator’s role. |
| Problem document | The JSON shape of every API error, with a stable code. See Errors. |
How the pieces fit
Organization (plan, billing)
└─ Workspace (key abcd1234)
├─ Library: files and folders
├─ Brands
├─ Transfers, file requests, feedback
└─ Members and rolesA call names a workspace with its key, is checked against the token’s scope, and is then checked against the creator’s role in that workspace.
Where to go next
- Quickstart
- Product areas: what each part of Tarkle is and what the API covers today.
- API reference