stores

Get a file from a store.

Args: store_identifier: The ID or name of the store. file_id: The ID or name of the file. options: Get file options.

Returns: VectorStoreFile: The file details.

get/v1/stores/{store_identifier}/files/{file_identifier}

Request

  • Base URL
    https://api.mixedbread.com
  • URL
    https://api.mixedbread.com/v1/stores/{store_identifier}/files/{file_identifier}
  • Auth
    HTTP bearer

Path parameters

string required
OR
string uuid required
string required
OR
string uuid required

Query parameters

boolean
OR
integer[]

Response

The store file details

idstring required

Unique identifier for the file

filenamestring

Name of the file

metadataunknown
external_idstring nullable

External identifier for this file in the store

status'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed'

The lifecycle of a unit of background work.

One vocabulary for every job family. The database keeps a separate enum type per table (parsing_job_status, store_file_status, ...) but they all carry these values, so the aliases below are this enum rather than copies of it. :class:SyncStatus is this set plus IDLE for connectors, which have a resting state between runs.

last_errorunknown
store_idstring required

ID of the containing store

created_atstring date-time required

Timestamp of store file creation

versioninteger nullable

Version number of the file

usage_bytesinteger nullable

Storage usage in bytes

usage_tokensinteger nullable

Storage usage in tokens

object'store.file'

Type of the object

content_urlstring required

Presigned URL for file content

Example response

{
  "version": 1,
  "usage_bytes": 51200,
  "usage_tokens": 51200,
  "chunks": [
    {
      "mime_type": "text/plain",
      "model": "text-embedding-ada-002",
      "context": "This chunk is from an SEC filing on ACME corp's Q2 2023 performance.",
      "summary": "A short overview of ACME's Q2 2023 performance."
    }
  ]
}

Changes

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status