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

# Start an Apache Ossie conversion

Converts between a Cube data model and an [Apache Ossie (Open Semantic Interchange)](https://github.com/apache/ossie) model, and returns polling URLs immediately. An export converts the YAML data model of the deployment's latest successful build, or uploaded YAML files, to one Ossie model; an import converts an uploaded Ossie model to Cube data model files. Neither changes the deployment. Only static YAML model files are converted; JavaScript models and Jinja-templated files are skipped. Uploads are limited to 512 files of at most 2 MiB each and 20 MiB in total. Requests and results are kept for at most one day. Requires `SchemaRead` or `SchemaUpdate` access. This is currently in preview — reach out to the Cube support team to activate it for your account.


## OpenAPI

````yaml /api-reference/api.yaml post /api/v1/deployments/{deploymentId}/ossie-conversions
openapi: 3.1.0
info:
  title: Cube Platform API
  version: 1.0.0
  description: >-
    Programmatically manage Cube: deployments and everything scoped to them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
    Data-model

    authoring, dev mode, branches, and uploads live under /build/api/v1 — same
    host and

    token, routed to the build pods.
servers:
  - url: https://{tenant}.cubecloud.dev
    description: Your tenant host. Replace the whole host if you use a custom domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Deployment Creation
  - name: Environments
  - name: Env Variables
  - name: Regions
  - name: Data Model
  - name: Data Model Uploads
  - name: GitHub
  - name: GitHub Connection
  - name: dbt Sync
  - name: Databricks Metric View Publication
  - name: Databricks Metric View Integration
  - name: Snowflake Semantic View Sync
  - name: Folders
  - name: Reports
  - name: External Documents
  - name: Workbooks
  - name: Workbook Promotions
  - name: Dashboard Exports
  - name: Notifications
  - name: Scheduled Tasks
  - name: Workspace
  - name: Agents
  - name: Users
  - name: Users Admin
  - name: API Keys
  - name: User Attributes
  - name: User Attribute Values
  - name: Tenant Settings
  - name: OAuth Integrations
  - name: User OAuth Tokens
  - name: OIDC Token Configs
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dashboard Embed Access
  - name: Usage Analytics
  - name: OpenAPI Spec
  - name: Chat History
  - name: Ossie Conversion
  - name: Report Deliveries
paths:
  /api/v1/deployments/{deploymentId}/ossie-conversions:
    post:
      tags:
        - Ossie Conversion
      summary: Start an Apache Ossie conversion
      operationId: startConversion
      parameters:
        - in: path
          name: deploymentId
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OssieConversionInput'
        description: OssieConversionInput
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OssieConversionStartResponse'
          description: ''
components:
  schemas:
    OssieConversionInput:
      properties:
        baseCube:
          description: >-
            Import only. The dataset the generated view is rooted at, for an
            Ossie model whose relationships do not determine one.
          oneOf:
            - type: string
            - type: 'null'
        dialect:
          description: >-
            Import only. The warehouse dialect whose expressions are preferred
            where the Ossie model has several; ANSI_SQL is always the fallback.
            Defaults to the dialect of the deployment's default data source, or
            ANSI_SQL.
          oneOf:
            - $ref: '#/components/schemas/OssieConversionInputDialect'
            - type: 'null'
        direction:
          $ref: '#/components/schemas/OssieConversionInputDirection'
          description: >-
            'export' converts a Cube data model to an Ossie model; 'import'
            converts an Ossie model to Cube data model files.
        files:
          description: >-
            Export with source 'files' only. Relative `.yml`/`.yaml` paths
            mapped to their contents, such as a local checkout of the data
            model. Other files are not accepted.
          oneOf:
            - type: object
              additionalProperties:
                type: string
            - type: 'null'
        ossieYaml:
          description: Import only. The Ossie YAML document to convert.
          oneOf:
            - type: string
            - type: 'null'
        source:
          description: >-
            Export only. 'deployment' (the default) converts the YAML data model
            of the deployment's latest successful build; 'files' converts the
            `files` sent with the request.
          oneOf:
            - $ref: '#/components/schemas/OssieConversionInputSource'
            - type: 'null'
        strictFanout:
          description: >-
            Export only. Refuse a metric whose value join fan-out could change,
            instead of converting it with a warning. Defaults to false for a
            whole-model export and true for a view export.
          oneOf:
            - type: boolean
            - type: 'null'
        view:
          description: >-
            Export only. Convert just this view's public members instead of the
            whole model.
          oneOf:
            - type: string
            - type: 'null'
      required:
        - direction
      type: object
    OssieConversionStartResponse:
      properties:
        conversionId:
          type: string
        resultUrl:
          type: string
        status:
          $ref: '#/components/schemas/OssieConversionStartResponseStatus'
        statusUrl:
          type: string
      required:
        - conversionId
        - status
        - statusUrl
        - resultUrl
      type: object
    OssieConversionInputDialect:
      enum:
        - ANSI_SQL
        - SNOWFLAKE
        - DATABRICKS
        - BIGQUERY
      type: string
    OssieConversionInputDirection:
      enum:
        - export
        - import
      type: string
    OssieConversionInputSource:
      enum:
        - deployment
        - files
      type: string
    OssieConversionStartResponseStatus:
      enum:
        - QUEUED
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````

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