{"openapi":"3.1.0","info":{"title":"OpenAI vector stores, files and batches (your key) API","version":"0.1.0","description":"OpenAI vector stores, files and batches (your key) lets an AI assistant read your own OpenAI Vector Stores data through the OpenAI Vector Stores API with a key you supply (OpenAI API key). Read-only: 6 tools (list_vector_stores, get_vector_store, list_vector_store_files, get_vector_store_file, get_file_batch, list_file_batch_files). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-openai-vector-stores.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-openai-vector-stores/docs"},"termsOfService":"https://connectorbay.com/byok-openai-vector-stores/terms"},"servers":[{"url":"https://byok-openai-vector-stores.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-openai-vector-stores/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_vector_stores":{"post":{"operationId":"list_vector_stores","summary":"List vector stores with name, status, size in bytes, file counts and last activity (Unix seconds). Reads store metadata ","description":"List vector stores with name, status, size in bytes, file counts and last activity (Unix seconds). Reads store metadata only: it runs no search and no embedding. Use for \"Which vector stores do I have in OpenAI and how big are they\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for paging: the last_id of the previous page.","title":"After"},"before":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for paging backwards: the first_id of the page after the wanted one.","title":"Before"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time: desc (default, newest first) or asc.","title":"Order"}},"title":"list_vector_storesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_vector_store":{"post":{"operationId":"get_vector_store","summary":"Get one vector store: name, status, size, file counts, expiry policy and metadata. Reads store metadata only: it runs no","description":"Get one vector store: name, status, size, file counts, expiry policy and metadata. Reads store metadata only: it runs no search and no embedding. Use for \"What is the status of OpenAI vector store vs_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vector_store_id":{"description":"Vector store id, for example 'vs_abc123'.","maxLength":100,"title":"Vector Store Id","type":"string"}},"required":["vector_store_id"],"title":"get_vector_storeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_vector_store_files":{"post":{"operationId":"list_vector_store_files","summary":"List the files attached to a vector store with indexing status, size in bytes, last error and attributes. Reads store me","description":"List the files attached to a vector store with indexing status, size in bytes, last error and attributes. Reads store metadata only: it runs no search and no embedding. Use for \"Which files are in OpenAI vector store vs_abc123 and did any fail\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vector_store_id":{"description":"Vector store id, for example 'vs_abc123'.","maxLength":100,"title":"Vector Store Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for paging: the last_id of the previous page.","title":"After"},"before":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for paging backwards: the first_id of the page after the wanted one.","title":"Before"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time: desc (default, newest first) or asc.","title":"Order"},"filter":{"anyOf":[{"enum":["in_progress","completed","failed","cancelled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only files with this status.","title":"Filter"}},"required":["vector_store_id"],"title":"list_vector_store_filesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_vector_store_file":{"post":{"operationId":"get_vector_store_file","summary":"Get one file of a vector store: indexing status, size in bytes, last error, chunking strategy type and attributes. Reads","description":"Get one file of a vector store: indexing status, size in bytes, last error, chunking strategy type and attributes. Reads store metadata only: it runs no search and no embedding. Use for \"Is file file-abc123 indexed in OpenAI vector store vs_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vector_store_id":{"description":"Vector store id, for example 'vs_abc123'.","maxLength":100,"title":"Vector Store Id","type":"string"},"file_id":{"description":"File id, for example 'file-abc123'.","maxLength":100,"title":"File Id","type":"string"}},"required":["vector_store_id","file_id"],"title":"get_vector_store_fileArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_file_batch":{"post":{"operationId":"get_file_batch","summary":"Get one file batch of a vector store: status and file counts by state. Reads store metadata only: it runs no search and ","description":"Get one file batch of a vector store: status and file counts by state. Reads store metadata only: it runs no search and no embedding. Use for \"How far along is OpenAI file batch vsfb_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vector_store_id":{"description":"Vector store id, for example 'vs_abc123'.","maxLength":100,"title":"Vector Store Id","type":"string"},"batch_id":{"description":"File batch id, for example 'vsfb_abc123'.","maxLength":100,"title":"Batch Id","type":"string"}},"required":["vector_store_id","batch_id"],"title":"get_file_batchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_file_batch_files":{"post":{"operationId":"list_file_batch_files","summary":"List the files of one vector store file batch with indexing status and size. Reads store metadata only: it runs no searc","description":"List the files of one vector store file batch with indexing status and size. Reads store metadata only: it runs no search and no embedding. Use for \"Which files are in OpenAI file batch vsfb_abc123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vector_store_id":{"description":"Vector store id, for example 'vs_abc123'.","maxLength":100,"title":"Vector Store Id","type":"string"},"batch_id":{"description":"File batch id, for example 'vsfb_abc123'.","maxLength":100,"title":"Batch Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (1 to 100).","title":"Limit"},"after":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for paging: the last_id of the previous page.","title":"After"},"before":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor for paging backwards: the first_id of the page after the wanted one.","title":"Before"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":"desc","description":"Sort order by creation time: desc (default, newest first) or asc.","title":"Order"},"filter":{"anyOf":[{"enum":["in_progress","completed","failed","cancelled"],"type":"string"},{"type":"null"}],"default":null,"description":"Only files with this status.","title":"Filter"}},"required":["vector_store_id","batch_id"],"title":"list_file_batch_filesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}