> ## Documentation Index > Fetch the complete documentation index at: https://docs.mka1.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a vector store connector ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json get /api/v1/llm/vector_stores/connectors/{connector_id} openapi: 3.1.1 info: title: MKA1 API version: 1.1.0 description: >- The MKA1 API is a RESTful API that provides access to the MKA1 platform. Learn how to get started with the API and the TypeScript SDK [here](https://mka1.apidocumentation.com/guides/getting-started). license: name: Proprietary servers: - url: https://apigw.mka1.com description: MKA1 API Gateway - url: / description: Relative server URL (configurable via SDK constructor) security: [] tags: - name: Resource Authorization description: >- Manage permissions for LLM resources. Create resources, grant/revoke permissions, and delete resources. Only resource owners can grant, revoke, or delete permissions. x-displayName: Resource Authorization - name: Audit description: >- Audit API for org owners and admins. Trace one request end to end by its X-Request-ID: API gateway timing, the responses it created, and their model invocations and tool calls. x-displayName: Audit - name: Embeddings description: >- Text embedding API endpoints for generating vector representations of text. Create semantic embeddings for search, clustering, and similarity matching using various embedding models. x-displayName: Embeddings - name: Feedback description: >- User feedback API for rating and commenting on chat completions. Collect thumbs up/down ratings and detailed feedback to improve model responses and track user satisfaction. x-displayName: Feedback - name: Images description: >- Image generation API endpoints for creating images from text descriptions. Generate images with control over size, quality, and style. x-displayName: Images - name: MCP Vault description: >- MCP vault API for storing user-owned MCP server configurations and encrypted credentials. Agents reference vault IDs so secrets are resolved only at tool execution time. x-displayName: MCP Vault - name: Speech description: >- Speech API endpoints for audio processing. Convert text to natural-sounding speech (TTS) or transcribe speech to text (STT) in different languages. x-displayName: Speech - name: Usage description: >- Usage tracking and analytics API for monitoring token consumption, request counts, and cost analysis. View detailed statistics per user, model, and time period. x-displayName: Usage - name: Extract description: >- Structured data extraction API for extracting information from files. Define JSON schemas to extract structured data from images, PDFs, and documents. Supports reusable schema templates. x-displayName: Extract - name: Text Classification description: >- Text classification API for categorizing text into predefined labels. Use AI models to classify text content for sentiment analysis, topic categorization, and content moderation. x-displayName: Text Classification - name: Responses description: >- Agent-powered responses API for creating AI agents with autonomous tool usage. Build conversational assistants that can use web search, file operations, image generation, code execution, and MCP integrations. Supports background processing, streaming, and real-time status tracking. x-displayName: Responses - name: Files description: >- File management API for uploading, storing, and managing files with automatic expiration and S3 integration. Upload files that can be used with Assistants, Vector Stores, and other features. Files are stored in S3 with metadata tracked in PostgreSQL. Supports automatic cleanup of expired files. x-displayName: Files - name: Vector Stores description: >- Vector store API for storing and searching documents using embeddings. Create vector stores, upload files with automatic chunking and embedding generation, and perform semantic search. Files are processed asynchronously using Temporal workflows for durability. Supports automatic cleanup of expired stores and LanceDB for efficient vector storage. x-displayName: Vector Stores - name: Conversations description: >- Conversation management API for storing and retrieving conversation state across Response API calls. Create conversations, add items (user messages, assistant messages, system messages), and maintain conversation history. Supports metadata tracking and multi-turn dialogue state management. x-displayName: Conversations - name: Guardrails description: >- AI safety guardrails API for configuring content moderation and security policies. Set up ban word lists, prompt injection detection, and system prompt leakage prevention. Guardrails apply to all requests from an account and can be tested before deployment. x-displayName: Guardrails - name: Tool Policy description: >- Organization tool policy API. Org admins deny tool types, or require approval before their calls run, for every Responses request in the organization, including saved agent runs. The policy overrides what requests and agents configure. x-displayName: Tool Policy - name: Models description: >- Model listing API for discovering available models. Returns model IDs, ownership, and metadata for all registered models in the gateway. x-displayName: Models - name: Skills description: >- Skills API for managing versioned bundles of instructions and files following the Agent Skills standard. Create, version, and download reusable skill packages that include SKILL.md manifests for agent environments. x-displayName: Skills - name: Chat Completions description: >- **Deprecated: Use the Responses API (`/api/v1/llm/responses`) instead.** Chat completion endpoints with support for streaming, tool calls, and multiple providers. x-deprecated: true x-displayName: Chat Completions - name: Batches x-displayName: Batches - name: Evals x-displayName: Evals - name: Fine-Tuning x-displayName: Fine-Tuning - name: Memory Stores x-displayName: Memory Stores - name: Prompts x-displayName: Prompts - name: API Key x-displayName: API Key - name: OAuth x-displayName: OAuth - name: Session x-displayName: Session - name: Organization x-displayName: Organization - name: Cluster Admin x-displayName: Cluster Admin - name: Sessions description: Create, inspect, access, and terminate sandbox sessions. x-displayName: Sessions - name: Browser description: >- Connect to browser sessions through the gateway port proxy. Browser sessions expose a Chrome DevTools Protocol endpoint on port 9222. x-displayName: Browser - name: Execution description: Run shell commands and code inside an existing sandbox session. x-displayName: Execution - name: Workspace description: >- Inspect the workspace manifest, transfer files or archives, and download generated artifacts. x-displayName: Workspace - name: Sandbox Usage description: >- Aggregate sandbox usage statistics across sessions, execution, and workspace operations. x-displayName: Sandbox Usage - name: Sandbox Pricing description: >- Cluster-admin management of the sandbox compute rate card used for budgeted spend. x-displayName: Sandbox Pricing - name: Sandbox GitHub description: >- Connect a GitHub account, clone its repositories into sandbox sessions, and push branches and open pull requests from a session. The GitHub token stays in the sandbox service and never enters a session. x-displayName: Sandbox GitHub - name: Sandbox Environments description: >- Save reusable session configuration (repositories, environment variables, network access, and a setup script) and run the setup script in a session. x-displayName: Sandbox Environments - name: Sandbox Connectors description: >- Connect remote MCP servers (Linear, Notion, Sentry and others) to your account so Coding Harness sessions started from an environment that lists them can call their tools. The sandbox service keeps each connector's credential and never puts it in a session. x-displayName: Sandbox Connectors - name: Agents description: Create and manage reusable agent definitions. x-displayName: Agents - name: Agent Versions description: Inspect an agent's configuration history and roll back to a prior version. x-displayName: Agent Versions - name: Agent Runs description: Execute saved agents and inspect persisted run results. x-displayName: Agent Runs - name: Agent Connectors description: >- Connect saved agents to external messaging channels such as Telegram, including text, photo, and supported document exchange. x-displayName: Agent Connectors - name: Agent Schedules description: Create and manage scheduled or recurring saved agent runs. x-displayName: Agent Schedules - name: schema-4_other x-displayName: other - name: Billing x-displayName: Billing - name: Budgets x-displayName: Budgets - name: Settings x-displayName: Settings - name: Compute Jobs x-displayName: Compute Jobs - name: Compute Services x-displayName: Compute Services - name: Compute Catalog x-displayName: Compute Catalog - name: Compute Volumes x-displayName: Compute Volumes - name: Compute Pricing x-displayName: Compute Pricing - name: Compute Secrets x-displayName: Compute Secrets - name: Compute Usage x-displayName: Compute Usage - name: Compute Tenants x-displayName: Compute Tenants - description: Create, list, read, update, and delete repositories. name: Repositories x-displayName: Repositories - name: Tracking Experiments description: Create and query tenant experiments. x-displayName: Tracking Experiments - name: Tracking Runs description: Record and retrieve run parameters, metrics, and tags. x-displayName: Tracking Runs - name: analytics.projects x-displayName: Projects description: Create, list, rename, and archive analytics projects. - name: analytics.keys x-displayName: Capture keys description: Create and revoke project keys for sending events. - name: analytics x-displayName: Events description: Send events and query event counts or unique visitors. - name: analytics.events x-displayName: Event search description: List individual events with their properties, newest first. - name: analytics.visitors x-displayName: Visitor search description: List visitors by their latest activity, with first and last seen times. - name: generators x-displayName: generators - name: generations x-displayName: generations - name: formats x-displayName: formats - description: >- Flags, environments, evaluation, and the audit log. Administrative operations require a cluster administrator; evaluation uses an environment-specific evaluation key. name: Feature Flags x-displayName: Feature Flags - name: Service Status description: >- Current status of each service and the incident history, for this deployment's region. x-displayName: Service Status - name: Support Cases description: >- Open and follow support cases. Organization owners and admins see all of the organization's cases; other members see the cases they opened. x-displayName: Support Cases - name: Vector Store Connectors description: 'Vector store connectors: external locations mirrored into vector stores.' x-displayName: Vector Store Connectors paths: /api/v1/llm/vector_stores/connectors/{connector_id}: get: tags: - Vector Store Connectors summary: Get a vector store connector operationId: getVectorStoreConnector parameters: - name: connector_id in: path required: true schema: type: string description: The connector id. - name: X-On-Behalf-Of in: header required: false schema: type: string description: Optional external end-user identifier forwarded by the API gateway. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VectorStoreConnector' security: - bearerAuth: [] x-codeSamples: - lang: csharp label: CSharp (SDK) source: >- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; var sdk = new SDK(bearerAuth: ""); var res = await sdk.Llm.VectorStores.Connectors.GetAsync(connectorId: ""); // handle response - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.llm.vector_stores.connectors.get(connector_id="") # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.llm.vectorStores.connectors.get({ connectorId: "", }); console.log(result); } run(); - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\tmka1 \"github.com/MeetKai/mka1-sdks/go\"\n\t\"log\"\n\t\"github.com/MeetKai/mka1-sdks/go/models/components\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := mka1.New(\n mka1.WithSecurity(\"\"),\n )\n\n res, err := s.Llm.VectorStores.Connectors.Get(ctx, \"\", nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.VectorStoreConnector != nil {\n switch res.VectorStoreConnector.Location.Type {\n case components.LocationTypeVectorStoreConnectorS3Location:\n // res.VectorStoreConnector.Location.VectorStoreConnectorS3Location is populated\n case components.LocationTypeVectorStoreConnectorSharePointLocation:\n // res.VectorStoreConnector.Location.VectorStoreConnectorSharePointLocation is populated\n default:\n // Unknown type - use res.VectorStoreConnector.Location.GetUnknownRaw() for raw JSON\n }\n\n }\n}" components: schemas: VectorStoreConnector: type: object properties: id: type: string description: The connector id, prefixed `vsc_`. object: const: vector_store.connector type: $ref: '#/components/schemas/VectorStoreConnectorType' name: type: string location: anyOf: - $ref: '#/components/schemas/VectorStoreConnectorS3Location' - $ref: '#/components/schemas/VectorStoreConnectorSharePointLocation' description: >- Where the connector reads from, in the shape of its `type`. Fixed at creation. credentials_configured: const: true description: Credentials are write-only; this says a credential is stored. api_key_id: type: string description: >- The id of the API key the connector's syncs run as: the key's id, never its secret. It changes only when an update call is made with another key of the same principal. include_patterns: type: array items: type: string exclude_patterns: type: array items: type: string chunking_strategy: anyOf: - anyOf: - $ref: '#/components/schemas/VectorStoreConnectorAutoChunking' - $ref: '#/components/schemas/VectorStoreConnectorStaticChunking' - type: 'null' description: >- The chunking every mirrored file gets. Null means the gateway's automatic strategy. Fixed at creation. auto_sync: type: boolean sync_interval_minutes: type: integer minimum: -9007199254740991 maximum: 9007199254740991 next_sync_at: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: When the next scheduled sync fires (Unix seconds). - type: 'null' description: Null while auto_sync is off or no store is linked. status: $ref: '#/components/schemas/VectorStoreConnectorStatus' last_error: anyOf: - type: string - type: 'null' last_run: anyOf: - $ref: '#/components/schemas/VectorStoreConnectorRunSummary' - type: 'null' vector_store_ids: type: array items: type: string created_at: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: When the connector was created (Unix seconds). updated_at: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: When the connector was last changed (Unix seconds). required: - id - object - type - name - location - credentials_configured - api_key_id - include_patterns - exclude_patterns - chunking_strategy - auto_sync - sync_interval_minutes - next_sync_at - status - last_error - last_run - vector_store_ids - created_at - updated_at VectorStoreConnectorType: enum: - s3 - sharepoint type: string description: >- The kind of location. `s3` is a bucket on AWS S3 or S3-compatible storage. `sharepoint` is a document library of a SharePoint Online site. VectorStoreConnectorS3Location: type: object properties: bucket: type: string minLength: 3 maxLength: 63 pattern: ^[a-z0-9][a-z0-9.-]*[a-z0-9]$ description: The bucket to mirror from. prefix: type: string maxLength: 1024 default: '' description: >- Only objects whose key starts with this prefix are considered. Patterns are relative to it. region: type: string minLength: 1 maxLength: 64 description: The bucket's region, e.g. `us-west-2`. endpoint: anyOf: - type: string format: uri - type: 'null' default: null description: >- For S3-compatible storage: an https endpoint, reached with path-style addressing. Null for AWS S3. required: - bucket - region VectorStoreConnectorSharePointLocation: type: object properties: site_url: type: string maxLength: 2048 description: >- The SharePoint Online site's web address, e.g. `https://contoso.sharepoint.com/sites/Marketing`. Never dialed: it names the site. library: type: string minLength: 1 maxLength: 255 description: >- The document library's name as SharePoint shows it, e.g. `Documents`. folder: type: string maxLength: 1024 default: '' description: >- Only files inside this folder of the library are considered. Patterns are relative to it. Empty for the whole library. required: - site_url - library VectorStoreConnectorAutoChunking: type: object properties: type: const: auto required: - type description: The gateway's automatic chunking. VectorStoreConnectorStaticChunking: type: object properties: type: const: static static: type: object properties: chunk_overlap_tokens: type: integer minimum: 0 maximum: 9007199254740991 description: >- Tokens shared by consecutive chunks. Must not exceed half of max_chunk_size_tokens. max_chunk_size_tokens: type: integer minimum: 100 maximum: 4096 description: The maximum number of tokens in each chunk. required: - chunk_overlap_tokens - max_chunk_size_tokens required: - type - static VectorStoreConnectorStatus: enum: - idle - syncing - removing - error type: string description: >- `syncing` while a run is in progress, `removing` while a delete or unsync is in progress, `error` when the last run failed, else `idle`. VectorStoreConnectorRunSummary: type: object properties: id: type: string object: const: vector_store.connector.run status: $ref: '#/components/schemas/VectorStoreConnectorRunStatus' trigger: $ref: '#/components/schemas/VectorStoreConnectorRunTrigger' started_at: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: When the run started (Unix seconds). finished_at: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: When the run ended (Unix seconds). - type: 'null' added: type: integer minimum: -9007199254740991 maximum: 9007199254740991 updated: type: integer minimum: -9007199254740991 maximum: 9007199254740991 removed: type: integer minimum: -9007199254740991 maximum: 9007199254740991 restored: type: integer minimum: -9007199254740991 maximum: 9007199254740991 skipped: type: integer minimum: -9007199254740991 maximum: 9007199254740991 failed: type: integer minimum: -9007199254740991 maximum: 9007199254740991 error: anyOf: - type: string - type: 'null' description: >- Why the run failed as a whole; null when it completed or is still running. required: - id - object - status - trigger - started_at - finished_at - added - updated - removed - restored - skipped - failed - error VectorStoreConnectorRunStatus: enum: - running - completed - failed type: string VectorStoreConnectorRunTrigger: enum: - schedule - manual - created - linked - rules_changed type: string description: >- What started the run: the interval, a sync request, creation with stores, a store being linked, or a rule change. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Send Authorization: Bearer , using an MKA1 API key for automation or an OAuth API access token for a signed-in application. Use a dynamic security callback to refresh OAuth access tokens. Browser session-only operations still require their declared cookie. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.