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

# Create profile for a data asset

> Create profile for a data asset



## OpenAPI

````yaml /api-reference/bundled.yaml post /v0/data-asset/{id}/profile
openapi: 3.1.0
info:
  title: Gable API
  description: >
    API to interact with the Gable platform

    ## Authorization

    All API requests require an API key to be passed in the `X-API-KEY` header.
    For instructions on finding your API key and api endpoint check out the [API
    Key documentation](../docs/api-keys.md).

    Example: `curl -H "X-API-KEY: <your-api-key>"
    https://api-{organization}.gable.ai/v0/ping`
  contact:
    name: Gable Engineering
    url: https://gable.ai
    email: engineers@gable.ai
  version: 1.28.0
servers:
  - url: https://{hostname}.gable.ai
    description: Gable API
    variables:
      hostname:
        default: demo-api
        description: Customer environment assigned by Gable
security:
  - ApiKeyAuth: []
tags:
  - name: action
  - name: api-keys
  - name: auth
  - name: changelog
  - name: config
  - name: contract
  - name: data-asset
  - name: debug
  - name: s3
  - name: settings
  - name: slack
  - name: sso
  - name: webhook
  - name: notifications
  - name: constraints
  - name: telemetry
  - name: component
  - name: components
  - name: sca
  - name: cross-service-components
  - name: lineage
  - name: events
  - name: measurements
  - name: defect-report
  - name: experimental
paths:
  /v0/data-asset/{id}/profile:
    post:
      tags:
        - data-asset
      summary: Create profile for a data asset
      description: Create profile for a data asset
      operationId: createDataAssetProfile
      parameters:
        - in: path
          name: id
          schema:
            type: string
            format: uuid
          required: true
          description: UUID of the data asset
      requestBody:
        description: Data Asset Profiles
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataAssetProfileRequest'
      responses:
        '200':
          description: Data asset profile was successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDataAssetProfileResponse'
        '404':
          description: Data asset not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CreateDataAssetProfileRequest:
      type: object
      properties:
        darn:
          description: the Data Asset Resource Name (DARN) of the data asset
          type: string
        data_asset_id:
          type: string
          format: uuid
          description: ID for the data asset
        fieldsToProfilesMapping:
          $ref: '#/components/schemas/DataAssetFieldsToProfilesMapping'
          description: >-
            The mapping of data asset fields to data asset field profiles
            associated with the data asset
      required:
        - darn
        - data_asset_id
        - fieldsToProfilesMapping
    CreateDataAssetProfileResponse:
      type: object
      required:
        - fieldsToProfilesMapping
      properties:
        fieldsToProfilesMapping:
          $ref: '#/components/schemas/DataAssetFieldsToProfilesMapping'
    ErrorResponse:
      type: object
      required:
        - message
      properties:
        id:
          type: number
        title:
          type: string
        message:
          type: string
    DataAssetFieldsToProfilesMapping:
      type: object
      description: Mapping of a data asset's fields to their respective data profiles
      additionalProperties:
        $ref: '#/components/schemas/DataAssetFieldProfile'
    DataAssetFieldProfile:
      oneOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBoolean'
        - $ref: '#/components/schemas/DataAssetFieldProfileNumber'
        - $ref: '#/components/schemas/DataAssetFieldProfileOther'
        - $ref: '#/components/schemas/DataAssetFieldProfileString'
        - $ref: '#/components/schemas/DataAssetFieldProfileUUID'
        - $ref: '#/components/schemas/DataAssetFieldProfileTemporal'
        - $ref: '#/components/schemas/DataAssetFieldProfileUnion'
        - $ref: '#/components/schemas/DataAssetFieldProfileList'
      discriminator:
        propertyName: profileType
        mapping:
          boolean:
            $ref: '#/components/schemas/DataAssetFieldProfileBoolean'
          number:
            $ref: '#/components/schemas/DataAssetFieldProfileNumber'
          other:
            $ref: '#/components/schemas/DataAssetFieldProfileOther'
          string:
            $ref: '#/components/schemas/DataAssetFieldProfileString'
          uuid:
            $ref: '#/components/schemas/DataAssetFieldProfileUUID'
          temporal:
            $ref: '#/components/schemas/DataAssetFieldProfileTemporal'
          union:
            $ref: '#/components/schemas/DataAssetFieldProfileUnion'
          list:
            $ref: '#/components/schemas/DataAssetFieldProfileList'
    DataAssetFieldProfileBoolean:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for boolean
          required:
            - profileType
            - trueCount
            - falseCount
          properties:
            profileType:
              type: string
              enum:
                - boolean
            trueCount:
              type: integer
              description: Number of true values
            falseCount:
              type: integer
              description: Number of false values
    DataAssetFieldProfileNumber:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for number
          required:
            - profileType
            - uniqueCount
            - min
            - max
          properties:
            profileType:
              type: string
              enum:
                - number
            uniqueCount:
              type: integer
              description: Number of unique values
            min:
              type: number
              description: Minimum value
            max:
              type: number
              description: Maximum value
    DataAssetFieldProfileOther:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for unspecified type
          required:
            - profileType
          properties:
            profileType:
              type: string
              enum:
                - other
    DataAssetFieldProfileString:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for string
          required:
            - profileType
            - uniqueCount
            - minLength
            - maxLength
            - emptyCount
          properties:
            profileType:
              type: string
              enum:
                - string
            uniqueCount:
              type: integer
              description: Number of unique values
            minLength:
              type: integer
              description: Minimum length
            maxLength:
              type: integer
              description: Maximum length
            emptyCount:
              type: integer
              description: Number of empty values
    DataAssetFieldProfileUUID:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for a UUID
          required:
            - profileType
            - uniqueCount
            - minLength
            - maxLength
            - emptyCount
          properties:
            profileType:
              type: string
              enum:
                - uuid
            uniqueCount:
              type: integer
              description: Number of unique values
            minLength:
              type: integer
              description: Minimum length
            maxLength:
              type: integer
              description: Maximum length
            emptyCount:
              type: integer
              description: Number of empty values
            format:
              type: string
              description: UUID format
            uuidVersion:
              type: integer
              description: UUID version
    DataAssetFieldProfileTemporal:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for temporal
          required:
            - profileType
            - min
            - max
            - format
          properties:
            profileType:
              type: string
              enum:
                - temporal
            min:
              type: string
              format: date-time
              description: Minimum value
            max:
              type: string
              format: date-time
              description: Maximum value
            format:
              type: string
              description: Temporal format
    DataAssetFieldProfileUnion:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for union
          required:
            - profileType
            - profiles
          properties:
            profileType:
              type: string
              enum:
                - union
            profiles:
              type: array
              description: List of constituent data asset field profiles
              items:
                $ref: '#/components/schemas/DataAssetFieldProfile'
    DataAssetFieldProfileList:
      allOf:
        - $ref: '#/components/schemas/DataAssetFieldProfileBase'
        - type: object
          description: Data asset field profile for string
          required:
            - profileType
            - minLength
            - maxLength
          properties:
            profileType:
              type: string
              enum:
                - list
            minLength:
              type: integer
              description: Minimum length
            maxLength:
              type: integer
              description: Maximum length
    DataAssetFieldProfileBase:
      type: object
      description: generic data asset field profile
      required:
        - sampledRecordsCount
        - nullable
        - sampledFiles
        - samplingParameters
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the data asset field profile in UUID format
        sampledRecordsCount:
          type: integer
          description: Number of samples
        nullable:
          type: boolean
          description: Whether the data is nullable
        nullCount:
          type: integer
          description: Number of nulls (only defined if nullable is true)
        sampledFiles:
          type: array
          minItems: 1
          items:
            type: string
          description: List of sampled files
        sampledDate:
          description: The date the sample was taken
          type: string
          format: date-time
        samplingParameters:
          $ref: '#/components/schemas/S3SamplingParameters'
    S3SamplingParameters:
      type: object
      description: The parameters used to sample the data
      required:
        - rowSampleCount
      properties:
        rowSampleCount:
          type: integer
          description: Number of rows sampled per file
        recentFileCount:
          type: integer
          description: Number of most recent files whose schemas are sampled per data asset
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````