NAME

OpenAPI::Client::OpenAI::Path::vector_stores - Documentation for the /vector_stores path.

DESCRIPTION

This document describes the API endpoint at /vector_stores.

See the examples/ directory in the distribution for examples of how to use this.

GET /vector_stores

Returns a list of vector stores.

Operation ID

listVectorStores

$client->listVectorStores( ... );

Parameters

• limit (in query) (Optional) - A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

  Type: integer

  Default: 20

• order (in query) (Optional) - Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.

  Type: string

  Possible values: asc desc

  Default: desc

• after (in query) (Optional) - A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

  Type: string

• before (in query) (Optional) - A cursor for use in pagination. `before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

  Type: string

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example:

  {
     "object" : "list",
     "data" : [
        {
           "file_counts" : null,
           "expires_after" : null
        }
     ],
     "has_more" : false,
     "first_id" : "vs_abc123",
     "last_id" : "vs_abc456"
  }

POST /vector_stores

Create a vector store.

Operation ID

createVectorStore

$client->createVectorStore( ... );

Request Body

Content Type: application/json

Example:

{
   "file_ids" : [
      null
   ],
   "expires_after" : null
}

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example:

  {
     "expires_after" : null,
     "file_counts" : null
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.

cpanm OpenAPI::Client::OpenAI

perl -MCPAN -e shell
install OpenAPI::Client::OpenAI