List files in vector store

curl --request GET \
  --url https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'

import requests

url = "https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files"

headers = {
    "x-api-key": "<api-key>",
    "x-selected-account-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', 'x-selected-account-id': '<api-key>'}
};

fetch('https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>",
    "x-selected-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-selected-account-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files")
  .header("x-api-key", "<api-key>")
  .header("x-selected-account-id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "parse_result_id": "<string>",
      "vector_store_id": "<string>",
      "file_id": "<string>",
      "file_name": "<string>",
      "file_size": 123,
      "file_mime_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 123,
  "next_token": "<string>",
  "prev_token": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Vector Stores

List files in vector store

Retrieve a paginated list of files that have been added to a vector store.

This endpoint returns all files that are currently indexed in the specified vector store, including their metadata such as file name, size, MIME type, and creation timestamp.

Token-based Pagination:

New syntax (recommended): Use page_size, continuation_token, sort_by, sort_order query parameters
Legacy syntax (deprecated): Use size and continuation_token query parameters
If no pagination parameters are provided, returns a plain list
Use the next_token from the response to fetch subsequent pages
When next_token is null, you have reached the last page

Returns:

Paginated list of vector store file entities
Total count of files in the vector store
next_token for pagination (null if no more pages)
File metadata including ID, name, size, and MIME type

Example Response:

{
    "items": [
        {
            "id": "vsf_123456789",
            "vector_store_id": "vs_123456789",
            "parse_result_id": "pres_987654321",
            "file_id": "file_987654321",
            "file_name": "document.pdf",
            "file_size": 1024000,
            "file_mime_type": "application/pdf",
            "created_at": "2024-01-15T10:30:00Z"
        }
    ],
    "total_count": 1,
    "next_token": "eyJmaWxlX2lkIjoiZmlsZV85ODc2NTQzMjEifQ=="
}

GET

projects

{project_id}

vector-stores

{vector_store_id}

files

List files in vector store

curl --request GET \
  --url https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'

import requests

url = "https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files"

headers = {
    "x-api-key": "<api-key>",
    "x-selected-account-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<api-key>', 'x-selected-account-id': '<api-key>'}
};

fetch('https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>",
    "x-selected-account-id: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-selected-account-id", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files")
  .header("x-api-key", "<api-key>")
  .header("x-selected-account-id", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/projects/{project_id}/vector-stores/{vector_store_id}/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-selected-account-id"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "parse_result_id": "<string>",
      "vector_store_id": "<string>",
      "file_id": "<string>",
      "file_name": "<string>",
      "file_size": 123,
      "file_mime_type": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 123,
  "next_token": "<string>",
  "prev_token": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

x-api-key

string

header

required

API key for authentication

x-selected-account-id

string

header

required

Selected Account ID

Path Parameters

project_id

string

required

vector_store_id

string

required

Query Parameters

size

integer

default:999

deprecated

[DEPRECATED] Maximum number of files to return per page. Use page_size instead.

Required range: 1 <= x <= 1000

Example:

20

continuation_token

string | null

Pagination token

page_size

integer | null

Number of items per page

Required range: 1 <= x <= 100

sort_by

string | null

Field to sort by

sort_order

enum<string> | null

Sort order (asc or desc) Enum for project sort fields. Note that only non-nullable fields can be sorted by (for details, see: https://github.com/djrobstep/sqlakeyset?tab=readme-ov-file#limitations ).

Available options:

asc,

desc

Response

List of files retrieved successfully

items

VectorStoreFileEntity · object[]

required

Show child attributes

total_count

integer

required

next_token

string | null

prev_token

string | null

Delete a vector store Add files to vector store

⌘I

Projects

Files

Parse

Vector Stores

Extract

Research

Jobs

Indexes

List files in vector store

Authorizations

Path Parameters

Query Parameters

Response