> ## Documentation Index
> Fetch the complete documentation index at: https://vastai-80aa3a82-auto-openapi-update-79df5d46.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Scheduled Job

> Creates a new scheduled job that periodically calls a specified API endpoint on behalf of the authenticated user.



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/v0/commands/schedule_job/
openapi: 3.1.0
info:
  title: Vast.ai API
  description: >-
    Vast.ai REST API for managing GPU cloud instances, machine operations, and
    AI/ML workflows.


    ## AI Agent Quick-Start


    Install the CLI skill for your agent (Claude Code, Cursor, Windsurf, etc.):
      npx skills add vast-ai/vast-cli

    CLI reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai/SKILL.md

    SDK reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai_sdk/SKILL.md


    ## Auth

    All endpoints require `Authorization: Bearer $VAST_API_KEY`.

    Get your key at: https://cloud.vast.ai/manage-keys/


    ## Key Quirks

    - `gpu_ram` in CLI = GB; in REST API = MB (CLI auto-converts)

    - SSH keys must be registered BEFORE creating an instance (VM: no recovery;
    Docker: can add post-create)

    - `onstart` field is limited to 4048 characters -- gzip+base64 for longer
    scripts

    - `POST /api/v0/asks/{id}/` (create instance) returns `new_contract` as the
    instance ID, not `id`

    - Poll trap: if `actual_status` becomes `exited`, `unknown`, or `offline` it
    will never reach `running` -- destroy and retry
  version: 1.0.0
  contact:
    name: Vast.ai Support
    url: https://discord.gg/vast
servers:
  - url: https://console.vast.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/v0/commands/schedule_job/:
    post:
      tags:
        - Instances
      summary: Create Scheduled Job
      description: >-
        Creates a new scheduled job that periodically calls a specified API
        endpoint on behalf of the authenticated user.
      responses:
        '200':
          description: >-
            Scheduled job created successfully; returns {success: true,
            scheduled_job_id: <id>, msg: <message>}
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always true on success
                  scheduled_job_id:
                    type: integer
                    description: ID of the newly created scheduled job
                  msg:
                    type: string
                    description: Human-readable confirmation message
              example:
                success: true
                scheduled_job_id: 42
                msg: >-
                  Successfully inserted new scheduled job with ID 42 for user_id
                  1234 and instance_id 5678
        '400':
          description: Scheduled job limit exceeded or invalid/missing parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: >-
            A matching scheduled job already exists for this user, instance,
            endpoint, and method; returns {error: "job_exists"}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: 'Failed to create the scheduled job; returns {error: "insert_failed"}'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        msg:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````