OpenAPI::Client::OpenAI::Path::vector_stores(3)

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

DESCRIPTION
This document describes the API endpoint at "/vector_stores".

PATHS

  "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"

    Allowed 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 (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
           "data" : [
              "{\n  \"id\": \"vs_123\",\n  \"object\": \"vector_store\",\n  \"created_at\": 1698107661,\n  \"usage_bytes\": 123456,\n  \"last_active_at\": 1698107661,\n  \"name\": \"my_vector_store\",\n  \"status\": \"completed\",\n  \"file_counts\": {\n    \"in_progress\": 0,\n    \"completed\": 100,\n    \"cancelled\": 0,\n    \"failed\": 0,\n    \"total\": 100\n  },\n  \"last_used_at\": 1698107661\n}\n"
           ],
           "first_id" : "vs_abc123",
           "has_more" : false,
           "last_id" : "vs_abc456",
           "object" : "list"
        }

  "POST /vector_stores"
Create a vector store.

Operation ID

"createVectorStore"

    $client->createVectorStore( ... );

Parameters

Request Body

Content Type: "application/json"

Example:

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

Responses

Status Code: 200

OK

Content Types:

•   "application/json"

    Example (See the OpenAI spec for more detail <https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):

        {
          "id": "vs_123",
          "object": "vector_store",
          "created_at": 1698107661,
          "usage_bytes": 123456,
          "last_active_at": 1698107661,
          "name": "my_vector_store",
          "status": "completed",
          "file_counts": {
            "in_progress": 0,
            "completed": 100,
            "cancelled": 0,
            "failed": 0,
            "total": 100
          },
          "last_used_at": 1698107661
        }

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.