Trieve File API

The File API from Trieve — 1 operation(s) for file.

OpenAPI Specification

trieve-file-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Trieve REST Chunk File API
  version: '1'
  description: 'Trieve REST API for search, recommendations, RAG, and analytics. Endpoints

    derived from https://docs.trieve.ai/api-reference and the Redoc spec at

    https://api.trieve.ai/redoc.

    '
  contact:
    name: Trieve (Devflow, Inc.)
    url: https://docs.trieve.ai/api-reference
servers:
- url: https://api.trieve.ai
  description: Trieve Cloud (production)
- url: http://localhost:8090
  description: Self-hosted (local dev)
security:
- ApiKeyAuth: []
tags:
- name: File
paths:
  /api/file:
    post:
      tags:
      - File
      summary: Upload a file
      description: 'Upload a file to the S3 bucket attached to a dataset. Supports naive

        chunking via Apache Tika or vision-LLM markdown conversion.

        '
      parameters:
      - in: header
        name: TR-Dataset
        required: true
        schema:
          type: string
      responses:
        '200':
          description: File accepted (async processing)
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Trieve API key. User or API key must have admin or owner role on the

        targeted dataset''s organization.

        '