{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenAI Assistants Vector stores API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Vector stores",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns a list of vector stores.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "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.\n"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "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.\n"
              }
            ]
          },
          "docs": "Returns a list of vector stores."
        },
        {
          "info": {
            "name": "Create a vector store.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a vector store."
        },
        {
          "info": {
            "name": "Retrieves a vector store.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store to retrieve."
              }
            ]
          },
          "docs": "Retrieves a vector store."
        },
        {
          "info": {
            "name": "Modifies a vector store.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store to modify."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies a vector store."
        },
        {
          "info": {
            "name": "Delete a vector store.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store to delete."
              }
            ]
          },
          "docs": "Delete a vector store."
        },
        {
          "info": {
            "name": "Create a vector store file batch.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/file_batches",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store for which to create a File Batch.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The maximum number of files in a single batch request is 2000.\nVector store file attach requests are rate limited per vector store (300 requests per minute across both this endpoint and `/vector_stores/{vector_store_id}/files`).\nFor ingesting multiple files into the same vector store, this batch endpoint is recommended.\n"
        },
        {
          "info": {
            "name": "Retrieves a vector store file batch.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/file_batches/:batch_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store that the file batch belongs to."
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file batch being retrieved."
              }
            ]
          },
          "docs": "Retrieves a vector store file batch."
        },
        {
          "info": {
            "name": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/file_batches/:batch_id/cancel",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store that the file batch belongs to."
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file batch to cancel."
              }
            ]
          },
          "docs": "Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible."
        },
        {
          "info": {
            "name": "Returns a list of vector store files in a batch.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/file_batches/:batch_id/files",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store that the files belong to."
              },
              {
                "name": "batch_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file batch that the files belong to."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "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.\n"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "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.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`."
              }
            ]
          },
          "docs": "Returns a list of vector store files in a batch."
        },
        {
          "info": {
            "name": "Returns a list of vector store files.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/files",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store that the files belong to."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.\n"
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and `desc` for descending order.\n"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "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.\n"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "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.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`."
              }
            ]
          },
          "docs": "Returns a list of vector store files."
        },
        {
          "info": {
            "name": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/files",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store for which to create a File.\n"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint is subject to a per-vector-store write rate limit of 300 requests per minute, shared with `/vector_stores/{vector_store_id}/file_batches`.\nFor uploading multiple files to the same vector store, use the file batches endpoint to reduce request volume."
        },
        {
          "info": {
            "name": "Retrieves a vector store file.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/files/:file_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store that the file belongs to."
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file being retrieved."
              }
            ]
          },
          "docs": "Retrieves a vector store file."
        },
        {
          "info": {
            "name": "Update attributes on a vector store file.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/files/:file_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store the file belongs to."
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file to update attributes."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update attributes on a vector store file."
        },
        {
          "info": {
            "name": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/files/:file_id",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store that the file belongs to."
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file to delete."
              }
            ]
          },
          "docs": "Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the [delete file](/docs/api-reference/files/delete) endpoint."
        },
        {
          "info": {
            "name": "Retrieve the parsed contents of a vector store file.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/files/:file_id/content",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store."
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path",
                "description": "The ID of the file within the vector store."
              }
            ]
          },
          "docs": "Retrieve the parsed contents of a vector store file."
        },
        {
          "info": {
            "name": "Search a vector store for relevant chunks based on a query and file attributes filter.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.openai.com/v1/vector_stores/:vector_store_id/search",
            "params": [
              {
                "name": "vector_store_id",
                "value": "",
                "type": "path",
                "description": "The ID of the vector store to search."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Search a vector store for relevant chunks based on a query and file attributes filter."
        }
      ]
    }
  ],
  "bundled": true
}