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

# Create Task

> Create a scheduled task for an agent. Replaces `bot/heartbeat/configure` — a heartbeat was a task with a cron.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/bot/tasks/create
openapi: 3.0.0
info:
  title: BoostGPT API
  version: 1.0.0
  description: API for managing AI agents with memory capabilities
servers:
  - url: https://api.boostgpt.co
    description: Production server
security:
  - BearerAuth: []
tags:
  - name: Agent
    description: Operations for managing AI agents
  - name: Memory
    description: Operations for managing agent memory sources
  - name: Chat
    description: Operations for chatting with agents and managing conversations
  - name: Subscribers
    description: Operations for managing subscribers and leads
  - name: Tools
    description: Operations for managing agent tools and MCP server integrations
  - name: Analytics
    description: Operations for retrieving agent statistics and analytics
  - name: Tasks
    description: >-
      Scheduled tasks — recurring work an agent performs on its own. Replaces
      the Heartbeat API.
  - name: Email
    description: Operations for managing agent email functionality
  - name: Workflows
    description: Operations for managing agent workflow automations
  - name: Workspace
    description: Operations for managing agent workspaces and files
paths:
  /v1/bot/tasks/create:
    post:
      tags:
        - Tasks
      summary: Create Task
      description: >-
        Create a scheduled task for an agent. Replaces `bot/heartbeat/configure`
        — a heartbeat was a task with a cron.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTaskRequest'
      responses:
        '200':
          description: The created task
          content:
            application/json:
              schema:
                type: object
                properties:
                  task:
                    $ref: '#/components/schemas/TaskObject'
components:
  schemas:
    CreateTaskRequest:
      type: object
      required:
        - project_id
        - bot_id
        - name
        - prompt
      properties:
        project_id:
          type: string
          description: Project ID
        bot_id:
          type: string
          description: Agent ID
        name:
          type: string
          description: Task name, shown on the board
        prompt:
          type: string
          description: What the agent should do each run
        description:
          type: string
          description: Optional longer description
        schedule_type:
          type: string
          description: >-
            How the task repeats. `interval` uses
            `schedule_config.interval_minutes`; `cron` uses
            `schedule_config.cron`.
          enum:
            - once
            - daily
            - weekly
            - monthly
            - interval
            - cron
        schedule_config:
          type: object
          description: >-
            Shape depends on `schedule_type`: `{ interval_minutes }`, `{ time
            }`, `{ day, time }`, `{ day_of_month, time }` or `{ cron }`.
        timezone:
          type: string
          description: IANA timezone, e.g. Europe/London
        active_hours_start:
          type: string
          description: Only run at or after this time, HH:MM
        active_hours_end:
          type: string
          description: Only run before this time, HH:MM
        max_executions:
          type: integer
          description: Stop after this many runs. Omit for unlimited.
        chat_mode:
          type: string
          description: Conversation mode the run uses
        chat_id:
          type: string
          description: Bind the task to a Site's builder conversation
        assignee_type:
          type: string
          description: '`agent` or `member`'
        assignee_id:
          type: string
          description: UUID of the assignee
        tags:
          type: array
          items:
            type: string
        attachments:
          type: array
          items:
            type: object
    TaskObject:
      type: object
      properties:
        uuid:
          type: string
          description: Task UUID — this is `task_id` elsewhere
        bot_id:
          type: string
          description: Agent this task belongs to
        name:
          type: string
        description:
          type: string
        prompt:
          type: string
        purpose:
          type: string
          description: '`site_review` for a Site''s own review task, otherwise null'
        schedule_type:
          type: string
          description: >-
            How the task repeats. `interval` uses
            `schedule_config.interval_minutes`; `cron` uses
            `schedule_config.cron`.
          enum:
            - once
            - daily
            - weekly
            - monthly
            - interval
            - cron
        schedule_config:
          type: object
          description: >-
            Shape depends on `schedule_type`: `{ interval_minutes }`, `{ time
            }`, `{ day, time }`, `{ day_of_month, time }` or `{ cron }`.
        timezone:
          type: string
        enabled:
          type: boolean
        state:
          type: string
          description: Board column
        autonomy:
          type: string
          description: How far the agent may act unattended
        chat_mode:
          type: string
        active_hours_start:
          type: string
        active_hours_end:
          type: string
        execution_count:
          type: integer
        max_executions:
          type: integer
        error_count:
          type: integer
        max_consecutive_errors:
          type: integer
          description: Disabled after this many failures in a row
        last_executed_at:
          type: string
          format: date-time
        last_status:
          type: string
        last_reason:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Enter your API key

````