> ## Documentation Index
> Fetch the complete documentation index at: https://docs.duvo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Up Module

> Set up a Duvo Module (a ready-made solution such as AP Invoice Intake & Routing or Freight Audit) as a new Automation on the team, the same as pressing Set up on the Module in the web app. Creates the Module's Agents, code steps, Queues, Policy and dashboards in one call. If the team already has a demo of this Module open, the call is refused with 409 unless `convert_existing_demo` is true; then that demo becomes the Automation and its sample cases and Runs are deleted, so ask the user first. The Automation starts in setup and does not run yet: call `getAutomationReadiness` next to see what is left of the setup, the Policy questions, the current process and the automation proposal, whose approval builds the automation. Connections and routing come once the approved proposal is being built, so don't raise them before. Give the user the `url`.



## OpenAPI

````yaml https://api.duvo.ai/v2/documentation/mintlify.json post /v2/teams/{teamId}/modules/{slug}/automations
openapi: 3.0.3
info:
  title: Duvo Public API
  description: >-
    Public API for programmatic access to Duvo. Authenticate with API keys
    created in the Duvo dashboard.


    ## Rate limits


    Requests are counted per API key. Every response advertises the quota with
    the IETF RateLimit fields, so a client can self-throttle without waiting for
    a rejection:


    - `RateLimit-Policy: "default";q=<quota>;w=<window seconds>` — the policy in
    force: `q` requests per `w` seconds.

    - `RateLimit: "default";r=<remaining>;t=<seconds>` — the live state: `r`
    requests left, quota resetting in `t` seconds.

    - Read the quota from the headers rather than hard-coding it; it differs per
    environment.

    - The same numbers are also sent as `ratelimit-limit`, `ratelimit-remaining`
    and `ratelimit-reset`.


    Once the quota is exhausted the API answers `429 Too Many Requests` with
    `Retry-After` set to the seconds to wait; honor it instead of retrying
    immediately.
  version: 1.0.0
servers:
  - url: https://api.duvo.ai
    description: Production server
security: []
tags:
  - name: Runs
    description: Start, monitor, and manage agent runs (Runs in the Duvo UI)
  - name: Sandboxes
    description: Create sandboxes and upload files for agent runs
  - name: Queues
    description: Manage queues and their agent bindings
  - name: Cases
    description: Create, list, and manage cases and their labels within queues
  - name: Case Approvals
    description: Submit decisions on pending case approval requests issued by an agent run
  - name: Case Attachments
    description: Upload, list, download, and remove the files attached to a case
  - name: Automations
    description: >-
      List and manage automations — the workspace container that groups the
      agents and queues making up one end-to-end process
  - name: Agents
    description: Create and manage agents for automation workloads
  - name: Revisions
    description: Create and manage agent revisions — the underlying Setup for an Agent
  - name: Agent Folders
    description: Organize agents into folders
  - name: Agent Memory
    description: Read an agent's memory files (the Memory feature in the Duvo UI)
  - name: Suggestions
    description: >-
      List, apply, and dismiss an Agent's improvement suggestions (the
      suggestions inbox in the Duvo UI)
  - name: Notifications
    description: >-
      List, read, dismiss, and clear the authenticated user's team notifications
      (the Notification Center in the Duvo UI)
  - name: Schedules
    description: List schedules configured for an agent
  - name: Duvo Pulse
    description: >-
      Create, list, iterate on, and delete Duvo Pulse dashboards — live,
      agent-generated visualizations of your Duvo data
  - name: Case Triggers
    description: >-
      Configure case triggers that automatically dispatch agent runs (Runs in
      the Duvo UI) for cases added to a queue
  - name: Triggers
    description: >-
      Configure event triggers that start a Run automatically when an external
      event fires (e.g. an email arrives, a Linear issue is created, or a file
      changes in Google Drive)
  - name: Skills
    description: Manage team and system skills (reusable knowledge packs).
  - name: Files
    description: Manage team files.
  - name: Plugins
    description: Discover plugins that can be referenced from a revision.
  - name: Organizations
    description: Inspect organizations you belong to and the teams within them
  - name: Team
    description: Inspect the team and members associated with the API key
  - name: Invites
    description: >-
      Invite people to a team — one at a time or in bulk, scoped to a Clarity
      process or the whole team — and manage the team's shareable invite link
  - name: Integrations
    description: Browse the team's catalog of available integration types
  - name: Connections
    description: Manage your connected integrations
  - name: Credentials
    description: >-
      Manage logins (domain + username + password + TOTP) used by agents to sign
      in to websites and desktop applications, and attach them to assignment
      revisions
  - name: Secrets
    description: >-
      Manage env-var secrets injected into runs, and attach them to assignment
      revisions. Only metadata is exposed; values are never returned
  - name: Revision Integrations
    description: >-
      Attach integrations to assignment revisions, pin specific connections, and
      link queues
  - name: ClarityV2
    description: >-
      Manage Clarity v2 process snapshots, automation proposals, and the
      extra-capture-request follow-up loop
paths:
  /v2/teams/{teamId}/modules/{slug}/automations:
    post:
      tags:
        - Modules
      summary: Set Up Module
      description: >-
        Set up a Duvo Module (a ready-made solution such as AP Invoice Intake &
        Routing or Freight Audit) as a new Automation on the team, the same as
        pressing Set up on the Module in the web app. Creates the Module's
        Agents, code steps, Queues, Policy and dashboards in one call. If the
        team already has a demo of this Module open, the call is refused with
        409 unless `convert_existing_demo` is true; then that demo becomes the
        Automation and its sample cases and Runs are deleted, so ask the user
        first. The Automation starts in setup and does not run yet: call
        `getAutomationReadiness` next to see what is left of the setup, the
        Policy questions, the current process and the automation proposal, whose
        approval builds the automation. Connections and routing come once the
        approved proposal is being built, so don't raise them before. Give the
        user the `url`.
      operationId: setUpModule
      parameters:
        - schema:
            type: string
            enum:
              - chargebacks
              - freight-audit
              - inbound-to-store
              - mode-mix
              - ap-invoice-intake-routing
              - payables-audit
              - demand-supply-balancing
              - po-management
          in: path
          name: slug
          required: true
          description: >-
            Module template to set up, for example `ap-invoice-intake-routing`
            for AP Invoice Intake & Routing or `freight-audit` for Freight
            Audit.
        - name: teamId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              default:
                convert_existing_demo: false
              type: object
              properties:
                convert_existing_demo:
                  default: false
                  description: >-
                    Set true only after the user agreed to it: when the team
                    already has a demo of this Module open, that demo becomes
                    the Automation and its sample cases and Runs are deleted,
                    with no undo. Left false, such a call is refused with 409
                    and nothing changes.
                  type: boolean
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  automation_id:
                    type: string
                    format: uuid
                    description: The team's new Automation, built from the Module template.
                  name:
                    nullable: true
                    description: >-
                      The new Automation's name, or null when it could not be
                      read back after setup; the Automation exists either way.
                    type: string
                  is_setting_up:
                    type: boolean
                    enum:
                      - true
                    description: >-
                      Always true: the Automation starts in setup, with its
                      Policy, current process and automation proposal still to
                      do.
                  link:
                    nullable: true
                    description: >-
                      Root-relative web-app path to the Automation's setup
                      screen, or null when this viewer has no such tab.
                    type: string
                  url:
                    nullable: true
                    description: The full web-app URL of `link`.
                    type: string
                required:
                  - automation_id
                  - name
                  - is_setting_up
                  - link
                  - url
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key authentication. Get your API key from the Duvo dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.