find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/dataassist-io:dataassist-io-data-sources-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: DataAssist-IO Server Data Sources API
  version: 0.1.0
tags:
- name: Data Sources
paths:
  /data-sources:
    get:
      summary: Spa Data Sources
      operationId: spa_data_sources_data_sources_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Data Sources
  /data-sources/new:
    get:
      summary: Spa Data Sources New
      operationId: spa_data_sources_new_data_sources_new_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Data Sources
  /data-sources/{rest}:
    get:
      summary: Spa Data Sources Sub
      operationId: spa_data_sources_sub_data_sources__rest__get
      parameters:
      - name: rest
        in: path
        required: true
        schema:
          type: string
          title: Rest
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Data Sources
  /api/admin/data-source-engines:
    get:
      tags:
      - Data Sources
      summary: List Engines
      operationId: list_engines_api_admin_data_source_engines_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/admin/data-source-engines/{engine_id}:
    put:
      tags:
      - Data Sources
      summary: Update Engine
      operationId: update_engine_api_admin_data_source_engines__engine_id__put
      parameters:
      - name: engine_id
        in: path
        required: true
        schema:
          type: integer
          title: Engine Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEngineRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-source-types:
    get:
      tags:
      - Data Sources
      summary: List Types
      operationId: list_types_api_data_source_types_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/admin/data-source-types:
    post:
      tags:
      - Data Sources
      summary: Create Type
      operationId: create_type_api_admin_data_source_types_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTypeRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/data-source-types/{type_id}:
    put:
      tags:
      - Data Sources
      summary: Update Type
      operationId: update_type_api_admin_data_source_types__type_id__put
      parameters:
      - name: type_id
        in: path
        required: true
        schema:
          type: integer
          title: Type Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTypeRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources:
    get:
      tags:
      - Data Sources
      summary: List Data Sources
      operationId: list_data_sources_api_data_sources_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
    post:
      tags:
      - Data Sources
      summary: Create Data Source
      operationId: create_data_source_api_data_sources_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDataSourceRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}:
    get:
      tags:
      - Data Sources
      summary: Get Data Source
      operationId: get_data_source_api_data_sources__source_id__get
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Data Sources
      summary: Update Data Source
      operationId: update_data_source_api_data_sources__source_id__put
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDataSourceRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Data Sources
      summary: Delete Data Source
      operationId: delete_data_source_api_data_sources__source_id__delete
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/config:
    get:
      tags:
      - Data Sources
      summary: Get Data Source Config
      operationId: get_data_source_config_api_data_sources__source_id__config_get
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/test-config:
    post:
      tags:
      - Data Sources
      summary: Test Config
      description: Test a connection before creating the data source.
      operationId: test_config_api_data_sources_test_config_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestConfigRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/test:
    post:
      tags:
      - Data Sources
      summary: Test Data Source
      operationId: test_data_source_api_data_sources__source_id__test_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/browse:
    get:
      tags:
      - Data Sources
      summary: Browse Data Source
      operationId: browse_data_source_api_data_sources__source_id__browse_get
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/upload:
    post:
      tags:
      - Data Sources
      summary: Upload Csv
      operationId: upload_csv_api_data_sources__source_id__upload_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_csv_api_data_sources__source_id__upload_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/excel-sheets/inspect:
    post:
      tags:
      - Data Sources
      summary: Inspect Excel No Source
      description: Inspect Excel sheet names without an existing data source — used by the create wizard.
      operationId: inspect_excel_no_source_api_excel_sheets_inspect_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_inspect_excel_no_source_api_excel_sheets_inspect_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/excel-sheets:
    post:
      tags:
      - Data Sources
      summary: Inspect Excel Sheets
      description: Return sheet names from an Excel file without importing anything.
      operationId: inspect_excel_sheets_api_data_sources__source_id__excel_sheets_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_inspect_excel_sheets_api_data_sources__source_id__excel_sheets_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/upload-excel:
    post:
      tags:
      - Data Sources
      summary: Upload Excel
      description: Import selected sheets from an Excel file — one table per sheet.
      operationId: upload_excel_api_data_sources__source_id__upload_excel_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_excel_api_data_sources__source_id__upload_excel_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/{source_id}/tables:
    get:
      tags:
      - Data Sources
      summary: List Source Tables
      operationId: list_source_tables_api_data_sources__source_id__tables_get
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Data Sources
      summary: Expose Tables
      operationId: expose_tables_api_data_sources__source_id__tables_post
      parameters:
      - name: source_id
        in: path
        required: true
        schema:
          type: integer
          title: Source Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExposeTablesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/tables/{table_id}:
    patch:
      tags:
      - Data Sources
      summary: Patch Table
      operationId: patch_table_api_data_sources_tables__table_id__patch
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchTableRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Data Sources
      summary: Remove Table
      operationId: remove_table_api_data_sources_tables__table_id__delete
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/tables/{table_id}/sync:
    post:
      tags:
      - Data Sources
      summary: Sync Table
      operationId: sync_table_api_data_sources_tables__table_id__sync_post
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/tables/{table_id}/meta:
    get:
      tags:
      - Data Sources
      summary: Get Table Meta
      description: 'Return table metadata.


        With ``refresh=true`` and a live-query source, also introspects the remote

        schema and merges the result into the response in-memory — new remote columns

        are flagged ``status="new"``, stored columns missing remotely are flagged

        ``status="dropped"``. Nothing is written; persistence happens only when the

        caller subsequently PUTs ``/meta/columns``.'
      operationId: get_table_meta_api_data_sources_tables__table_id__meta_get
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      - name: refresh
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Refresh
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Data Sources
      summary: Update Table Meta
      operationId: update_table_meta_api_data_sources_tables__table_id__meta_put
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMetaRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/data-sources/tables/{table_id}/meta/columns:
    put:
      tags:
      - Data Sources
      summary: Update Table Columns
      description: 'Persist column metadata.


        For non-live tables (csv / sftp) — the local schema is the source of truth,

        so we only merge label/description for the columns the caller sent.


        For live-query tables — re-introspect the remote schema and reconcile:

        * only columns the caller sent AND that exist remotely are kept,

        * stored columns missing from the caller''s set are dropped,

        * remote columns the caller didn''t send are NOT auto-added (the user

        explicitly opts-in via the NEW checkbox on the detail page).'
      operationId: update_table_columns_api_data_sources_tables__table_id__meta_columns_put
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateColumnsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/my-tables:
    get:
      tags:
      - Data Sources
      summary: List My Tables
      description: 'Flat list of all tables in the org — readable by any authenticated user.


        Viewers only see tables from active, connected sources and column counts

        reflect committed columns only (pending ``status="new"``/``"dropped"`` entries

        are hidden). Admins see everything so they can manage broken sources.


        Team scope (V1, see docs/teams.md): a viewer with one or more

        ``team_users`` rows is restricted to the union of their teams''

        ``team_tables``; a viewer with zero rows sees every active+connected

        org table (the opt-in restriction model — teams narrow, not gate).

        Admin role bypasses the team filter.'
      operationId: list_my_tables_api_my_tables_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/my-tables/{table_id}:
    get:
      tags:
      - Data Sources
      summary: Get My Table
      description: 'Read-only column metadata for one table — readable by any authenticated user.


        Viewers can only read tables whose source is active+connected and only

        see committed columns (pending ``status="new"``/``"dropped"`` hidden).

        Admins see everything.


        Team scope (V1, see docs/teams.md): a viewer with one or more

        ``team_users`` rows can only read tables granted to those teams.'
      operationId: get_my_table_api_my_tables__table_id__get
      parameters:
      - name: table_id
        in: path
        required: true
        schema:
          type: integer
          title: Table Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Body_inspect_excel_no_source_api_excel_sheets_inspect_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_inspect_excel_no_source_api_excel_sheets_inspect_post
    UpdateTypeRequest:
      properties:
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        default_query_engine_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Default Query Engine Id
        can_schedule:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Can Schedule
        can_browse:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Can Browse
        is_live_query:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Live Query
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
        config_schema:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Config Schema
        supported_dialects:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Supported Dialects
      type: object
      title: UpdateTypeRequest
    Body_upload_excel_api_data_sources__source_id__upload_excel_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        sheets:
          type: string
          title: Sheets
      type: object
      required:
      - file
      - sheets
      title: Body_upload_excel_api_data_sources__source_id__upload_excel_post
    ExposeTablesRequest:
      properties:
        tables:
          items:
            $ref: '#/components/schemas/ExposeTableItem'
          type: array
          title: Tables
      type: object
      required:
      - tables
      title: ExposeTablesRequest
    TestConfigRequest:
      properties:
        source_type:
          type: string
          title: Source Type
        config:
          additionalProperties: true
          type: object
          title: Config
      type: object
      required:
      - source_type
      - config
      title: TestConfigRequest
    Body_inspect_excel_sheets_api_data_sources__source_id__excel_sheets_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
      type: object
      required:
      - file
      title: Body_inspect_excel_sheets_api_data_sources__source_id__excel_sheets_post
    UpdateEngineRequest:
      properties:
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
      type: object
      title: UpdateEngineRequest
    ExposeTableItem:
      properties:
        remote_path:
          type: string
          title: Remote Path
        display_name:
          type: string
          title: Display Name
      type: object
      required:
      - remote_path
      - display_name
      title: ExposeTableItem
    Body_upload_csv_api_data_sources__source_id__upload_post:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
        display_name:
          type: string
          title: Display Name
      type: object
      required:
      - file
      - display_name
      title: Body_upload_csv_api_data_sources__source_id__upload_post
    PatchTableRequest:
      properties:
        display_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Display Name
      type: object
      title: PatchTableRequest
    CreateDataSourceRequest:
      properties:
        name:
          type: string
          title: Name
        source_type:
          type: string
          title: Source Type
        config:
          additionalProperties: true
          type: object
          title: Config
        dialect:
          anyOf:
          - type: string
          - type: 'null'
          title: Dialect
      type: object
      required:
      - name
      - source_type
      - config
      title: CreateDataSourceRequest
    UpdateMetaRequest:
      properties:
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
      type: object
      title: UpdateMetaRequest
    UpdateDataSourceRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        config:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Config
        is_active:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Active
        sync_schedule:
          anyOf:
          - type: string
          - type: 'null'
          title: Sync Schedule
        dialect:
          anyOf:
          - type: string
          - type: 'null'
          title: Dialect
      type: object
      title: UpdateDataSourceRequest
    CreateTypeRequest:
      properties:
        source_type:
          type: string
          title: Source Type
        label:
          type: string
          title: Label
        default_query_engine_id:
          type: integer
          title: Default Query Engine Id
          default: 1
        can_schedule:
          type: boolean
          title: Can Schedule
          default: false
        can_browse:
          type: boolean
          title: Can Browse
          default: false
        is_live_query:
          type: boolean
          title: Is Live Query
          default: false
        is_active:
          type: boolean
          title: Is Active
          default: true
        config_schema:
          additionalProperties: true
          type: object
          title: Config Schema
          default: {}
        supported_dialects:
          items:
            type: string
          type: array
          title: Supported Dialects
          default: []
      type: object
      required:
      - source_type
      - label
      title: CreateTypeRequest
    UpdateColumnsRequest:
      properties:
        columns:
          additionalProperties:
            additionalProperties: true
            type: object
          type: object
          title: Columns
      type: object
      required:
      - columns
      title: UpdateColumnsRequest