Home How to Request a Controlled Flow from the Cloud Humans Team
💡

How to Request a Controlled Flow from the Cloud Humans Team

Best practices for requesting an Eddie from the Cloud Humans team
Tech
By Jordana Cruz and 1 other
• 6 articles

API Requirements for Use in Controlled Flow

📄Model Document for Usage**:** API Specification Document 1. What API information do we need to receive? - To configure Controlled Flow with any API, the documentation must provide the following data. 1.1 API Endpoint: - Main Base URL. - Specific endpoint that will be used by Controlled Flow. 2. Where to get or generate the API access key? 2.1 API Key: - Information on where to generate or access the API key. - If you already have the key, just send it. 2.2 Does the API use a generated token? - If the API requires a token generated via another endpoint, we need: - Endpoint responsible for generating the token. - Necessary credentials. - Expected response format. 3. API Documentation - The documentation should be up-to-date and include: - Description of the endpoints. - Supported methods. - Recent payload example. - Structure of fields that Controlled Flow will need to extract. 4. What parameters do we need to test the API? - Test parameter examples: - Email - CPF - Order number - Other identifiers used by the API. 5. Examples of Ideal Documentation - An ideal documentation should contain: - Base URL + detailed endpoints. - Method (GET, POST, PUT, DELETE). - Necessary headers. - Request example (JSON). - Response example (JSON). - Explanation of each field. - Authentication flow (if any). 6. Common errors and how to handle them. The documentation should list the main errors returned by the API, with clear explanations so we can identify, interpret, and correct them properly in case of failures. It's important to include: 1. Most common HTTP codes, such as: - *400 (Bad Request), - 401 (Unauthorized), - 403 (Forbidden), - 404 (Not Found), - 409 (Conflict), - 422 (Unprocessable Entity), - 429 (Too Many Requests), - 500 (Internal Server Error).* 2. Probable cause description for each error, for example: - Invalid or missing parameters. - Authentication failure or expired token. - Excessive requests (rate limit). - Endpoint temporarily unavailable. - Internal server error of the API. 3. Error response example, including the JSON format returned and relevant fields, such as: - error - message - code 4. Guidelines for correction or handling, such as: - Generate or renew the token. - Adjust required parameters. - Wait a few seconds before resending (in case of 429).

Last updated on Jun 24, 2026

[Start Here] How to Request a Controlled Flow (Automation) for ClaudIA

How to Request a Controlled Flow (Automation) for ClaudIA This FAQ helps your team request new automated Controlled Flows for ClaudIA, ensuring that everything is sent clearly, completely, and standardized. This prevents rework, speeds up implementations, and increases the accuracy of ClaudIA's responses. To request a new Controlled Flow, your company must send: (1) The business description of the flow — what it should do, when it is triggered, what data the user should provide, business rules, and examples of desired conversation. (2) The complete technical specification — endpoints, payloads, possible responses (200/400/404/500), authentication, limits, and any configuration needed for integration. Example of a well-specified flow: With these two parts complete, Cloud Humans can quickly set up the flow and enable ClaudIA to perform automated actions in your service. ✔ Important: All requests must be sent exclusively through the Account Manager responsible for your account. They will validate the request, review if all necessary information has been included, and forward it to the Cloud Humans technical team for implementation. The Controlled Flows Team prioritizes building flows focused on retaining new cases through ClaudIA. Check with your AM about extra packages (at additional cost) for professional services to build generic flows. Additional FAQs: 📌 PART 1 — How to specify the flow 🧩 PART 2 — Technical Specification (Tech Layer)

Last updated on Jun 24, 2026

📌 PART 1 — How to Specify the Flow

1. What is a Controlled Flow? Controlled Flow is the automation module of Cloud Humans that performs actions for ClaudIA, such as: - checking order status, - verifying payments, - generating invoices, - fetching data from your system, - creating tickets, - updating records, - consulting sensitive information. ClaudIA identifies the user's intent and triggers the corresponding Controlled Flow. 2. When does it make sense to request a new Controlled Flow? Request a flow when you need ClaudIA to do something that cannot be answered with content alone and has an impact on case resolution without the need for human intervention. ✓ When support requires external queries (API, ERP, CRM, Billing, etc.) - Request product exchange, Send invoice, Check delivery address, etc. ✓ When dependent on dynamic information - Request status, Order progress, etc. ✓ When involving data validation - CPF/CNPJ lookup to provide sensitive information ✓ When involving process execution (e.g., generate second copy) - Second copy of invoice or boleto, Send Invoice. 3. What are the triggers for the flow? < (review the explanation in the interactive content section + screenshots) > The Controlled Flow is triggered when ClaudIA detects a Configured Interactive Content in the panel. This content acts as the trigger. 1. Access the ClaudIA Panel and go to Content 2. Create or edit a content and select Content type "INTERACTIVE". When switching to Interactive, the option to choose the Flow appears. 3. Choose the published Controlled Flow, add a tag, and save. Done: whenever this content is triggered, it activates the flow. Define how ClaudIA recognizes it should trigger the flow: Examples: - “order inquiry”, - “track delivery”, - “second copy”, - “subscription check”. 4. What data does the user need to provide? List all mandatory data: Examples of primary keys: - CPF / CNPJ - Email - Order number - Phone - Registration number - Birth date - Unique code 5. What validations need to be performed before triggering the flow? Examples: - CPF must have 11 digits. - Order should start with “ABC-”. - Email must be valid. - CNPJ must have 14 digits. - If the field is empty, request again. (Simple validations prevent errors before calling your system.) 6. What are the business rules of the flow? Explain the behavior the Controlled Flow should follow, whether a happy or unhappy path: Example: - What to do if one result is found? - What to do if multiple results are found? - What to do if none are found? - After how many attempts escalate to a human? - Is there a daily query limit? 7. Specify the end of the flow among the 4 options: - Forward to human: Forward to a human (N2). - End Flow: Forward to ClaudIA and wait for the customer’s response (N1). - Answer ticket: Forward to ClaudIA to respond immediately (N1). - Close ticket: Finalize the ticket within the flow (N1). 8. Example of the ideal deliverable (No mandatory tool for submission; in this example, Miro was used) Link: <FLOW LINK>***

Last updated on Aug 29, 2026