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

# Create Job

> Create Job



## OpenAPI

````yaml /api-reference/openapi.json post /v1/jobs
openapi: 3.1.0
info:
  title: Nimble SDK
  version: 1.0.0
  description: The AI-Native SDK for Real-Time Web Data at scale
servers:
  - url: https://sdk.nimbleway.com
security: []
paths:
  /v1/jobs:
    post:
      tags:
        - Jobs
      summary: Create Job
      description: Create Job
      operationId: create_job_v1_jobs_post
      parameters:
        - name: token
          in: cookie
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    CreateJobRequest:
      properties:
        name:
          type: string
          title: Name
          description: Job name.
        agent_name:
          type: string
          title: Agent Name
          description: Name of the agent to run.
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
          description: Human-friendly job name shown in the UI.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Free-text description of the job.
        schedule:
          anyOf:
            - $ref: '#/components/schemas/JobSchedule'
            - type: 'null'
          description: Cron schedule controlling automatic runs.
        inputs:
          anyOf:
            - $ref: '#/components/schemas/JobInputs'
            - type: 'null'
          description: Input data configuration for the job.
        destination:
          anyOf:
            - $ref: '#/components/schemas/JobDestination'
            - type: 'null'
          description: Where the job writes its results.
      type: object
      required:
        - name
        - agent_name
      title: CreateJobRequest
      description: Payload to create a new job.
    Job:
      properties:
        id:
          type: string
          pattern: ^job_[1-9][0-9]*$
          title: Id
          description: Unique job identifier (job_<n>).
        name:
          type: string
          title: Name
          description: Job name.
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
          description: Human-friendly job name shown in the UI.
        agent_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Name
          description: Name of the agent this job runs.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Free-text description of the job.
        schedule:
          anyOf:
            - $ref: '#/components/schemas/JobSchedule'
            - type: 'null'
          description: Cron schedule controlling automatic runs.
        inputs:
          anyOf:
            - $ref: '#/components/schemas/JobInputs'
            - type: 'null'
          description: Input data configuration for the job.
        destination:
          anyOf:
            - $ref: '#/components/schemas/JobDestination'
            - type: 'null'
          description: Where the job writes its results.
        last_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Run At
          description: Timestamp of the most recent run.
        last_run_status:
          anyOf:
            - type: string
              enum:
                - PENDING
                - RUNNING
                - SUCCESS
                - FAILED
                - CANCELLED
                - TIMEOUT
                - WARNING
            - type: 'null'
          title: Last Run Status
          description: Status of the most recent run.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
          description: When the job was created.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: When the job was last updated.
      type: object
      required:
        - id
        - name
      title: Job
      description: 'A configured job: an agent plus its schedule, inputs, and destination.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JobSchedule:
      properties:
        cron:
          type: string
          title: Cron
          description: Cron expression defining when the job runs.
        enabled:
          type: boolean
          title: Enabled
          description: Whether the schedule is currently active.
      type: object
      required:
        - cron
        - enabled
      title: JobSchedule
      description: Cron-based schedule controlling when a job runs automatically.
    JobInputs:
      properties:
        type:
          type: string
          enum:
            - s3
            - inline
            - file
          title: Type
          description: >-
            How inputs are supplied: an 's3' bucket, 'inline' records, or an
            uploaded 'file'.
        file_path:
          anyOf:
            - type: string
            - type: 'null'
          title: File Path
          description: >-
            Path to the input file; must start with 's3' or 'file_'. Used for
            's3'/'file' types.
        data:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Data
          description: Inline list of input records. Used when type is 'inline'.
      type: object
      required:
        - type
      title: JobInputs
      description: Configuration for the input data a job processes.
    JobDestination:
      properties:
        type:
          type: string
          enum:
            - file
            - s3
          title: Type
          description: 'Destination kind: a local ''file'' or an ''s3'' bucket.'
        path:
          type: string
          title: Path
          description: Destination path the output is written to.
        format:
          type: string
          enum:
            - jsonl
            - csv
            - parquet
          title: Format
          default: parquet
          description: Output file format.
      type: object
      required:
        - type
        - path
      title: JobDestination
      description: Where a job writes its results.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````