WorkerCreationMonthlyArgs

  • day
    Type: integer
    min:  
    1
    max:  
    31
    required

    Integer numbers.

  • frequency
    enum
    const:  
    monthly
    required
    values
    • monthly
  • hour
    Type: integerenum
    required

    The hour of the day (0-23) when the agent should run.

    values
    • 0
    • 1
    • 2
    • 3
    • 4
  • name
    Type: string
    min length:  
    1
    max length:  
    255
    required
  • prompt
    Type: string
    min length:  
    1
    required

    The prompt that the worker will use when it runs.

  • accessResourceIds
    Type: array string[] | null · UUID[]

    Optional list of resource IDs that the worker will have access to when running. Providing this will restrict the worker's access to only these resources and their descendants.

    • Type: string · UUID Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
  • active
    Type: boolean

    Whether the worker is scheduled to run automatically.

  • focusResourceIds
    Type: array string[] | null · UUID[]

    Optional list of resource IDs that the worker should focus on when running. This only provides a hint and does not change the worker's permissions.

    • Type: string · UUID Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-8][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
  • timezone
    Type: string | null
    max length:  
    255

    The timezone that the worker should use for scheduling in IANA format (e.g. "America/Toronto").

  • toolPermissions

    Optional permissions for tools that the worker can use when running. Providing this will restrict the worker's tool usage to only the specified permissions.

    • native
      Type: object