DeepFellow DOCS

Create a vector store.

Create a vector store with specified configuration parameters.

Initialize a new vector store that can be configured with file chunking strategies, expiration policies or retention strategies, and metadata. The operation involves multiple steps:

  1. Validate if the name is unique within the project.
  2. Create a document in the vector stores collection.
  3. Initialize a corresponding collection in the underlying vector database.
  4. Process associated files for vector store creation.

Needs user bearer token in authorization header.

POST
/v1/vector_stores
AuthorizationBearer <token>

In: header

Header Parameters

OpenAI-Organization?Openai-Organization
OpenAI-Project?Openai-Project
chunking_strategy?ChunkingStrategy
Default{"type":"auto","static":{"chunk_overlap_tokens":400,"max_chunk_size_tokens":800}}
expires_after?ExpirationPolicy | null
file_ids?File Ids

A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.

Default[]
metadata?Metadata | null
name?VectorStoreName

The name of the vector store.

Default""

Response Body

curl -X POST "https://loading/v1/vector_stores" \
  -H "OpenAI-Organization: 5eb7cf5a86d9755df3a6c593" \
  -H "OpenAI-Project: 5eb7cf5a86d9755df3a6c593" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "project_id": "5eb7cf5a86d9755df3a6c593",
  "object": "vector_store",
  "name": "",
  "status": "in_progress",
  "file_counts": {
    "cancelled": 0,
    "completed": 0,
    "failed": 0,
    "in_progress": 0,
    "total": 0
  },
  "expires_after": {
    "anchor": "last_active_at",
    "days": 36500
  },
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "chunking_strategy": {
    "type": "auto",
    "static": {
      "chunk_overlap_tokens": 400,
      "max_chunk_size_tokens": 800
    }
  },
  "id": "5eb7cf5a86d9755df3a6c593",
  "last_active_at": 0,
  "created_at": 0,
  "expires_at": 0,
  "bytes": 0
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.