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-upload-session-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:
  description: deepset API description
  title: Haystack Enterprise Platform Upload Session 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: upload_session
paths:
  /api/v1/workspaces/{workspace_name}/upload_sessions:
    get:
      description: Returns a list of all active upload sessions.
      operationId: get_upload_sessions_api_v1_workspaces__workspace_name__upload_sessions_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
      - description: Specifies if the session is expired.
        in: query
        name: is_expired
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Specifies if the session is expired.
          title: Is Expired
      - description: The number of entries to display. Leaving this field empty keeps the default, and max 10 results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: The number of entries to display. Leaving this field empty keeps the default, and max 10 results are returned.
          maximum: 100
          title: Limit
          type: integer
      - description: Enter an ID if you want to see all entries before this ID. To use this option, clear the `page_number` parameter first.
        in: query
        name: before
        required: false
        schema:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: Enter an ID if you want to see all entries before this ID. To use this option, clear the `page_number` parameter first.
          title: Before
      - description: Enter an ID if you want to see all entries after this ID. To use this option, clear the `page_number` parameter first.
        in: query
        name: after
        required: false
        schema:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: Enter an ID if you want to see all entries after this ID. To use this option, clear the `page_number` parameter first.
          title: After
      - description: The number of the page you want to see.
        in: query
        name: page_number
        required: false
        schema:
          anyOf:
          - minimum: 1
            type: integer
          - type: 'null'
          description: The number of the page you want to see.
          title: Page Number
      - description: The name of the entity you want to sort by.<br/><br/>Supported values:<ul><li>`created_at`</li><li>`expires_at`</li><li>`file_count`</li><li>`ingestion_status_reason`</li><li>`name`</li><li>`status`</li><li>`write_mode`</li></ul>
        in: query
        name: field
        required: false
        schema:
          default: created_at
          description: The name of the entity you want to sort by.<br/><br/>Supported values:<ul><li>`created_at`</li><li>`expires_at`</li><li>`file_count`</li><li>`ingestion_status_reason`</li><li>`name`</li><li>`status`</li><li>`write_mode`</li></ul>
          enum:
          - created_at
          - expires_at
          - ingestion_status_reason
          - name
          - file_count
          - status
          - write_mode
          title: Field
          type: string
      - description: Choose how you want to sort the results.
        in: query
        name: order
        required: false
        schema:
          default: DESC
          description: Choose how you want to sort the results.
          enum:
          - ASC
          - DESC
          title: Order
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResult_Session_'
          description: Your upload sessions.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Get Upload Sessions
      tags:
      - upload_session
      x-deepset-permissions:
        action: write
        asset: files
        asset_description: Access to individual file details
        type: workspace
  /api/v1/workspaces/{workspace_name}/upload_sessions/{session_id}/files:
    get:
      description: Displays the file details of a session. Use this endpoint to check the status of the files in a session or the session expiration date.
      operationId: get_session_files_api_v1_workspaces__workspace_name__upload_sessions__session_id__files_get
      parameters:
      - description: The ID of the session.
        in: path
        name: session_id
        required: true
        schema:
          description: The ID of the session.
          format: uuid
          title: Session Id
          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
      - description: Use this option to filter for files that are still being ingested or that were already ingested.
        in: query
        name: ingestion_status
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/FileIngestionStatusEnum'
          - type: 'null'
          description: Use this option to filter for files that are still being ingested or that were already ingested.
          title: Filter for Ingestion Status
      - description: The number of entries to display. Leaving this field empty keeps the default, and max 10 results are returned.
        in: query
        name: limit
        required: false
        schema:
          default: 10
          description: The number of entries to display. Leaving this field empty keeps the default, and max 10 results are returned.
          maximum: 100
          title: Limit
          type: integer
      - description: Enter an ID if you want to see all entries before this ID. To use this option, clear the `page_number` parameter first.
        in: query
        name: before
        required: false
        schema:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: Enter an ID if you want to see all entries before this ID. To use this option, clear the `page_number` parameter first.
          title: Before
      - description: Enter an ID if you want to see all entries after this ID. To use this option, clear the `page_number` parameter first.
        in: query
        name: after
        required: false
        schema:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: Enter an ID if you want to see all entries after this ID. To use this option, clear the `page_number` parameter first.
          title: After
      - description: The number of the page you want to see.
        in: query
        name: page_number
        required: false
        schema:
          anyOf:
          - minimum: 1
            type: integer
          - type: 'null'
          description: The number of the page you want to see.
          title: Page Number
      - description: The name of the entity you want to sort by.<br/><br/>Supported values:<ul><li>`created_at`</li><li>`ingestion_status`</li><li>`ingestion_status_reason`</li><li>`name`</li></ul>
        in: query
        name: field
        required: false
        schema:
          default: created_at
          description: The name of the entity you want to sort by.<br/><br/>Supported values:<ul><li>`created_at`</li><li>`ingestion_status`</li><li>`ingestion_status_reason`</li><li>`name`</li></ul>
          enum:
          - created_at
          - ingestion_status
          - ingestion_status_reason
          - name
          title: Field
          type: string
      - description: Choose how you want to sort the results.
        in: query
        name: order
        required: false
        schema:
          default: DESC
          description: Choose how you want to sort the results.
          enum:
          - ASC
          - DESC
          title: Order
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResult_SessionFile_'
          description: Returns a list of files registered to the session.
        '404':
          description: 'There''s no session with the ID ''{session_id}'' in the workspace. Check if the ID is correct. '
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Get Session Files
      tags:
      - upload_session
      x-deepset-permissions:
        action: write
        asset: files
        asset_description: Access to individual file details
        type: workspace
components:
  schemas:
    PaginatedResult_Session_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Session'
          title: Data
          type: array
        has_more:
          description: Indicates if there are more results to show.
          title: Has more results
          type: boolean
        total:
          description: The total number of results matching your query.
          title: Total number of results
          type: integer
      required:
      - data
      - has_more
      - total
      title: PaginatedResult[Session]
      type: object
    FileWriteModeEnum:
      enum:
      - KEEP
      - OVERWRITE
      - FAIL
      - TEMPORARY
      title: FileWriteModeEnum
      type: string
    SessionStatusEnum:
      enum:
      - OPEN
      - CLOSED
      - EXPIRED
      title: SessionStatusEnum
      type: string
    FileIngestionStatusEnum:
      enum:
      - PENDING
      - FAILED
      - FINISHED
      title: FileIngestionStatusEnum
      type: string
    UserIdName:
      properties:
        family_name:
          description: Family name of a user.
          title: Family name
          type: string
        given_name:
          description: Given name of a user.
          title: Given name
          type: string
        user_id:
          description: Unique identifier of a user.
          format: uuid
          title: User ID
          type: string
      required:
      - given_name
      - family_name
      - user_id
      title: Oauth User
      type: object
    FileIngestionStatusReasonEnum:
      enum:
      - EMPTY_FILE
      - FILE_NOT_FOUND
      - FAILED_TO_PARSE_META
      - FILE_ALREADY_EXISTS
      - INGESTING_FILE_FAILED
      - UNKNOWN_ERROR
      - FILE NAME TOO LONG. MAX LENGTH IS 800
      - SLOWDOWN
      title: FileIngestionStatusReasonEnum
      type: string
    SessionFile:
      properties:
        file_ingestion_id:
          description: The ID of the ingested file.
          format: uuid
          title: Ingested File ID
          type: string
        ingestion_status:
          $ref: '#/components/schemas/FileIngestionStatusEnum'
          description: The ingestion status of the ingested file.
          title: Ingested File Ingestion Status
        ingestion_status_reason:
          anyOf:
          - $ref: '#/components/schemas/FileIngestionStatusReasonEnum'
          - type: 'null'
          description: The ingestion status message that explains the ingestion status. This is only available for files that failed to ingest.
          title: Explanation of the Ingestion Status
        name:
          description: The name of the ingested file.
          title: Ingested File Name
          type: string
      required:
      - name
      - ingestion_status
      title: SessionFile
      type: object
    PaginatedResult_SessionFile_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/SessionFile'
          title: Data
          type: array
        has_more:
          description: Indicates if there are more results to show.
          title: Has more results
          type: boolean
        total:
          description: The total number of results matching your query.
          title: Total number of results
          type: integer
      required:
      - data
      - has_more
      - total
      title: PaginatedResult[SessionFile]
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      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
    Session:
      properties:
        created_at:
          description: The time when the session was created.
          format: date-time
          title: Session Created At
          type: string
        created_by:
          $ref: '#/components/schemas/UserIdName'
          description: The user who created the session.
          title: Session Created By User
        expires_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: The time when the session expires.
          title: Session Expires At
        session_id:
          description: Unique identifier of a session.
          format: uuid
          title: Session ID
          type: string
        status:
          $ref: '#/components/schemas/SessionStatusEnum'
          default: OPEN
          description: The status of the upload session. The status can be 'OPEN' or 'CLOSED'.
          title: Session Status
        write_mode:
          $ref: '#/components/schemas/FileWriteModeEnum'
          default: KEEP
          description: Determines how to handle files that already exist. You can KEEP the existing file, OVERWRITE it, or FAIL to ingest if a file with the same name is already in your workspace.
          title: Write Mode
      required:
      - expires_at
      - created_by
      - created_at
      title: Session
      type: object