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

# Start a session

> Open an interactive session against a job application URL. A browser navigates to the form and the parsed fields come back in `fields` — you decide every answer and advance the flow with `POST /api/auto-apply/sessions/{id}/answers`. Use sessions when you want to review or edit answers before submission; use applications for one-shot automation.



## OpenAPI

````yaml /openapi.yaml post /api/auto-apply/sessions
openapi: 3.1.0
info:
  title: Jobo Enterprise API
  description: >
    The Jobo Enterprise API provides programmatic access to job listings,
    intelligent search,

    real-time feeds, automated job applications, and geocoding services.
  version: 1.0.0
  contact:
    name: Jobo Support
    url: https://jobo.world
    email: support@jobo.world
servers:
  - url: https://connect.jobo.world
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Jobs Search
    description: Search and retrieve job listings
  - name: Jobs Feed
    description: Bulk job feeds and expiration tracking
  - name: Career Sites Feed
    description: Bulk feed of newly discovered career sites with enriched company profiles
  - name: Companies
    description: Company profiles and company-scoped job listings
  - name: Auto Apply Profiles
    description: Resume-first applicant profiles that power automated applications
  - name: Auto Apply Applications
    description: >-
      Fully automated job applications — submit asynchronously and poll for the
      outcome
  - name: Auto Apply Sessions
    description: Interactive, step-by-step application sessions with full answer control
  - name: Locations
    description: Geocoding and location services
paths:
  /api/auto-apply/sessions:
    post:
      tags:
        - Auto Apply Sessions
      summary: Start a session
      description: >-
        Open an interactive session against a job application URL. A browser
        navigates to the form and the parsed fields come back in `fields` — you
        decide every answer and advance the flow with `POST
        /api/auto-apply/sessions/{id}/answers`. Use sessions when you want to
        review or edit answers before submission; use applications for one-shot
        automation.
      operationId: createAutoApplySession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - job_url
              properties:
                job_url:
                  type: string
                  description: >-
                    The job posting's application URL. Absolute http(s), max
                    2000 characters.
                  example: https://boards.greenhouse.io/acme/jobs/4567890
      responses:
        '201':
          description: >-
            Session created. The `Location` header points at the session;
            `fields` carries the first page's form fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Session'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          description: >-
            The session could not be started (e.g. unsupported ATS provider,
            navigation failure)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '502':
          description: >-
            The automation backend is temporarily unavailable — the up-front
            charge (if any) is automatically refunded; retry shortly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    Session:
      type: object
      description: >-
        The live state of an interactive session, returned by session create and
        answer submissions. `fields` carries the current page's form fields.
        When `status` is `redirect_required`, start a new session with
        `redirect_url`.
      properties:
        id:
          type: string
          format: uuid
          description: Session identifier. Use it in the answers, get, and end endpoints.
          example: 6f1d2b3c-4a5e-4f60-9b7a-8c9d0e1f2a3b
        provider_id:
          type: string
          description: >-
            Detected ATS provider identifier (e.g. `greenhouse`, `lever`,
            `ashby`).
          example: greenhouse
        provider_name:
          type: string
          description: Human-readable ATS provider name.
          example: Greenhouse
        status:
          $ref: '#/components/schemas/ApplyFlowStatus'
        is_terminal:
          type: boolean
          description: >-
            True when the session is finished and no further answer submissions
            are possible.
          example: false
        error:
          type: string
          nullable: true
          description: Human-readable error detail when `status` is `error`.
          example: null
        current_url:
          type: string
          nullable: true
          description: The URL the session's browser is currently on.
          example: https://boards.greenhouse.io/acme/jobs/4567890
        validation_errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          description: >-
            Field-level problems reported by the ATS form after an answers
            submission.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FormFieldInfo'
          description: The current page's form fields to answer.
        redirect_url:
          type: string
          nullable: true
          description: >-
            When `status` is `redirect_required` — the application continues on
            a different ATS. Start a new session with this URL.
          example: null
        redirect_provider_id:
          type: string
          nullable: true
          description: >-
            When `status` is `redirect_required` — the provider expected to
            handle the redirect.
          example: null
    ValidationProblemDetails:
      allOf:
        - $ref: '#/components/schemas/ProblemDetails'
        - type: object
          properties:
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
              description: Map of field name to list of validation error messages.
    ProblemDetails:
      type: object
      description: RFC 7807 problem details object returned for error responses.
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
    ApplyFlowStatus:
      type: string
      description: >-
        The flow state of an interactive session. `form_ready`,
        `next_available`, and `submit_ready` are active states; `submitted`,
        `login_required`, `captcha_required`, `expired`, `redirected`,
        `redirect_required`, and `error` are terminal (`is_terminal = true`).
        `login_required`, `captcha_required`, `redirected`, and
        `redirect_required` are reserved — those situations report `error` until
        dedicated detection ships; treat the enum as open.
      enum:
        - form_ready
        - next_available
        - submit_ready
        - submitted
        - login_required
        - captcha_required
        - expired
        - redirected
        - redirect_required
        - error
      example: form_ready
    ValidationError:
      type: object
      description: A field-level problem reported by the ATS form.
      properties:
        field_id:
          type: string
          nullable: true
          description: The offending field, or null for page-level problems.
          example: c0203e24-63fd-4425-914c-216a5701861c
        message:
          type: string
          description: The validation message shown by the form.
          example: This field is required.
    FormFieldInfo:
      type: object
      description: A parsed form field on the current application page.
      properties:
        field_id:
          type: string
          description: >-
            Stable identifier for the field within the session. Echo it back in
            `FieldAnswer.field_id`.
          example: c0203e24-63fd-4425-914c-216a5701861c
        type:
          $ref: '#/components/schemas/FieldType'
        label:
          type: string
          description: The field's visible label.
          example: First name
        is_required:
          type: boolean
          description: True when the ATS marks the field as required.
          example: true
        options:
          type: array
          items:
            $ref: '#/components/schemas/FieldOption'
          description: >-
            Available options for `select`, `multi_select`, `radio`, and similar
            fields.
        handler_type:
          type: string
          nullable: true
          description: ATS-specific handler hint (e.g. "first-name", "email", "resume").
          example: first-name
        current_value:
          type: string
          nullable: true
          description: >-
            The field's current value on the page (pre-filled or previously
            set), or null when empty.
          example: null
    FieldType:
      type: string
      description: >-
        The kind of form control, which dictates the expected
        `FieldAnswer.value` format.
      enum:
        - text
        - text_area
        - select
        - multi_select
        - radio
        - checkbox
        - file
        - date
        - number
        - hidden
        - password
        - typeahead
        - toggle
        - rich_text
        - static
        - complex
        - unknown
      example: text
    FieldOption:
      type: object
      description: One selectable option of a choice field.
      properties:
        value:
          type: string
          description: The option value to send back in `FieldAnswer.value`.
          example: '4018213008'
        text:
          type: string
          description: The option's visible label.
          example: San Francisco, CA
  responses:
    Unauthorized:
      description: Missing or invalid API key
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key provided by Jobo

````