Skip to main content
POST
/
functions
Create MCP server
curl --request POST \
  --url https://api.blaxel.ai/v0/functions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "my-resource",
    "displayName": "My Resource",
    "labels": {}
  },
  "spec": {
    "enabled": true,
    "integrationConnections": [
      "<string>"
    ],
    "policies": [
      "<string>"
    ],
    "public": false,
    "revision": {
      "active": "rev-abc123",
      "canary": "<string>",
      "canaryPercent": 10,
      "stickySessionTtl": 0,
      "traffic": 100
    },
    "runtime": {
      "envs": [
        {
          "name": "MY_ENV_VAR",
          "secret": true,
          "value": "my-value"
        }
      ],
      "generation": "mk3",
      "image": "<string>",
      "maxScale": 10,
      "memory": 2048,
      "minScale": 0,
      "transport": "http-stream"
    },
    "triggers": [
      {
        "configuration": {
          "authenticationType": "blaxel",
          "callbackUrl": "https://myapp.com/webhook",
          "path": "/invoke",
          "retry": 3,
          "schedule": "0 * * * *",
          "tasks": [
            {}
          ],
          "timeout": 300
        },
        "enabled": true,
        "id": "trigger-1",
        "type": "http"
      }
    ]
  }
}
'
{
  "metadata": {
    "name": "my-resource",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "My Resource",
    "labels": {},
    "plan": "<string>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "spec": {
    "enabled": true,
    "integrationConnections": [
      "<string>"
    ],
    "policies": [
      "<string>"
    ],
    "public": false,
    "revision": {
      "active": "rev-abc123",
      "canary": "<string>",
      "canaryPercent": 10,
      "stickySessionTtl": 0,
      "traffic": 100
    },
    "runtime": {
      "envs": [
        {
          "name": "MY_ENV_VAR",
          "secret": true,
          "value": "my-value"
        }
      ],
      "generation": "mk3",
      "image": "<string>",
      "maxScale": 10,
      "memory": 2048,
      "minScale": 0,
      "transport": "http-stream"
    },
    "triggers": [
      {
        "configuration": {
          "authenticationType": "blaxel",
          "callbackSecret": "<string>",
          "callbackUrl": "https://myapp.com/webhook",
          "path": "/invoke",
          "retry": 3,
          "schedule": "0 * * * *",
          "tasks": [
            {}
          ],
          "timeout": 300
        },
        "enabled": true,
        "id": "trigger-1",
        "type": "http"
      }
    ]
  },
  "events": [
    {
      "canaryRevision": "<string>",
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "status": "DELETING"
}

Authorizations

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Body

application/json

MCP server deployment that exposes tools for AI agents via the Model Context Protocol (MCP). Deployed as a serverless auto-scaling endpoint using streamable HTTP transport.

​
metadata
object
required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

​
spec
object
required

Configuration for an MCP server function including runtime settings, transport protocol, and connected integrations

Response

successful operation

MCP server deployment that exposes tools for AI agents via the Model Context Protocol (MCP). Deployed as a serverless auto-scaling endpoint using streamable HTTP transport.

​
metadata
object
required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

​
spec
object
required

Configuration for an MCP server function including runtime settings, transport protocol, and connected integrations

​
events
object[]

Events happening on a resource deployed on Blaxel

​
status
enum<string>

Deployment status of a resource deployed on Blaxel

Available options:
DELETING,
TERMINATED,
FAILED,
DEACTIVATED,
DEACTIVATING,
UPLOADING,
BUILDING,
DEPLOYING,
DEPLOYED