Add Collection File

POST /v1/vector_store/{id}/files View .md

Adds a file to a vector store collection.

Path parameters

id string required

The ID of the vector store collection.

Body

multipart/form-data

file string (binary) required

The file object to be uploaded to the vector store collection.

Responses

application/json · add-vector-store-file-response-payload

1 field

file object

An object representing a file uploaded to a vector store collection.
6 fields
- id string
  
  The unique ID of the vector store collection file.
- filename string
  
  The name and extension of the file added to the vector store collection.
- status string
  
  The current processing status of the vector store collection file.
  
  enqueuedprocessingcompleteerror
- error string
  
  The description of what error was reached while processing the file for error status only.
- items integer
  
  The number of embeddings records representing the file in the vector store collection. Omitted for error status.
- tokens integer
  
  The number of tokens used while processing the uploaded file. Omitted for error status.

curl https://api.vultrinference.com/v1/vector_store/{id}/files \
  -H "Authorization: Bearer $VULTR_INFERENCE_API_KEY" \
  -F "file=@file.pdf"

import os
import requests

response = requests.post(
    "https://api.vultrinference.com/v1/vector_store/{id}/files",
    headers={"Authorization": f"Bearer {os.environ['VULTR_INFERENCE_API_KEY']}"},
    files={"file": open("file.pdf", "rb")},
)
print(response.json())

import { openAsBlob } from "node:fs";

const form = new FormData();
form.append("file", await openAsBlob("file.pdf"), "file.pdf");

const response = await fetch("https://api.vultrinference.com/v1/vector_store/{id}/files", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.VULTR_INFERENCE_API_KEY}`,
  },
  body: form,
});
console.log(await response.json());

Response · 201

{
    "file": {
        "id": "string",
        "filename": "string",
        "status": "enqueued",
        "error": "string",
        "items": 0,
        "tokens": 0
    }
}