> ## 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



## OpenAPI

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

````

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