Haystack / deepset

Haystack / deepset Datasets API

The Datasets API from Haystack / deepset — 2 operation(s) for datasets.

GitHub OpenAPI

Operations 2

GET /api/v1/workspaces/{workspace_name}/datasets List Datasets #
POST /api/v1/workspaces/{workspace_name}/datasets/{dataset_name} Add Files #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/haystack-ai/openapi/haystack-ai-datasets-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/haystack-ai:haystack-ai-datasets-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

haystack-ai-datasets-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: deepset API description
  title: Haystack Enterprise Platform Datasets API
  version: 1.0.0
servers:
- description: deepset Europe
  url: https://api.cloud.deepset.ai
- description: deepset US
  url: https://api.us.deepset.ai
tags:
- name: Datasets
paths:
  /api/v1/workspaces/{workspace_name}/datasets:
    get:
      description: 'Lists all datasets in a workspace with their associated files.

        Supports pagination.'
      operationId: list_datasets_api_v1_workspaces__workspace_name__datasets_get
      parameters:
      - description: Type the name of the workspace.
        in: path
        name: workspace_name
        required: true
        schema:
          description: Type the name of the workspace.
          title: Workspace Name
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetPagination'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: List Datasets
      tags:
      - Datasets
      x-deepset-permissions:
        action: read
        asset: files
        asset_description: Access to individual file details
        type: workspace
  /api/v1/workspaces/{workspace_name}/datasets/{dataset_name}:
    post:
      description: Adds files to a dataset by calling the file service's add_file method for each file.
      operationId: add_files_api_v1_workspaces__workspace_name__datasets__dataset_name__post
      parameters:
      - in: path
        name: dataset_name
        required: true
        schema:
          title: Dataset Name
          type: string
      - description: Type the name of the workspace.
        in: path
        name: workspace_name
        required: true
        schema:
          description: Type the name of the workspace.
          title: Workspace Name
          type: string
      responses:
        '204':
          description: Dataset uploaded successfully
        '404':
          description: Dataset not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Add Files
      tags:
      - Datasets
      x-deepset-permissions:
        action: read
        asset: files
        asset_description: Access to individual file details
        type: workspace
components:
  schemas:
    Dataset:
      properties:
        file_names:
          description: List of file names associated with the dataset
          items:
            type: string
          title: File Names
          type: array
        name:
          description: Name of the dataset
          title: Dataset Name
          type: string
      required:
      - name
      - file_names
      title: Dataset
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    DatasetPagination:
      properties:
        data:
          description: List of datasets in the current page
          items:
            $ref: '#/components/schemas/Dataset'
          title: Dataset Items
          type: array
        total:
          description: Total number of datasets available
          title: Total Count
          type: integer
      required:
      - data
      - total
      title: DatasetPagination
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object