Chatbot Operations

Get an action

Retrieves a specific action by name or index for the specified chatbot. Send exactly one of name or index.

get/get-action/{chatbotId}

Request

  • Base URL: https://api.chat-data.com/api/v2
  • URL: https://api.chat-data.com/api/v2/get-action/{chatbotId}
  • Auth: HTTP bearer

Path parameters

chatbotIdstring required

The unique identifier allocated to the chatbot.

Query parameters

namestring
Example:stockPriceLookup

The name of the action to retrieve (mutually exclusive with index).

indexinteger

The index of the action to retrieve (mutually exclusive with name).

Response

Successfully retrieved action.

status'success'

Example response

{
  "action": {
    "index": 0,
    "name": "stockPriceLookup",
    "description": "The user wants to know the current stock price of a company",
    "type": "api",
    "url": "https://api.example.com/stocks/{symbol}/price",
    "method": "GET",
    "headers": [
      {
        "name": "Authorization",
        "value": "Bearer stk_live_3f9a2c7d1e"
      }
    ],
    "pathParams": [
      {
        "name": "symbol",
        "type": "string",
        "description": "The stock ticker symbol to look up.",
        "required": true,
        "example": "AAPL"
      }
    ],
    "return_file": false
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.