API Reference

Deployment

Endpoints for API deployments and deployment-level sharing settings.

Related In Learn

Deployments Overview

Learn about the different ways to deploy and share your agents with the world.

Open Learn

Deployment endpoints manage API deployments and deployment-level sharing settings.

Endpoints

GET /studio/deployment/list

List deployments in the current workspace.

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

Request Fields

This endpoint does not define request body fields.

Examples

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

Response Shape

{
  "data": [
    {
      "deploymentId": "deployment-6cdc2c26-2a9b-4f7d-8126-fd58913ab5a4",
      "name": "cli-test-steve (Direct Link)",
      "type": "direct-link",
      "visibility": "public",
      "formId": "steve-25",
      "pickaxeName": "cli-test-steve",
      "path": "deployment-6cdc2c26-2a9b-4f7d-8126-fd58913ab5a4",
      "createdAt": "2026-04-09T01:37:56.427000"
    }
  ]
}

POST /studio/deployment/create

Create a new public deployment for an existing Pickaxe in the caller's workspace.

Full URL: https://api.pickaxe.co/v1/studio/deployment/create

Request Fields

formId (string, required): The Pickaxe ID to deploy. You can also send this as formid or pickaxeId.
deploymentType (string, required): The deployment type to create. Accepted types are "inline", "iframe", "fab", "popup", and "direct-link".

Examples

curl -X POST https://api.pickaxe.co/v1/studio/deployment/create \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
  "formId": "FORM123",
  "deploymentType": "direct-link"
}'

Document

Memory