Workspaces

#signup

stable

Create an account, workspace and account key (shown once)

REST

POST /v1/signup no authentication

JSON body: the arguments in the table above, as an object.

Example

curl -s -X POST "https://app.agentdb.link/v1/signup"

#signup.config

stable

Signup availability, terms and quotas

REST

GET /v1/signup no authentication

Example

curl -s "https://app.agentdb.link/v1/signup"

#workspace.import

stable

Import a data-export bundle (a file of this workspace) into a NEW workspace of your account (dry_run first)

REST

POST /v1/workspaces/{ws}/workspace-imports scope records:read

JSON body: the arguments in the table above, as an object.

Example

curl -s -X POST "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/workspace-imports" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"

#workspace.info

stable

Workspace details and quota usage

REST

GET /v1/workspaces/{ws} scope schema:read

Example

curl -s "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"

#workspace_create

stable added in 0.2.0-alpha.8 changes data

Create a new, empty workspace (an isolated project with its own schema and records) in the user's account. Needs an account key. Returns its id; pass it as workspace on later calls.

MCP tool

workspace_create

REST

POST /v1/account/workspaces scope schema:write

CLI

agentdb workspace create

Arguments

Example

{
  "tool": "workspace_create",
  "arguments": {
    "name": "Example CRM",
    "slug": "example-crm"
  }
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_create",
    "arguments": {
      "name": "Example CRM",
      "slug": "example-crm"
    }
  }
}

curl -s -X POST "https://app.agentdb.link/v1/account/workspaces" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"

agentdb workspace create [options] [name]

#workspace_delete

stable added in 1.0.0-rc.8 changes data destructive

Not available to agents since rc.8: always FORBIDDEN (reason explorer_only). Deleting a workspace is only possible in the explorer: tell the person to sign in to /app as the owner and use the Settings tab (offer a final export first).

MCP tool

workspace_delete

REST

POST /v1/workspaces/{ws}/delete scope schema:write

CLI

agentdb workspace delete

Arguments

Example

{
  "tool": "workspace_delete",
  "arguments": {
    "workspace": "example-crm",
    "confirm_name": "Example CRM"
  }
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_delete",
    "arguments": {
      "workspace": "example-crm",
      "confirm_name": "Example CRM"
    }
  }
}

curl -s -X POST "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/delete" \
  -H "Authorization: Bearer $AGENTDB_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"confirm_name":"Example CRM"}'

agentdb workspace delete [options] <workspace>

#workspace_get

stable added in 0.2.0-alpha.8 read-only

Show one workspace (id, name, slug, default) by id, slug or name; without workspace, the default one.

MCP tool

workspace_get

Arguments

Example

{
  "tool": "workspace_get",
  "arguments": {
    "workspace": "example-crm"
  }
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_get",
    "arguments": {
      "workspace": "example-crm"
    }
  }
}

#workspace_info

stable added in 0.2.0-alpha.4 or earlier read-only

Show the workspace this connection is bound to, your permission scopes and service limits. principal {kind, id, role, key_type, via}: key_type is account (reaches all your workspaces) or workspace, as in workspace_list; via is oauth (MCP connector), api_key, session or automation.

MCP tool

workspace_info

CLI

agentdb workspace info

Arguments

Example

{
  "tool": "workspace_info",
  "arguments": {}
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_info",
    "arguments": {}
  }
}

agentdb workspace info [options]

#workspace_list

stable added in 0.2.0-alpha.8 read-only

List the workspaces this connection can use (id, name, slug, default). Use it to find a workspace the user names. Also returns key_type (account or workspace) and via (oauth, api_key or session), the same values workspace_info reports.

MCP tool

workspace_list

REST

GET /v1/account/workspaces scope schema:read

CLI

agentdb workspace list

Arguments

No arguments.

Example

{
  "tool": "workspace_list",
  "arguments": {}
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_list",
    "arguments": {}
  }
}

curl -s "https://app.agentdb.link/v1/account/workspaces" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"

agentdb workspace list [options]

#workspace_rename

stable added in 0.2.0-alpha.8 changes data

Change a workspace's name and/or slug. Its id, schema and data stay the same.

MCP tool

workspace_rename

REST

PATCH /v1/workspaces/{ws} scope schema:write

CLI

agentdb workspace rename

Arguments

Example

{
  "tool": "workspace_rename",
  "arguments": {
    "workspace": "example-crm",
    "name": "Example CRM (archive)"
  }
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_rename",
    "arguments": {
      "workspace": "example-crm",
      "name": "Example CRM (archive)"
    }
  }
}

curl -s -X PATCH "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"

agentdb workspace rename [options] <workspace> <name>

#workspace_restore

stable added in 1.0.0-rc.8 changes data

Not available to agents since rc.8: always FORBIDDEN (reason explorer_only). A pending deletion is cancelled in the explorer: the owner signs in to /app and presses Restore under Settings.

MCP tool

workspace_restore

REST

POST /v1/workspaces/{ws}/restore scope schema:write

CLI

agentdb workspace restore

Arguments

Example

{
  "tool": "workspace_restore",
  "arguments": {
    "workspace": "example-crm"
  }
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_restore",
    "arguments": {
      "workspace": "example-crm"
    }
  }
}

curl -s -X POST "https://app.agentdb.link/v1/workspaces/$AGENTDB_WORKSPACE/restore" \
  -H "Authorization: Bearer $AGENTDB_TOKEN"

agentdb workspace restore [options] <workspace>

#workspace_select

stable added in 0.2.0-alpha.8 read-only

Resolve the workspace the user means (by id, slug or exact name) and use it from now on: pass the returned id as workspace on every later call. The server keeps no selection between calls; agentdb mcp proxy also remembers it for this session. Ambiguous or unknown names return an error listing the candidates: ask the user.

MCP tool

workspace_select

Arguments

Example

{
  "tool": "workspace_select",
  "arguments": {
    "workspace": "Example CRM"
  }
}

{
  "tool": "agentdb_execute",
  "arguments": {
    "operation": "workspace_select",
    "arguments": {
      "workspace": "Example CRM"
    }
  }
}