Label Studio

Label Studio Subpackage Files API

The subpackage_files API from Label Studio — 3 operation(s) for subpackage_files.

GitHub OpenAPI

Operations 6

GET /api/import/file-upload/{id} Get file upload #
DELETE /api/import/file-upload/{id} Delete file upload #
PATCH /api/import/file-upload/{id} Update file upload #
GET /api/projects/{id}/file-uploads Get files list #
DELETE /api/projects/{id}/file-uploads Delete files #
GET /data/upload/{filename} Download file #

Documentation

📖
Documentation
https://labelstud.io/
📖
APIReference
https://api.labelstud.io/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/label-studio/openapi/label-studio-subpackage-files-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/HumanSignal/label-studio
🔗
Community
https://labelstud.io/community

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/label-studio:label-studio-subpackage-files-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

label-studio-subpackage-files-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Reference Subpackage Files API
  version: 1.0.0
servers:
- url: http://localhost:8000
tags:
- name: subpackage_files
paths:
  /api/import/file-upload/{id}:
    get:
      operationId: get
      summary: Get file upload
      description: Retrieve details about a specific uploaded file.
      tags:
      - subpackage_files
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUpload'
    delete:
      operationId: delete
      summary: Delete file upload
      description: Delete a specific uploaded file.
      tags:
      - subpackage_files
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
    patch:
      operationId: update
      summary: Update file upload
      description: Update a specific uploaded file.
      tags:
      - subpackage_files
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileUpload'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedFileUploadRequest'
  /api/projects/{id}/file-uploads:
    get:
      operationId: list
      summary: Get files list
      description: Retrieve the list of uploaded files used to create labeling tasks for a specific project.
      tags:
      - subpackage_files
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: all
        in: query
        description: Set to "true" if you want to retrieve all file uploads
        required: false
        schema:
          type: boolean
      - name: ids
        in: query
        description: Specify the list of file upload IDs to retrieve, e.g. ids=[1,2,3]
        required: false
        schema:
          type: array
          items:
            type: string
      - name: ordering
        in: query
        description: Which field to use when ordering the results.
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FileUpload'
    delete:
      operationId: delete-many
      summary: Delete files
      description: Delete uploaded files for a specific project.
      tags:
      - subpackage_files
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
  /data/upload/{filename}:
    get:
      operationId: download
      summary: Download file
      description: Download a specific uploaded file.
      tags:
      - subpackage_files
      parameters:
      - name: filename
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: File downloaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/files_download_Response_200'
components:
  schemas:
    PatchedFileUploadRequest:
      type: object
      properties:
        file:
          type: string
          format: binary
      title: PatchedFileUploadRequest
    files_download_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: files_download_Response_200
    FileUpload:
      type: object
      properties:
        file:
          type: string
        id:
          type: integer
        size:
          type:
          - integer
          - 'null'
      required:
      - file
      - id
      - size
      title: FileUpload
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Authorization
      description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
x-provenance:
  method: harvested
  publisher: Label Studio
  source: https://api.labelstud.io/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)