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

# List Datasets

> List all datasets in your Friendli Suite project via the API. Returns dataset IDs, names, split counts, and creation timestamps for each entry.

List datasets.

To request successfully, it is required to enter a **Personal API Key** (e.g. flp\_XXX) in the **Bearer Token** field.
Refer to the [authentication section](/openapi/introduction#authentication) on our introduction page to learn more and [visit here](https://friendli.ai/suite/~/setting/keys) to generate your API Key.

<Info>
  This API is currently in **Beta**.
  While we strive to provide a stable and reliable experience, this feature is still under active development.
  As a result, you may encounter unexpected behavior or limitations.
  We encourage you to provide feedback to help us improve the feature before its official release.

  * [Feature request & feedback](mailto:support@friendli.ai)
  * [Contact support](mailto:support@friendli.ai)
</Info>


## OpenAPI

````yaml https://github.com/friendliai/friendli-openapi/raw/refs/heads/main/openapi.yaml get /beta/dataset
openapi: 3.1.0
info:
  title: Friendli Suite API Reference
  description: This is an OpenAPI reference of Friendli Suite API.
  termsOfService: https://friendli.ai/terms-of-service
  contact:
    name: FriendliAI Support Team
    email: support@friendli.ai
  version: 0.1.0
servers:
  - url: https://api.friendli.ai
security: []
tags:
  - name: Serverless.Chat
  - name: Serverless.ToolAssistedChat
  - name: Serverless.Messages
  - name: Serverless.ChatRender
  - name: Serverless.Completions
  - name: Serverless.Token
  - name: Serverless.Audio
  - name: Serverless.Model
  - name: Serverless.Knowledge
  - name: Dedicated.Chat
  - name: Dedicated.Messages
  - name: Dedicated.ChatRender
  - name: Dedicated.Completions
  - name: Dedicated.Embeddings
  - name: Dedicated.TextClassification
  - name: Dedicated.Token
  - name: Dedicated.Image
  - name: Dedicated.Audio
  - name: Dedicated.Endpoint
  - name: Container.Chat
  - name: Container.Messages
  - name: Container.Completions
  - name: Container.TextClassification
  - name: Container.Token
  - name: Container.Image
  - name: Container.Audio
  - name: Cost
  - name: Dataset
  - name: File
paths:
  /beta/dataset:
    get:
      tags:
        - Dataset
      summary: List datasets
      description: List datasets accessible to the user.
      operationId: list_datasets
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: binary
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 100
                minimum: 1
              - type: 'null'
            default: 20
            title: Limit
        - name: direction
          in: query
          required: false
          schema:
            anyOf:
              - enum:
                  - asc
                  - desc
                type: string
              - type: 'null'
            title: Direction
        - name: projectId
          in: query
          required: true
          schema:
            type: string
            title: Projectid
        - name: nameSearch
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Namesearch
        - name: X-Friendli-Team
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: ID of team to run requests as (optional parameter).
            title: X-Friendli-Team
          description: ID of team to run requests as (optional parameter).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
              examples:
                Example:
                  value:
                    data:
                      - id: 123
                        name: dataset-name
                        created_at: 1705244400
                        updated_at: 1765724399
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - token: []
components:
  schemas:
    ListDatasetsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/DatasetInfo'
          type: array
          title: Data
          description: List of items.
        nextCursor:
          anyOf:
            - type: string
              format: binary
            - type: 'null'
          title: Nextcursor
          description: >-
            Next cursor to use for pagination. `None` indicates no more items to
            fetch.
      type: object
      required:
        - data
      title: ListDatasetsResponse
      description: List datasets response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DatasetInfo:
      properties:
        id:
          type: string
          title: Id
          description: ID of the dataset.
        name:
          type: string
          title: Name
          description: Name of the dataset.
        createdAt:
          type: integer
          title: Createdat
          description: Unix timestamp (in seconds) of when the dataset was created.
        updatedAt:
          type: integer
          title: Updatedat
          description: Unix timestamp (in seconds) of when the dataset was last modified.
        modality:
          $ref: '#/components/schemas/DedicatedDatasetModality'
          description: Modality of the dataset.
      type: object
      required:
        - id
        - name
        - createdAt
        - updatedAt
        - modality
      title: DatasetInfo
      description: Dataset info.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    DedicatedDatasetModality:
      properties:
        input_modals:
          items:
            $ref: '#/components/schemas/DedicatedDatasetModalityType'
          type: array
          title: Input Modals
          default: []
        output_modals:
          items:
            $ref: '#/components/schemas/DedicatedDatasetModalityType'
          type: array
          title: Output Modals
          default: []
      type: object
      title: DedicatedDatasetModality
      description: Dataset modality.
    DedicatedDatasetModalityType:
      type: string
      enum:
        - VIDEO
        - IMAGE
        - AUDIO
        - TEXT
      title: DedicatedDatasetModalityType
      description: Modality type.
  securitySchemes:
    token:
      type: http
      description: >-
        When using Friendli Suite API for inference requests, you need to
        provide a **Personal API Key** for authentication and authorization
        purposes.


        For more detailed information, please refer
        [here](https://friendli.ai/docs/openapi/introduction#authentication).
      scheme: bearer

````