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

# Register a dataset upload

> Register Parquet tables and optionally one ZIP of downloaded files. The response contains a Run Proxy URL for each file and an upload token valid for 24 hours.
            Existing datasets can omit tables to reuse saved mappings or match all business tables by name.
            Each upload replaces the complete source, sequence and parallel-set slice. Tables omitted from an explicit table list lose their rows in that slice.
            Idempotency-Key is optional but recommended; reuse the same key when retrying registration.
            Without a key, each request creates a new registration subject to normal conflict checks.
            Category and dataset names are matched case-insensitively. A category name is reused or created within the owning organization.
            Organization administrator access is required.



## OpenAPI

````yaml POST /api/v1/dataset-uploads
openapi: 3.0.4
info:
  title: Sequentum Cloud API
  description: API endpoints for Sequentum Cloud
  version: v1
servers: []
security:
  - ApiKey: []
    Bearer: []
paths:
  /api/v1/dataset-uploads:
    post:
      tags:
        - ApiDatasetUploads
      summary: Register a dataset upload
      description: >-
        Register Parquet tables and optionally one ZIP of downloaded files. The
        response contains a Run Proxy URL for each file and an upload token
        valid for 24 hours.
                    Existing datasets can omit tables to reuse saved mappings or match all business tables by name.
                    Each upload replaces the complete source, sequence and parallel-set slice. Tables omitted from an explicit table list lose their rows in that slice.
                    Idempotency-Key is optional but recommended; reuse the same key when retrying registration.
                    Without a key, each request creates a new registration subject to normal conflict checks.
                    Category and dataset names are matched case-insensitively. A category name is reused or created within the owning organization.
                    Organization administrator access is required.
      parameters:
        - name: Idempotency-Key
          in: header
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CatalogUploadRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CatalogUploadRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CatalogUploadRequest'
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CatalogUploadResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogUploadResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CatalogUploadResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '409':
          description: Conflict
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '503':
          description: Service Unavailable
      x-codeSamples:
        - lang: curl
          label: cURL
          source: >-
            curl --request POST
            'https://dashboard.sequentum.com/api/v1/dataset-uploads' \
              --header 'Authorization: ApiKey {key}' \
              --header 'Content-Type: application/json' \
              --data '{"datasetId":42,"sourceId":"crm"}'
        - lang: node
          label: Node.js
          source: >-
            const response = await
            fetch('https://dashboard.sequentum.com/api/v1/dataset-uploads', {
              method: 'POST',
              headers: { Authorization: 'ApiKey ' + process.env.SEQUENTUM_API_KEY, 'Content-Type': 'application/json' },
              body: JSON.stringify({"datasetId":42,"sourceId":"crm"})
            });

            if (!response.ok) throw new Error(await response.text());

            console.log(await response.json());
        - lang: python
          label: Python
          source: |-
            import os
            import requests

            response = requests.post(
                'https://dashboard.sequentum.com/api/v1/dataset-uploads',
                headers={'Authorization': 'ApiKey ' + os.environ['SEQUENTUM_API_KEY']},
                json={"datasetId":42,"sourceId":"crm"},
                timeout=60,
            )
            response.raise_for_status()
            print(response.json())
components:
  schemas:
    CatalogUploadRequest:
      type: object
      properties:
        datasetId:
          type: integer
          format: int32
          nullable: true
        newDataset:
          $ref: '#/components/schemas/CatalogNewDataset'
        sourceId:
          type: string
          nullable: true
        sourceName:
          type: string
          nullable: true
        sequence:
          type: integer
          format: int64
          nullable: true
        extractedTime:
          type: string
          nullable: true
        parallelSet:
          type: integer
          format: int32
        tables:
          type: array
          items:
            $ref: '#/components/schemas/CatalogUploadTable'
          nullable: true
        attachments:
          type: boolean
        allowSchemaUpdates:
          type: boolean
      additionalProperties: false
      description: >-
        Registers a delivery of Parquet tables and an optional ZIP of downloaded
        files.
    CatalogUploadResponse:
      type: object
      properties:
        uploadId:
          type: integer
          format: int64
        datasetId:
          type: integer
          format: int32
        sourceId:
          type: string
          nullable: true
        sequence:
          type: integer
          format: int64
        parallelSet:
          type: integer
          format: int32
        extractedTime:
          type: string
          format: date-time
          nullable: true
        categoryId:
          type: integer
          format: int32
          nullable: true
        categoryName:
          type: string
          nullable: true
        deadline:
          type: string
          format: date-time
        status:
          type: string
          nullable: true
        error:
          type: string
          nullable: true
        files:
          type: array
          items:
            $ref: '#/components/schemas/CatalogUploadFileResponse'
          nullable: true
        uploadToken:
          type: string
          nullable: true
        step:
          type: integer
          format: int32
        totalSteps:
          type: integer
          format: int32
        previewSchema:
          $ref: '#/components/schemas/CatalogSchema'
        previewMappings:
          $ref: '#/components/schemas/CatalogConnectionSettings'
        previewPending:
          type: boolean
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    CatalogNewDataset:
      type: object
      properties:
        name:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        categoryId:
          type: integer
          format: int32
          nullable: true
        categoryName:
          type: string
          nullable: true
      additionalProperties: false
    CatalogUploadTable:
      type: object
      properties:
        name:
          type: string
          nullable: true
        targetTable:
          type: string
          nullable: true
        format:
          type: string
          nullable: true
        columns:
          type: object
          additionalProperties:
            type: string
          nullable: true
        idColumn:
          type: string
          nullable: true
        parentIdColumn:
          type: string
          nullable: true
        parentTable:
          type: string
          nullable: true
        isPrimary:
          type: boolean
          nullable: true
        fileColumns:
          type: array
          items:
            type: string
          nullable: true
      additionalProperties: false
      description: >-
        Describes a source table; column mappings map destination names to
        source names.
    CatalogUploadFileResponse:
      type: object
      properties:
        fileId:
          type: integer
          format: int64
        table:
          type: string
          nullable: true
        kind:
          type: string
          nullable: true
        uploadUrl:
          type: string
          nullable: true
        uploaded:
          type: boolean
      additionalProperties: false
      description: An expected upload destination; storage paths remain server-owned.
    CatalogSchema:
      type: object
      properties:
        systemColumnsVersion:
          type: integer
          format: int32
          default: 0
        hasCollectionTable:
          type: boolean
          default: false
        hasFileTable:
          type: boolean
        tables:
          type: array
          items:
            $ref: '#/components/schemas/CatalogTable'
          nullable: true
        warnings:
          type: array
          items:
            type: string
          nullable: true
      additionalProperties: false
    CatalogConnectionSettings:
      type: object
      properties:
        tables:
          type: array
          items:
            $ref: '#/components/schemas/CatalogTableMapping'
          nullable: true
        stagingRetentionDays:
          type: integer
          format: int32
      additionalProperties: false
    CatalogTable:
      type: object
      properties:
        id:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        displayName:
          type: string
          nullable: true
        parentTableId:
          type: string
          nullable: true
        isPrimary:
          type: boolean
        hasParentId:
          type: boolean
        columns:
          type: array
          items:
            $ref: '#/components/schemas/CatalogColumn'
          nullable: true
      additionalProperties: false
    CatalogTableMapping:
      type: object
      properties:
        sourceTableId:
          type: string
          nullable: true
        targetTable:
          type: string
          nullable: true
        columns:
          type: object
          additionalProperties:
            type: string
          description: >-
            Destination column to source column, with service-owned provenance
            excluded.
          nullable: true
        selectSql:
          type: string
          description: >-
            Optional SELECT override using the service-provided source relation
            named source.
          nullable: true
      additionalProperties: false
    CatalogColumn:
      type: object
      properties:
        isFileReference:
          type: boolean
        name:
          type: string
          nullable: true
        sourceName:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        contentType:
          $ref: '#/components/schemas/ContentType'
        isEncrypted:
          type: boolean
      additionalProperties: false
    ContentType:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
      type: integer
      description: >-
        `0` = `Text`; `1` = `LongText`; `2` = `File`; `3` = `Integer`; `4` =
        `BigInteger`; `5` = `Float`; `6` = `Decimal`; `7` = `Date`; `8` =
        `Time`; `9` = `DateAndTime`; `10` = `Boolean`; `11` = `Guid`
      format: int32
  securitySchemes:
    ApiKey:
      type: apiKey
      description: >-
        API Key authorization header. Example: "Authorization: ApiKey
        {your-api-key}"
      name: Authorization
      in: header
    Bearer:
      type: http
      description: 'OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"'
      scheme: bearer
      bearerFormat: JWT

````

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