{"openapi":"3.1.0","info":{"title":"Vectorize (BYOK) API","version":"0.1.0","description":"Vectorize (BYOK) lets an AI assistant read your own Vectorize data through the Vectorize API with a key you supply (Vectorize API access token). Read-only: 12 tools (list_workspaces, get_workspace, list_pipelines, get_pipeline, list_pipeline_events, get_pipeline_metrics, list_source_connectors, get_source_connector, list_destination_connectors, get_destination_connector,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vectorize-io.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vectorize-io/docs"},"termsOfService":"https://connectorbay.com/byok-vectorize-io/terms"},"servers":[{"url":"https://byok-vectorize-io.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vectorize-io/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_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the workspaces of the organization. Use for \"Which workspaces are in my Vectorize organization\".","description":"List the workspaces of the organization. Use for \"Which workspaces are in my Vectorize organization\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many workspaces to return (1 to 100).","title":"Limit"},"next_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Page token from the previous answer's nextToken, to fetch the next page.","title":"Next Token"}},"required":["organization_id"],"title":"list_workspacesArguments","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_workspace":{"post":{"operationId":"get_workspace","summary":"Get one workspace: name and dates. Use for \"Show the Vectorize workspace c4d5e6f7\".","description":"Get one workspace: name and dates. Use for \"Show the Vectorize workspace c4d5e6f7\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"workspace_id":{"description":"Workspace ID (from list_workspaces).","maxLength":200,"title":"Workspace Id","type":"string"}},"required":["organization_id","workspace_id"],"title":"get_workspaceArguments","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_pipelines":{"post":{"operationId":"list_pipelines","summary":"List RAG pipelines with status, document count and the connector types they use. Use for \"Which Vectorize pipelines do I","description":"List RAG pipelines with status, document count and the connector types they use. Use for \"Which Vectorize pipelines do I have and what is their status\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this workspace (from list_workspaces). Leave empty for all workspaces.","title":"Workspace Id"}},"required":["organization_id"],"title":"list_pipelinesArguments","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_pipeline":{"post":{"operationId":"get_pipeline","summary":"Get one pipeline: status, document count, connector types and creation date. Use for \"Show the Vectorize pipeline b843c7","description":"Get one pipeline: status, document count, connector types and creation date. Use for \"Show the Vectorize pipeline b843c74d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"pipeline_id":{"description":"Pipeline ID (from list_pipelines).","maxLength":200,"title":"Pipeline Id","type":"string"}},"required":["organization_id","pipeline_id"],"title":"get_pipelineArguments","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_pipeline_events":{"post":{"operationId":"list_pipeline_events","summary":"List recent events of a pipeline (ingestion and processing steps) with type and time. Use for \"What happened recently in","description":"List recent events of a pipeline (ingestion and processing steps) with type and time. Use for \"What happened recently in Vectorize pipeline b843c74d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"pipeline_id":{"description":"Pipeline ID (from list_pipelines).","maxLength":200,"title":"Pipeline Id","type":"string"},"next_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Page token from the previous answer's nextToken, to fetch the next page.","title":"Next Token"}},"required":["organization_id","pipeline_id"],"title":"list_pipeline_eventsArguments","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_pipeline_metrics":{"post":{"operationId":"get_pipeline_metrics","summary":"Get the counts of new, changed and deleted objects a pipeline processed over time. Use for \"How many documents has Vecto","description":"Get the counts of new, changed and deleted objects a pipeline processed over time. Use for \"How many documents has Vectorize pipeline b843c74d processed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"pipeline_id":{"description":"Pipeline ID (from list_pipelines).","maxLength":200,"title":"Pipeline Id","type":"string"}},"required":["organization_id","pipeline_id"],"title":"get_pipeline_metricsArguments","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_source_connectors":{"post":{"operationId":"list_source_connectors","summary":"List the source connectors of the organization with type, name and verification status. Credentials are not shown. Use f","description":"List the source connectors of the organization with type, name and verification status. Credentials are not shown. Use for \"Which source connectors do I have in Vectorize\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this workspace (from list_workspaces). Leave empty for all workspaces.","title":"Workspace Id"}},"required":["organization_id"],"title":"list_source_connectorsArguments","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_source_connector":{"post":{"operationId":"get_source_connector","summary":"Get one source connector: type, name, verification status and last error. Credentials are not shown. Use for \"Show the V","description":"Get one source connector: type, name, verification status and last error. Credentials are not shown. Use for \"Show the Vectorize source connector 550e8400-e29b-41d4-a716-446655440000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"source_connector_id":{"description":"Source connector ID (from list_source_connectors).","maxLength":200,"title":"Source Connector Id","type":"string"}},"required":["organization_id","source_connector_id"],"title":"get_source_connectorArguments","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_destination_connectors":{"post":{"operationId":"list_destination_connectors","summary":"List the destination connectors of the organization with type, name and verification status. Credentials are not shown. ","description":"List the destination connectors of the organization with type, name and verification status. Credentials are not shown. Use for \"Which destination connectors do I have in Vectorize\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this workspace (from list_workspaces). Leave empty for all workspaces.","title":"Workspace Id"}},"required":["organization_id"],"title":"list_destination_connectorsArguments","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_destination_connector":{"post":{"operationId":"get_destination_connector","summary":"Get one destination connector: type, name, verification status and last error. Credentials are not shown. Use for \"Show ","description":"Get one destination connector: type, name, verification status and last error. Credentials are not shown. Use for \"Show the Vectorize destination connector 550e8400-e29b-41d4-a716-446655440000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"destination_connector_id":{"description":"Destination connector ID (from list_destination_connectors).","maxLength":200,"title":"Destination Connector Id","type":"string"}},"required":["organization_id","destination_connector_id"],"title":"get_destination_connectorArguments","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_aiplatform_connectors":{"post":{"operationId":"list_aiplatform_connectors","summary":"List the AI platform connectors of the organization with type, name and verification status. Credentials are not shown. ","description":"List the AI platform connectors of the organization with type, name and verification status. Credentials are not shown. Use for \"Which AI platform connectors do I have in Vectorize\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only items in this workspace (from list_workspaces). Leave empty for all workspaces.","title":"Workspace Id"}},"required":["organization_id"],"title":"list_aiplatform_connectorsArguments","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_aiplatform_connector":{"post":{"operationId":"get_aiplatform_connector","summary":"Get one AI platform connector: type, name, verification status and last error. Credentials are not shown. Use for \"Show ","description":"Get one AI platform connector: type, name, verification status and last error. Credentials are not shown. Use for \"Show the Vectorize AI platform connector 550e8400-e29b-41d4-a716-446655440000\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Your Vectorize organization ID (shown in the console URL and on the API access page).","maxLength":200,"title":"Organization Id","type":"string"},"ai_platform_connector_id":{"description":"Ai platform connector ID (from list_aiplatform_connectors).","maxLength":200,"title":"Ai Platform Connector Id","type":"string"}},"required":["organization_id","ai_platform_connector_id"],"title":"get_aiplatform_connectorArguments","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}}}}