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

# Initiate a hosted upload

> Starts a multipart upload to a hosted source and returns an upload session. Follow with requests to sign parts, then complete the upload to enqueue ingestion.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/ingest/sources/{source_key}/uploads
openapi: 3.1.0
info:
  description: >-
    Splendor is a search and retrieval API for your operational data. Ingest

    datasets — logs, documents, and structured records — and query them through
    one

    consistent interface that spans full-text, SQL, and semantic (vector)
    search.


    Every request authenticates with a bearer token and selects a workspace with
    the

    `X-Splendor-Tenant-Id` header. Read and query operations are available to
    any

    member; operations that create, change, or delete data require an admin
    role.


    All search modes return one shared envelope, and every result carries
    provenance

    back to the exact source object it came from.
  title: Splendor API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.withsplendor.com
security:
  - bearerAuth: []
tags:
  - description: Resolve the authenticated user and the tenants they can access.
    name: Identity
  - description: >-
      Build on Splendor as a platform: authenticate with a platform API key to
      provision an isolated tenant per end-customer and manage your platform
      keys.
    name: Platform
  - description: >-
      List datasets, inspect inferred schemas and readiness, and manage dataset
      lifecycle including deletion and schema rebuilds.
    name: Datasets & schema
  - description: >-
      Run full-text, SQL, and semantic search over your datasets, stream
      results, and resolve object media.
    name: Search & query
  - description: Save queries and materialize result sets for repeatable analysis.
    name: Views
  - description: >-
      Define named, versioned, parameterized SQL queries and manage their
      versions.
    name: Query Endpoints
  - description: Create and manage asynchronous exports of search results.
    name: Exports
  - description: >-
      Configure data sources, upload data through hosted multipart uploads,
      stream logs, and track ingest runs.
    name: Sources & ingest
  - description: >-
      Connect third-party systems by managing connector instances in the
      selected tenant.
    name: Connectors
  - description: Define and test detection rules that run against incoming data.
    name: Detections
  - description: Inspect discovered fields and promote them to fast, aggregatable fields.
    name: Fields
  - description: >-
      Operational visibility and recovery: audit logs, usage, dead-letter queue,
      reindex jobs, and data-deletion jobs.
    name: Operations
paths:
  /v1/ingest/sources/{source_key}/uploads:
    post:
      tags:
        - Sources & ingest
      summary: Initiate a hosted upload
      description: >-
        Starts a multipart upload to a hosted source and returns an upload
        session. Follow with requests to sign parts, then complete the upload to
        enqueue ingestion.
      operationId: initiateUpload
      parameters:
        - in: path
          name: source_key
          required: true
          schema:
            title: Source Key
            type: string
        - $ref: '#/components/parameters/SplendorTenantId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostedUploadInitiateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostedUploadInitiateResponse'
          description: Successful Response
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
          description: The requested resource was not found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  parameters:
    SplendorTenantId:
      description: Selects the tenant (workspace) the request acts within.
      in: header
      name: x-splendor-tenant-id
      required: true
      schema:
        type: string
  schemas:
    HostedUploadInitiateRequest:
      properties:
        content_type:
          maxLength: 255
          minLength: 1
          title: Content Type
          type: string
        filename:
          anyOf:
            - maxLength: 1024
              type: string
            - type: 'null'
          title: Filename
        object_size_bytes:
          minimum: 0
          title: Object Size Bytes
          type: integer
      required:
        - object_size_bytes
        - content_type
      title: HostedUploadInitiateRequest
      type: object
    HostedUploadInitiateResponse:
      example:
        bucket: acme-uploads
        expires_at: '2026-01-15T09:30:00Z'
        key: uploads/ups_01H8Z3/data.jsonl
        part_size_bytes: 8388608
        required_headers: {}
        upload_id: mpu_1
        upload_mode: multipart
        upload_session_id: ups_01H8Z3
        upload_url: null
      properties:
        bucket:
          title: Bucket
          type: string
        expires_at:
          format: date-time
          title: Expires At
          type: string
        key:
          title: Key
          type: string
        part_size_bytes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Part Size Bytes
        required_headers:
          additionalProperties:
            type: string
          title: Required Headers
          type: object
        upload_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Upload Id
        upload_mode:
          enum:
            - single
            - multipart
          title: Upload Mode
          type: string
        upload_session_id:
          title: Upload Session Id
          type: string
        upload_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Upload Url
      required:
        - upload_session_id
        - bucket
        - key
        - upload_mode
        - expires_at
        - part_size_bytes
        - upload_id
        - upload_url
        - required_headers
      title: HostedUploadInitiateResponse
      type: object
    ApiError:
      description: >-
        Error envelope returned by every Splendor API endpoint.


        ``detail`` is either a plain message string (most errors) or a
        structured

        ``{code, message}`` object (validation and capacity errors that carry a
        stable

        machine-readable code).
      examples:
        - detail: Dataset not found
        - detail:
            code: semantic_search_capacity_exhausted
            message: Semantic search capacity is temporarily exhausted; retry shortly.
      properties:
        detail:
          anyOf:
            - type: string
            - $ref: '#/components/schemas/ErrorBody'
          title: Detail
      required:
        - detail
      title: ApiError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ErrorBody:
      description: Structured error detail returned by validation and capacity errors.
      examples:
        - code: semantic_query_text_required
          message: Semantic vector search requires non-empty text.
      properties:
        code:
          title: Code
          type: string
        message:
          title: Message
          type: string
      required:
        - code
        - message
      title: ErrorBody
      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
  responses:
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: The bearer token is missing, malformed, or expired.
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      description: The token lacks access to the tenant or the role required.
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: API token issued from the Splendor console.
      scheme: bearer
      type: http

````