API Reference

Action

Endpoints for managing actions attached to Pickaxes and Agents.

Related In Learn

Actions

Connect your agents to external tools, APIs, and other agents so they can take real actions.

Open Learn

Action endpoints manage actions attached to Pickaxes and Agents.

Endpoints

GET /studio/action/list?pickaxeId=<pickaxe_id>

List available actions and actions attached to a Pickaxe.

Full URL: https://api.pickaxe.co/v1/studio/action/list?pickaxeId=<pickaxe_id>

Request Fields

pickaxeId (string, required): The Pickaxe ID to inspect for currently attached and available actions.

Examples

curl -X GET "https://api.pickaxe.co/v1/studio/action/list?pickaxeId=steve-25" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"

Response Shape

{
  "success": true,
  "data": {
    "available": [
      {
        "actionId": "ACTIONDMU9TKI49FKPOHSJQOKI",
        "name": "get_current_time",
        "displayName": "Get Current Time",
        "description": "Gets the current time if the user asks for it.",
        "visibility": "public",
        "triggerPrompt": "",
        "isAttached": false,
        "isUsingPickaxeCredits": false,
        "variables": []
      }
    ],
    "attached": [],
    "pickaxeId": "steve-25"
  }
}

POST /studio/action/connect

Attach an action to a Pickaxe.

Full URL: https://api.pickaxe.co/v1/studio/action/connect

Request Fields

pickaxeId (string, required): The Pickaxe ID to attach the action to.
actionId (string, required): The action ID to attach.
triggerPrompt (string, optional): Optional trigger prompt for when the action should run.
isUsingPickaxeCredits (boolean, optional): Whether action execution should consume Pickaxe credits when applicable. Defaults to false.

Examples

curl -X POST https://api.pickaxe.co/v1/studio/action/connect \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "pickaxeId": "steve-25",
  "actionId": "ACTIONDMU9TKI49FKPOHSJQOKI",
  "triggerPrompt": "optional",
  "isUsingPickaxeCredits": false
}'

Response Shape

{
  "actionId": "ACTIONDMU9TKI49FKPOHSJQOKI",
  "name": "get_current_time",
  "displayName": "Get Current Time",
  "description": "Gets the current time if the user asks for it.",
  "visibility": "public",
  "triggerPrompt": "",
  "isAttached": true,
  "isUsingPickaxeCredits": false,
  "variables": []
}

POST /studio/action/disconnect

Remove an action from a Pickaxe.

Full URL: https://api.pickaxe.co/v1/studio/action/disconnect

Request Fields

pickaxeId (string, required): The Pickaxe ID to disconnect the action from.
actionId (string, required): The action ID to disconnect.

Examples

curl -X POST https://api.pickaxe.co/v1/studio/action/disconnect \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "pickaxeId": "steve-25",
  "actionId": "ACTIONDMU9TKI49FKPOHSJQOKI"
}'

Response Shape

{
  "pickaxeId": "steve-25",
  "actionId": "ACTIONDMU9TKI49FKPOHSJQOKI"
}

Agent

MCP