Functions

Deploy function

Deploy a function to the serverless runtime platform asynchronously. Deployment happens in the background and may take 10-60 seconds.

You’ll receive a 202 Accepted response immediately. To check deployment status:

Poll GET /functions/ to monitor status field
Wait for status to change from ‘draft’ to ‘deployed’ (success) or ‘error’ (failure)
Check last_deployed_at timestamp to confirm deployment completion

Deployment process:

For cloudflare_worker: Code is deployed to Cloudflare’s global edge network
For supabase_function: Code is deployed to Supabase Edge Functions with Deno runtime

Deployment will fail (status=‘error’) if:

Function code has syntax errors
Function type is ‘supabase_function’ but no Supabase project is configured
Runtime platform API is unavailable

After successful deployment, the function is immediately available for invocation via POST /functions//invoke.

POST

functions

{function_id}

deploy

Deploy function

curl --request POST \
  --url https://api.kapso.ai/platform/v1/functions/{function_id}/deploy \
  --header 'X-API-Key: <api-key>'

{
  "message": "Function deployment initiated",
  "function_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "deploying"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

function_id

string<uuid>

required

Function identifier

Response

Deployment initiated successfully (processing in background)

Async deployment response (HTTP 202 Accepted). Deployment happens in the background and may take 10-60 seconds. Poll GET /functions/{id} to check when status changes from 'draft' to 'deployed' (or 'error' if deployment fails).

message

string

required

Deployment confirmation message

Example:

"Function deployment initiated"

function_id

string<uuid>

required

ID of the function being deployed

status

string

required

Deployment status indicator

Example:

"deploying"

Invoke functionExecute a deployed serverless function with a custom JSON payload. The request body is forwarded directly to your function code. Request payload structure is completely flexible - send any valid JSON that your function expects. Your function receives the payload as the request body and can parse it however needed. Successful response behavior depends on `invoke_response_mode`: - New functions default to `passthrough`, so Kapso forwards the function response body, success status code, and `Content-Type` directly - Legacy wrapped functions can keep `wrapped`, which preserves the legacy API shape and returns successful JSON results under `data` The function must be in 'deployed' status to be invoked. If the function is in 'draft' or 'error' status, the request will fail with 422 validation error. Authentication: - Private functions require `X-API-Key` - Public Cloudflare functions (`public_endpoint=true`) can be invoked without an API key - Private and unknown functions both return `404` from this route Execution tracking: - All invocations are tracked with timing and request/response data - Failed invocations return an `invocation_id` for debugging - Check function invocation history via GET /functions/{id} (extended view) Error handling: - Function execution errors are captured and returned with details - Errors are truncated to 512 characters for storage - Original error context is preserved in invocation record

Deploy function

curl --request POST \
  --url https://api.kapso.ai/platform/v1/functions/{function_id}/deploy \
  --header 'X-API-Key: <api-key>'

{
  "message": "Function deployment initiated",
  "function_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "deploying"
}