POpoll-the-people
Agent Actions

Update built-in action settings.

Changed on
put/api/v1/projects/{projectId}/actions/builtin/{actionKey}/settings

Request

Path parameters

projectIdinteger required
Example:1

The unique agent identifier.

actionKeystring required
Example:document_analyst

Action key (built-in tool key such as "document_analyst", or custom action tool_key such as "custom_mcp_connector_abc123").

Request body

Example request

{
  "settings": {
    "document_source": "both",
    "allowed_file_types": [
      "pdf"
    ],
    "max_file_size": 50,
    "max_files_per_prompt": 3,
    "max_file_length": 50000,
    "max_image_size": 7000,
    "enable_reranker": true,
    "target_url": "https://customgpt.ai",
    "required_fields": [
      "email"
    ],
    "extra_options": [
      "company"
    ],
    "use_case": "book_a_call",
    "custom_use_case": "Other",
    "button_triggers": [
      "every_response"
    ],
    "extra_trigger_options": [
      "contact_sales"
    ],
    "button_title": "Book a call",
    "cta_value": "https://customgpt.ai"
  }
}

Response

Built-in action settings updated.

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "action": {
      "key": "lead_capture",
      "name": "Lead Capture",
      "is_enabled": true
    }
  }
}

Changes