Skip to main content
GET
/
vector_stores
Error
A valid request URL is required to generate request examples
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "vector_store",
      "created_at": 123,
      "name": "<string>",
      "usage_bytes": 123,
      "file_counts": {
        "in_progress": 123,
        "completed": 123,
        "failed": 123,
        "cancelled": 123,
        "total": 123
      },
      "last_active_at": 123,
      "metadata": {},
      "expires_after": {
        "anchor": "last_active_at",
        "days": 183
      },
      "expires_at": 123
    }
  ],
  "first_id": "<string>",
  "last_id": "<string>",
  "has_more": true
}

Authorizations

​
api-key
string
header
required

Query Parameters

​
api-version
enum<string>
default:v1

The explicit Azure AI Foundry Models API version to use for this request. v1 if not otherwise specified.

Available options:
v1,
preview
​
limit
integer<int32>
default:20

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

​
order
enum<string>

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order.

Available options:
asc,
desc
​
after
string

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.

​
before
string

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, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

Response

The request has succeeded.

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
first_id
string
required
​
last_id
string
required
​
has_more
boolean
required