Sign in
stores

Create a store

Create a new vector store.

Args: vector_store_create: VectorStoreCreate object containing the name, description, and metadata.

Returns: VectorStore: The response containing the created vector store details.

post/v1/stores

Request body

namestring nullable

Name for the new store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).

descriptionstring nullable

Description of the store

is_publicboolean

Whether the store can be accessed by anyone with valid login credentials

licensestring nullable

License for public stores

{"stackTrail":"components:schemas:StoreCreateParams:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Optional metadata key-value pairs","nullable":true}
tagsstring[]

Tags for organizing stores. Trimmed, lowercased and deduplicated.

file_idsstring[] nullable

Optional list of file IDs

Example request

{
  "name": "technical-documentation",
  "description": "Contains technical specifications and guides",
  "tags": [
    "production",
    "docs"
  ]
}

Response

The details of the created store

idstring required

Unique identifier for the store

namestring required

Name of the store

descriptionstring nullable

Detailed description of the store's purpose and contents

is_publicboolean

Whether the store can be accessed by anyone with valid login credentials

licensestring nullable

License for public stores

{"stackTrail":"components:schemas:Store:properties:metadata:anyOf","oasType":"schema","type":"unknown","title":"Metadata","description":"Additional metadata associated with the store","example":{"category":"support","language":"en"},"nullable":true}
tagsstring[]

Tags for organizing stores

bucket_idstring nullable

Customer bucket backing this store's storage; null = platform default

status'expired' | 'in_progress' | 'completed' | 'failed'

Status of a store.

created_atstring date-time required

Timestamp when the store was created

updated_atstring date-time required

Timestamp when the store was last updated

last_active_atstring date-time nullable

Timestamp when the store was last used

usage_bytesinteger

Total storage usage in bytes

usage_tokensinteger

Total storage usage in tokens

expires_atstring date-time nullable

Optional expiration timestamp for the store

object'store'

Type of the object

Example response

{
  "id": "1b8b486e-16d0-400b-8868-04cd75217a7e",
  "name": "customer-support-kb",
  "description": "Contains customer support articles and FAQs",
  "metadata": {
    "category": "support",
    "language": "en"
  },
  "tags": [
    "production",
    "docs"
  ],
  "file_counts": {
    "pending": 5,
    "in_progress": 5,
    "cancelled": 2,
    "completed": 42,
    "failed": 1,
    "total": 50
  },
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "usage_bytes": 1024000,
  "usage_tokens": 1024000,
  "expires_at": "2024-01-01T00:00:00Z"
}

Changes

Changed in 3 of the 30 revisions of this API.15

  • bc159968f2112See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 957bf8ec8df811See the full diff
    • ●

      added the new failed enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • ce403656bc182See the full diff
    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

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

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog