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

# Preview Fleet



## OpenAPI

````yaml https://app.podero.com/api/partners/v2.0/openapi.json post /api/partners/v2.0/org/{org_id}/device-simulator/fleets/preview
openapi: 3.1.0
info:
  title: Podero Partner API
  version: '2.0'
  description: >-
    This API provides a unified interaction point for Podero's partner
    companies.


    The goal of this API is to give partners easily integratable endpoints that
    don't require extensive software

    development. For this reason, the endpoints focus around user and device
    management, setting of preferences

    and high level device controls.


    While direct control of devices is implemented for special use cases such as
    pause power, we abstract away low level

    direct device steering so developers and partners can focus on delivering
    maximum value to end users.
  termsOfService: https://www.podero.com/terms-and-conditions
servers: []
security: []
paths:
  /api/partners/v2.0/org/{org_id}/device-simulator/fleets/preview:
    post:
      summary: Preview Fleet
      operationId: integrations_api_api_v2_device_simulator_fleets_preview_fleet
      parameters:
        - in: path
          name: org_id
          schema:
            format: uuid
            title: Org Id
            type: string
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FleetInput'
        required: true
      responses:
        '200':
          description: OK
      security:
        - OAuth2: []
components:
  schemas:
    FleetInput:
      additionalProperties: false
      properties:
        request_id:
          format: uuid
          title: Request Id
          type: string
        name:
          default: Simulated fleet
          maxLength: 120
          minLength: 1
          pattern: \S
          title: Name
          type: string
        count:
          default: 10
          maximum: 1000
          minimum: 1
          title: Count
          type: integer
        seed:
          default: 42
          maximum: 9007199254740991
          minimum: 0
          title: Seed
          type: integer
        history_days:
          default: 0
          maximum: 90
          minimum: 0
          title: History Days
          type: integer
        history_cutoff:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: History Cutoff
        latitude:
          anyOf:
            - maximum: 90
              minimum: -90
              type: number
            - type: 'null'
          title: Latitude
        longitude:
          anyOf:
            - maximum: 180
              minimum: -180
              type: number
            - type: 'null'
          title: Longitude
        density:
          anyOf:
            - $ref: '#/components/schemas/DensityRasterInput'
            - type: 'null'
        ev_ownership_fraction:
          default: 0.25
          maximum: 1
          minimum: 0
          title: Ev Ownership Fraction
          type: number
        pv_rating_kw:
          anyOf:
            - maximum: 100
              minimum: 0
              type: number
            - type: 'null'
          title: Pv Rating Kw
        battery_capacity_kwh:
          anyOf:
            - maximum: 1000
              minimum: 0.1
              type: number
            - type: 'null'
          title: Battery Capacity Kwh
        max_charge_power_w:
          anyOf:
            - maximum: 100000
              minimum: 1
              type: integer
            - type: 'null'
          title: Max Charge Power W
        max_discharge_power_w:
          anyOf:
            - maximum: 100000
              minimum: 1
              type: integer
            - type: 'null'
          title: Max Discharge Power W
        initial_soc_percent:
          anyOf:
            - maximum: 100
              minimum: 5
              type: number
            - type: 'null'
          title: Initial Soc Percent
        pv_rating_kw_range:
          anyOf:
            - $ref: '#/components/schemas/IntegerRange'
            - type: 'null'
        battery_capacity_kwh_range:
          anyOf:
            - $ref: '#/components/schemas/IntegerRange'
            - type: 'null'
        initial_soc_percent_range:
          anyOf:
            - $ref: '#/components/schemas/IntegerRange'
            - type: 'null'
        max_charge_power_w_range:
          anyOf:
            - $ref: '#/components/schemas/IntegerRange'
            - type: 'null'
        max_discharge_power_w_range:
          anyOf:
            - $ref: '#/components/schemas/IntegerRange'
            - type: 'null'
        annual_consumption_kwh:
          anyOf:
            - maximum: 100000
              minimum: 1
              type: number
            - type: 'null'
          title: Annual Consumption Kwh
        annual_consumption_with_ev_kwh:
          anyOf:
            - maximum: 100000
              minimum: 1
              type: number
            - type: 'null'
          title: Annual Consumption With Ev Kwh
        groups:
          items:
            $ref: '#/components/schemas/FleetGroupInput'
          maxItems: 100
          title: Groups
          type: array
      required:
        - request_id
      title: FleetInput
      type: object
    DensityRasterInput:
      additionalProperties: false
      description: >-
        Painted household density for one country. The Go contract holds the
        full rules; these checks

        stop malformed payloads before a runtime call and give the Console
        field-level errors.
      properties:
        country:
          pattern: ^[A-Z]{2}$
          title: Country
          type: string
        dataset_version:
          pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$
          title: Dataset Version
          type: string
        boundary_version:
          maxLength: 128
          minLength: 1
          title: Boundary Version
          type: string
        grid:
          $ref: '#/components/schemas/DensityGridInput'
        weights:
          maxLength: 340000
          minLength: 4
          title: Weights
          type: string
      required:
        - country
        - dataset_version
        - boundary_version
        - grid
        - weights
      title: DensityRasterInput
      type: object
    IntegerRange:
      additionalProperties: false
      properties:
        min:
          title: Min
          type: integer
        max:
          title: Max
          type: integer
      required:
        - min
        - max
      title: IntegerRange
      type: object
    FleetGroupInput:
      additionalProperties: false
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: \S
          title: Name
          type: string
        count:
          anyOf:
            - maximum: 1000
              minimum: 0
              type: integer
            - type: 'null'
          title: Count
        percentage:
          anyOf:
            - maximum: 100
              minimum: 0
              type: number
            - type: 'null'
          title: Percentage
        profile:
          default: mixed
          title: Profile
          type: string
        weights:
          anyOf:
            - items:
                type: number
              maxItems: 10
              minItems: 10
              type: array
            - type: 'null'
          title: Weights
        annual_consumption_kwh:
          anyOf:
            - maximum: 100000
              minimum: 1
              type: number
            - type: 'null'
          title: Annual Consumption Kwh
        annual_consumption_with_ev_kwh:
          anyOf:
            - maximum: 100000
              minimum: 1
              type: number
            - type: 'null'
          title: Annual Consumption With Ev Kwh
        max_time_shift_minutes:
          anyOf:
            - maximum: 180
              minimum: 0
              type: integer
            - type: 'null'
          title: Max Time Shift Minutes
        variation_fraction:
          anyOf:
            - maximum: 0.5
              minimum: 0
              type: number
            - type: 'null'
          title: Variation Fraction
      required:
        - name
      title: FleetGroupInput
      type: object
    DensityGridInput:
      additionalProperties: false
      properties:
        origin_lat:
          maximum: 90
          minimum: -90
          title: Origin Lat
          type: number
        origin_lon:
          maximum: 180
          minimum: -180
          title: Origin Lon
          type: number
        cell_deg:
          exclusiveMinimum: 0
          maximum: 1
          title: Cell Deg
          type: number
        rows:
          maximum: 4000
          minimum: 1
          title: Rows
          type: integer
        cols:
          maximum: 4000
          minimum: 1
          title: Cols
          type: integer
      required:
        - origin_lat
        - origin_lon
        - cell_deg
        - rows
        - cols
      title: DensityGridInput
      type: object
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/partners/v2.0/auth/token
          scopes: {}
        clientCredentials:
          tokenUrl: /api/partners/v2.0/auth/token
          scopes: {}

````