Management API

Create Action

POST/v1/action

Programmatically register a new Action in a Meebly environment. Actions define the API endpoints that agents can call on your behalf.

Definition

Headers

bash

X-API-Key: YOUR_API_KEY

Body Parameters

Parameter	Type	Required	Description
`environmentId`	string	Yes	ID of the environment to create the action in
`operationName`	string	Yes	Unique name for this action (e.g. `getOrderStatus`)
`method`	string	Yes	HTTP method: `GET`, `POST`, `PUT`, `DELETE`, or `PATCH`
`path`	string	Yes	Endpoint path (e.g. `/orders/:id`)
`headers`	object	No	Custom headers sent with the request. Use `{{token}}` in values for runtime auth token substitution.
`systemInstructions`	string	No	Instructions describing what this action does and when agents should call it
`inputFields`	object	No	Schema of inputs the agent must supply when calling this action
`backendUrlOverride`	string	No	Overrides the environment's default backend URL for this action only
`contentType`	string	No	Content type sent to the backend. Defaults to `application/json`
`requestConfirmation`	boolean	No	When `true`, the agent pauses and requests human approval before executing (HITL)
`successUrl`	string	No	URL or fragment to redirect to after successful execution

Response

Returns 201 Created with the newly created action object.

json

{
  "id": "action_abc123",
  "operationName": "getOrderStatus",
  "method": "GET",
  "path": "/orders/:orderId",
  "headers": { "Authorization": "Bearer {{token}}" },
  "environmentId": "env_xyz789",
  "systemInstructions": "Retrieves the current status of a customer order.",
  "inputFields": {
    "orderId": "string"
  },
  "createdAt": "2025-01-15T12:00:00Z"
}

Store the id returned in the response — you will need it when attaching this action to an agent via the toolIds field.

Sample Request

bash

curl -X POST "https://api.meebly.ai/v1/action" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "environmentId": "env_xyz789",
    "operationName": "getOrderStatus",
    "method": "GET",
    "path": "/orders/:orderId",
    "headers": { "Authorization": "Bearer {{token}}" },
    "systemInstructions": "Retrieves the current status of a customer order.",
    "inputFields": { "orderId": "string" }
  }'

PreviousCreate App NextCreate Agent

Last updated: March 2026Report an issue