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

# Create a datasource



## OpenAPI

````yaml /api-reference/openapi/datasources-api.json post /
openapi: 3.0.0
info:
  title: datasources-api
  version: 0.0.0
  description: |-
    # Errors
    | Error code | Message | HTTP status code | Payload |
    | :--- | :--- | :--- | :--- |
    | number | string | 409 |  |
servers:
  - url: https://api.reelevant.com/v2/datasources/
    description: production
security: []
paths:
  /:
    post:
      tags:
        - Datasource
      summary: Create a datasource
      operationId: create-datasource
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - type: object
                  properties:
                    mode:
                      $ref: '#/components/schemas/DatasourceMode'
                    name:
                      type: string
                    type:
                      oneOf:
                        - $ref: '#/components/schemas/DatasourcePush'
                        - type: object
                          properties:
                            name:
                              type: string
                              enum:
                                - analytics
                            subtype:
                              oneOf:
                                - type: string
                                  enum:
                                    - reelevant
                                - type: string
                                  enum:
                                    - google_tag_manager
                                - type: string
                                  enum:
                                    - workflow_events
                                - type: string
                                  enum:
                                    - user
                                - type: string
                                  enum:
                                    - mutable
                          required:
                            - name
                            - subtype
                          additionalProperties: false
                        - type: object
                          properties:
                            name:
                              type: string
                              enum:
                                - analytics
                            subtype:
                              type: string
                              enum:
                                - purchases
                            options:
                              type: object
                              properties:
                                autoExclusions:
                                  type: boolean
                                noStats:
                                  type: boolean
                              additionalProperties: false
                          required:
                            - name
                            - subtype
                            - options
                          additionalProperties: false
                        - $ref: '#/components/schemas/DatasourceGeneric'
                        - $ref: '#/components/schemas/DatasourceCRM'
                        - $ref: '#/components/schemas/DatasourceProduct'
                        - $ref: '#/components/schemas/DatasourceLocation'
                  additionalProperties: false
                - type: object
                  properties:
                    fromTemplate:
                      type: string
                  required:
                    - fromTemplate
                  additionalProperties: false
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - success
                    required:
                      - status
                    additionalProperties: false
                  - $ref: >-
                      #/components/schemas/InternalResponse_Union_PushDatasource_WorkerDatasource_ProxyDatasource_IngesterDatasource_PubsubDatasource
        '404':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/InternalResponse_'
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - fail
                      error_code:
                        type: number
                      code:
                        type: number
                      message:
                        type: string
                      data:
                        oneOf:
                          - type: object
                            properties: {}
                            additionalProperties:
                              $ref: '#/components/schemas/AnyValue'
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              id:
                                type: string
                            required:
                              - id
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                              datasourceId:
                                type: string
                            required:
                              - field
                              - datasourceId
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              protocol:
                                type: string
                            required:
                              - protocol
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties:
                              type:
                                type: string
                            required:
                              - type
                            additionalProperties: false
                          - type: object
                            properties:
                              field:
                                type: string
                            required:
                              - field
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: object
                            properties:
                              textEncoding:
                                type: string
                            required:
                              - textEncoding
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                              format:
                                oneOf:
                                  - type: string
                                    enum:
                                      - avro
                                  - type: string
                                    enum:
                                      - csv
                                  - type: string
                                    enum:
                                      - json
                                  - type: string
                                    enum:
                                      - ndjson
                                  - type: string
                                    enum:
                                      - parquet
                                  - type: string
                                    enum:
                                      - xlsx
                                  - type: string
                                    enum:
                                      - xml
                              url:
                                type: string
                            required:
                              - err
                              - format
                              - url
                            additionalProperties: false
                          - type: object
                            properties:
                              name:
                                type: string
                            required:
                              - name
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              fields:
                                type: array
                                items:
                                  type: string
                            required:
                              - fields
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                              url:
                                type: string
                            required:
                              - err
                              - url
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              q:
                                type: string
                              err:
                                type: string
                            required:
                              - q
                              - err
                            additionalProperties: false
                          - type: object
                            properties:
                              err:
                                type: string
                            required:
                              - err
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              workflows:
                                type: array
                                items:
                                  type: string
                              contents:
                                type: array
                                items:
                                  type: string
                            required:
                              - workflows
                              - contents
                            additionalProperties: false
                          - type: object
                            properties:
                              expectedStep:
                                $ref: '#/components/schemas/StepName'
                            required:
                              - expectedStep
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties:
                              timeout:
                                type: number
                            required:
                              - timeout
                            additionalProperties: false
                          - type: object
                            properties:
                              message:
                                type: string
                            required:
                              - message
                            additionalProperties: false
                          - type: object
                            properties:
                              ids:
                                type: array
                                items:
                                  type: string
                            required:
                              - ids
                            additionalProperties: false
                          - type: object
                            properties:
                              expectedType:
                                $ref: '#/components/schemas/DatasourceType'
                            required:
                              - expectedType
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                          - type: object
                            properties: {}
                            additionalProperties: false
                    required:
                      - status
                      - error_code
                      - code
                      - message
                    additionalProperties: false
      security:
        - password_auth: []
components:
  schemas:
    DatasourceMode:
      type: string
      enum:
        - ingester
        - worker
        - proxy
        - pubsub
        - push
    DatasourcePush:
      type: object
      properties:
        name:
          type: string
          enum:
            - push
        subtype:
          type: string
          enum:
            - email
      required:
        - name
        - subtype
      additionalProperties: false
    DatasourceGeneric:
      type: object
      properties:
        name:
          type: string
          enum:
            - generic
        subtype:
          $ref: '#/components/schemas/DatasourceGenericSubType'
      required:
        - name
        - subtype
      additionalProperties: false
    DatasourceCRM:
      type: object
      properties:
        name:
          type: string
          enum:
            - crm
        subtype:
          $ref: '#/components/schemas/DatasourceCRMSubType'
      required:
        - name
        - subtype
      additionalProperties: false
    DatasourceProduct:
      type: object
      properties:
        name:
          type: string
          enum:
            - product
        subtype:
          $ref: '#/components/schemas/DatasourceProductSubType'
      required:
        - name
        - subtype
      additionalProperties: false
    DatasourceLocation:
      type: object
      properties:
        name:
          type: string
          enum:
            - location
        subtype:
          $ref: '#/components/schemas/DatasourceLocationSubType'
      required:
        - name
        - subtype
      additionalProperties: false
    InternalResponse_Union_PushDatasource_WorkerDatasource_ProxyDatasource_IngesterDatasource_PubsubDatasource:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          oneOf:
            - $ref: '#/components/schemas/PushDatasource'
            - $ref: '#/components/schemas/WorkerDatasource'
            - $ref: '#/components/schemas/ProxyDatasource'
            - $ref: '#/components/schemas/IngesterDatasource'
            - $ref: '#/components/schemas/PubsubDatasource'
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    InternalResponse_:
      type: object
      properties:
        program:
          type: string
        version:
          type: string
        datetime:
          type: string
        status:
          type: string
        code:
          type: number
        message:
          type: string
        data:
          type: object
          properties: {}
          additionalProperties: false
      required:
        - program
        - version
        - datetime
        - status
        - message
        - data
      additionalProperties: false
    AnyValue:
      description: Can be any value
      nullable: true
    StepName:
      type: string
      enum:
        - configure_name
        - configure_resource_group_ids
        - configure_sources
        - configure_fields
        - configure_field
        - create_oauth_client
        - authorize_oauth_client
        - configure_thresholds
        - configure_api_key
        - patch
        - configure_fetcher
        - validate
        - configure_google_tag_manager
        - configure_reelevant_analytics_script
        - configure_product_datasource_source
        - configure_tracking_datasource_source
        - configure_best_product_query
        - configure_best_product_field
        - configure_bought_together
        - configure_merge_mapping
        - configure_merge_datasource_source
        - configure_merge_datasource_dependency
        - configure_top_attributes
        - configure_destination
        - configure_hierarchy
    DatasourceType:
      type: string
      enum:
        - generic
        - location
        - product
        - analytics
        - crm
        - push
    DatasourceGenericSubType:
      type: string
      enum:
        - user
        - TOP_ATTRIBUTES
        - mutable
    DatasourceCRMSubType:
      type: string
      enum:
        - user
        - mutable
    DatasourceProductSubType:
      type: string
      enum:
        - user
        - localized
        - best_product
        - bought_together
        - mutable
    DatasourceLocationSubType:
      type: string
      enum:
        - user
        - google_my_business
        - partoo
        - weather
        - mutable
    PushDatasource:
      $ref: '#/components/schemas/AnyValue'
    WorkerDatasource:
      $ref: '#/components/schemas/AnyValue'
    ProxyDatasource:
      $ref: '#/components/schemas/AnyValue'
    IngesterDatasource:
      $ref: '#/components/schemas/AnyValue'
    PubsubDatasource:
      $ref: '#/components/schemas/AnyValue'
  securitySchemes:
    password_auth:
      type: oauth2
      flows:
        password:
          tokenUrl: https://api.reelevant.com/v1/auth/token
          refreshUrl: https://api.reelevant.com/v1/auth/token
          scopes: {}

````