functions

Execute function

Manually execute a function with custom payload. Payload is merged with auto-injected trigger context. Rate limited (data mutation rate limiter). Enforces maxExecutionsPerMinute/maxExecutionsPerHour.

POST/api/functions/projects/{projectId}/functions/{functionId}/execute

Authentication

Requires JWT Requires API Key JWT or API Key
Note
This endpoint accepts either JWT Bearer token or API Key. Use Authorization: Bearer YOUR_TOKEN for user context, or X-API-Key: YOUR_KEY for server-to-server. View authentication guide →Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Include your API key in the X-API-Key: YOUR_KEY header (server-to-server, SDKs). View authentication guide →

Path Parameters

NameTypeRequiredDescription
projectIdstringYesProject ID (MongoDB ObjectId) that owns the function.
functionIdstringYesFunction ID (MongoDB ObjectId) to execute.

Request Body

Optional JSON payload merged with trigger context (e.g. document, file, webhook body). Omit for no custom input.

json
{
  "payload": {}
}
{
  "payload": {}
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.functions.execute({
  projectId: "proj_EwwhbTtTQYHn",
  functionId: "sb4DfzBYnaxvvkta",
  payload: "port generate"
});
const result = await client.functions.execute({
  projectId: "proj_EwwhbTtTQYHn",
  functionId: "sb4DfzBYnaxvvkta",
  payload: "port generate"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

Get your API key from the console
Use the auth endpoints to obtain a JWT.

No Request Yet

Send a request to see the full inspector

Responses

200Function executed successfully

Successful execution

json
{
  "success": true,
  "data": {
    "success": true,
    "result": {
      "processed": 1,
      "count": 5
    },
    "executionTime": 125
  }
}
{
  "success": true,
  "data": {
    "success": true,
    "result": {
      "processed": 1,
      "count": 5
    },
    "executionTime": 125
  }
}

Execution failed

json
{
  "success": false,
  "error": "ReferenceError: x is not defined",
  "data": {
    "success": false,
    "error": "ReferenceError: x is not defined",
    "executionTime": 15
  }
}
{
  "success": false,
  "error": "ReferenceError: x is not defined",
  "data": {
    "success": false,
    "error": "ReferenceError: x is not defined",
    "executionTime": 15
  }
}
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
429Rate limit exceeded

Errors

CodeMeaning
400Bad request or validation error.
401Authentication required or invalid token.
403Access denied or insufficient permissions.
429Rate limit exceeded

Next steps

Edit this page on GitHub