Pickaxe Learn

API Reference

Workspace

Authenticated workspace context and workspace-level metadata endpoints.


Workspace endpoints manage authenticated workspace context and workspace-level metadata.

Endpoints

GET /studio/whoami

Return the authenticated workspace API key context.

  • Full URL: https://api.pickaxe.co/v1/studio/whoami

Request Fields

This endpoint does not define request body fields.

Examples

curl -X GET https://api.pickaxe.co/v1/studio/whoami \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response Shape

{
  "data": {
    "authMode": "workspace_api_key",
    "user": {
      "email": "carson@pickaxeproject.com",
      "name": null
    },
    "workspace": {
      "workspaceId": "5f90404a-f736-48c4-95df-d84cf886759b",
      "name": "WaveWatch"
    },
    "workspaceScope": "fixed",
    "capabilities": {
      "pickaxes": true,
      "deployments": true,
      "actions": true,
      "mcps": true,
      "accessGroups": true,
      "products": true,
      "aiBuild": true
    }
  }
}

GET /studio/workspace/list

List workspaces visible to the current API key.

  • Full URL: https://api.pickaxe.co/v1/studio/workspace/list

Request Fields

This endpoint does not define request body fields.

Examples

curl -X GET https://api.pickaxe.co/v1/studio/workspace/list \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response Shape

{
  "data": [
    {
      "workspaceId": "5f90404a-f736-48c4-95df-d84cf886759b",
      "name": "WaveWatch",
      "selected": true,
      "visibility": "public",
      "creator": "carson@pickaxeproject.com"
    }
  ]
}