Modules

Add module

post/api/v1/agents/{agent}/steps

Request

  • Base URL: https://www.cysora.com
  • URL: https://www.cysora.com/api/v1/agents/{agent}/steps
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Request body

positioninteger required

1-based position to insert the module at. Position 0 is reserved for the pinned needs-discovery step.

appTypestring required

Block type of the module, e.g. 'booking', 'signup', 'similar_examples', 'identify_products'.

configobject

Optional block-specific configuration object.

rulesstring

Optional plain-language guidance the agent follows for this step. Stored as config.rules (wins over config.rules when both are sent).

Response

Success.

Changes

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