Create a vector store connector

POST

api

llm

vector_stores

connectors

CSharp (SDK)

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;
using MeetKai.MKA1.Types.Requests;

var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Llm.VectorStores.Connectors.CreateAsync(body: CreateVectorStoreConnectorRequestBody.CreateS3(
    new VectorStoreConnectorCreateS3() {
        Location = new VectorStoreConnectorS3Location() {
            Bucket = "<value>",
            Region = "<value>",
        },
        Credentials = new VectorStoreConnectorS3Credentials() {
            AccessKeyId = "<id>",
            SecretAccessKey = "<value>",
        },
        Name = "<value>",
    }
));

// handle response

from meetkai_mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.vector_stores.connectors.create(body={
        "type": "s3",
        "location": {
            "bucket": "<value>",
            "prefix": "",
            "region": "<value>",
        },
        "credentials": {
            "access_key_id": "<id>",
            "secret_access_key": "<value>",
        },
        "name": "<value>",
        "auto_sync": True,
    })

    # Handle response
    print(res)

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.llm.vectorStores.connectors.create({
    requestBody: {
      type: "s3",
      location: {
        bucket: "<value>",
        prefix: "",
        region: "<value>",
      },
      credentials: {
        accessKeyId: "<id>",
        secretAccessKey: "<value>",
      },
      name: "<value>",
      autoSync: true,
    },
  });

  console.log(result);
}

run();

package main

import(
	"context"
	mka1 "github.com/MeetKai/mka1-sdks/go"
	"github.com/MeetKai/mka1-sdks/go/models/components"
	"github.com/MeetKai/mka1-sdks/go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := mka1.New(
        mka1.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
    )

    res, err := s.Llm.VectorStores.Connectors.Create(ctx, operations.CreateCreateVectorStoreConnectorRequestBodyS3(
        components.VectorStoreConnectorCreateS3{
            Location: components.VectorStoreConnectorS3Location{
                Bucket: "<value>",
                Region: "<value>",
            },
            Credentials: components.VectorStoreConnectorS3Credentials{
                AccessKeyID: "<id>",
                SecretAccessKey: "<value>",
            },
            Name: "<value>",
        },
    ), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.VectorStoreConnector != nil {
        switch res.VectorStoreConnector.Location.Type {
            case components.LocationTypeVectorStoreConnectorS3Location:
                // res.VectorStoreConnector.Location.VectorStoreConnectorS3Location is populated
            case components.LocationTypeVectorStoreConnectorSharePointLocation:
                // res.VectorStoreConnector.Location.VectorStoreConnectorSharePointLocation is populated
            default:
                // Unknown type - use res.VectorStoreConnector.Location.GetUnknownRaw() for raw JSON
        }

    }
}

curl --request POST \
  --url https://apigw.mka1.com/api/v1/llm/vector_stores/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "s3",
  "location": {
    "bucket": "<string>",
    "region": "<string>",
    "prefix": "",
    "endpoint": "<string>"
  },
  "credentials": {
    "access_key_id": "<string>",
    "secret_access_key": "<string>"
  },
  "name": "<string>",
  "include_patterns": [],
  "exclude_patterns": [],
  "chunking_strategy": {
    "type": "auto"
  },
  "auto_sync": true,
  "sync_interval_minutes": 5047,
  "vector_store_ids": []
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 's3',
    location: {bucket: '<string>', region: '<string>', prefix: '', endpoint: '<string>'},
    credentials: {access_key_id: '<string>', secret_access_key: '<string>'},
    name: '<string>',
    include_patterns: [],
    exclude_patterns: [],
    chunking_strategy: {type: 'auto'},
    auto_sync: true,
    sync_interval_minutes: 5047,
    vector_store_ids: []
  })
};

fetch('https://apigw.mka1.com/api/v1/llm/vector_stores/connectors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/llm/vector_stores/connectors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 's3',
    'location' => [
        'bucket' => '<string>',
        'region' => '<string>',
        'prefix' => '',
        'endpoint' => '<string>'
    ],
    'credentials' => [
        'access_key_id' => '<string>',
        'secret_access_key' => '<string>'
    ],
    'name' => '<string>',
    'include_patterns' => [
        
    ],
    'exclude_patterns' => [
        
    ],
    'chunking_strategy' => [
        'type' => 'auto'
    ],
    'auto_sync' => true,
    'sync_interval_minutes' => 5047,
    'vector_store_ids' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/llm/vector_stores/connectors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"s3\",\n  \"location\": {\n    \"bucket\": \"<string>\",\n    \"region\": \"<string>\",\n    \"prefix\": \"\",\n    \"endpoint\": \"<string>\"\n  },\n  \"credentials\": {\n    \"access_key_id\": \"<string>\",\n    \"secret_access_key\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"include_patterns\": [],\n  \"exclude_patterns\": [],\n  \"chunking_strategy\": {\n    \"type\": \"auto\"\n  },\n  \"auto_sync\": true,\n  \"sync_interval_minutes\": 5047,\n  \"vector_store_ids\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/llm/vector_stores/connectors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"s3\",\n  \"location\": {\n    \"bucket\": \"<string>\",\n    \"region\": \"<string>\",\n    \"prefix\": \"\",\n    \"endpoint\": \"<string>\"\n  },\n  \"credentials\": {\n    \"access_key_id\": \"<string>\",\n    \"secret_access_key\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"include_patterns\": [],\n  \"exclude_patterns\": [],\n  \"chunking_strategy\": {\n    \"type\": \"auto\"\n  },\n  \"auto_sync\": true,\n  \"sync_interval_minutes\": 5047,\n  \"vector_store_ids\": []\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "vector_store.connector",
  "type": "s3",
  "name": "<string>",
  "location": {
    "bucket": "<string>",
    "region": "<string>",
    "prefix": "",
    "endpoint": "<string>"
  },
  "credentials_configured": true,
  "api_key_id": "<string>",
  "include_patterns": [
    "<string>"
  ],
  "exclude_patterns": [
    "<string>"
  ],
  "chunking_strategy": {
    "type": "auto"
  },
  "auto_sync": true,
  "sync_interval_minutes": 0,
  "next_sync_at": 0,
  "status": "idle",
  "last_error": "<string>",
  "last_run": {
    "id": "<string>",
    "object": "vector_store.connector.run",
    "status": "running",
    "trigger": "schedule",
    "started_at": 0,
    "finished_at": 0,
    "added": 0,
    "updated": 0,
    "removed": 0,
    "restored": 0,
    "skipped": 0,
    "failed": 0,
    "error": "<string>"
  },
  "vector_store_ids": [
    "<string>"
  ],
  "created_at": 0,
  "updated_at": 0
}

Authorizations

Authorization

string

header

required

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.

Headers

X-On-Behalf-Of

string

Optional external end-user identifier forwarded by the API gateway.

Body

application/json

Option 1
Option 2

type

any

required

location

object

required

Show child attributes

credentials

object

required

A read-only access key pair for the bucket. Write-only: never returned.

Show child attributes

name

string

required

Required string length: 1 - 255

include_patterns

string[]

A glob relative to the connector's prefix: * within one folder, ** across folders, ? one character, [abc] a set; backslash escapes. Every other character is literal.

Minimum string length: 1

exclude_patterns

string[]

A glob relative to the connector's prefix: * within one folder, ** across folders, ? one character, [abc] a set; backslash escapes. Every other character is literal.

Minimum string length: 1

chunking_strategy

object

The gateway's automatic chunking.

Option 1
Option 2

Show child attributes

auto_sync

boolean

default:true

On: sync every interval. Off: only when asked.

sync_interval_minutes

integer

Minutes between syncs while auto_sync is on, from 15 to 10080. The default is the operator's, 60 unless changed.

Required range: 15 <= x <= 10080

vector_store_ids

string[]

Stores to link at creation. With auto_sync on, the first sync starts at once.

Response

200 - application/json

string

required

The connector id, prefixed vsc_.

object

any

required

type

enum<string>

required

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.

Available options:

s3,

sharepoint

name

string

required

location

object

required

Where the connector reads from, in the shape of its type. Fixed at creation.

Option 1
Option 2

Show child attributes

credentials_configured

any

required

Credentials are write-only; this says a credential is stored.

api_key_id

string

required

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

string[]

required

exclude_patterns

string[]

required

chunking_strategy

object

required

The chunking every mirrored file gets. Null means the gateway's automatic strategy. Fixed at creation.

Option 1
Option 2

Show child attributes

auto_sync

boolean

required

sync_interval_minutes

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

next_sync_at

integer | null

required

Null while auto_sync is off or no store is linked.

Required range: -9007199254740991 <= x <= 9007199254740991

status

enum<string>

required

syncing while a run is in progress, removing while a delete or unsync is in progress, error when the last run failed, else idle.

Available options:

idle,

syncing,

removing,

error

last_error

string | null

required

last_run

object | null

required

Show child attributes

vector_store_ids

string[]

required

created_at

integer

required

When the connector was created (Unix seconds).

Required range: -9007199254740991 <= x <= 9007199254740991

updated_at

integer

required

When the connector was last changed (Unix seconds).

Required range: -9007199254740991 <= x <= 9007199254740991

⌘I

CSharp (SDK)

using MeetKai.MKA1;
using MeetKai.MKA1.Types.Components;
using MeetKai.MKA1.Types.Requests;

var sdk = new SDK(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Llm.VectorStores.Connectors.CreateAsync(body: CreateVectorStoreConnectorRequestBody.CreateS3(
    new VectorStoreConnectorCreateS3() {
        Location = new VectorStoreConnectorS3Location() {
            Bucket = "<value>",
            Region = "<value>",
        },
        Credentials = new VectorStoreConnectorS3Credentials() {
            AccessKeyId = "<id>",
            SecretAccessKey = "<value>",
        },
        Name = "<value>",
    }
));

// handle response

from meetkai_mka1 import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.vector_stores.connectors.create(body={
        "type": "s3",
        "location": {
            "bucket": "<value>",
            "prefix": "",
            "region": "<value>",
        },
        "credentials": {
            "access_key_id": "<id>",
            "secret_access_key": "<value>",
        },
        "name": "<value>",
        "auto_sync": True,
    })

    # Handle response
    print(res)

import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.llm.vectorStores.connectors.create({
    requestBody: {
      type: "s3",
      location: {
        bucket: "<value>",
        prefix: "",
        region: "<value>",
      },
      credentials: {
        accessKeyId: "<id>",
        secretAccessKey: "<value>",
      },
      name: "<value>",
      autoSync: true,
    },
  });

  console.log(result);
}

run();

package main

import(
	"context"
	mka1 "github.com/MeetKai/mka1-sdks/go"
	"github.com/MeetKai/mka1-sdks/go/models/components"
	"github.com/MeetKai/mka1-sdks/go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := mka1.New(
        mka1.WithSecurity("<YOUR_BEARER_TOKEN_HERE>"),
    )

    res, err := s.Llm.VectorStores.Connectors.Create(ctx, operations.CreateCreateVectorStoreConnectorRequestBodyS3(
        components.VectorStoreConnectorCreateS3{
            Location: components.VectorStoreConnectorS3Location{
                Bucket: "<value>",
                Region: "<value>",
            },
            Credentials: components.VectorStoreConnectorS3Credentials{
                AccessKeyID: "<id>",
                SecretAccessKey: "<value>",
            },
            Name: "<value>",
        },
    ), nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.VectorStoreConnector != nil {
        switch res.VectorStoreConnector.Location.Type {
            case components.LocationTypeVectorStoreConnectorS3Location:
                // res.VectorStoreConnector.Location.VectorStoreConnectorS3Location is populated
            case components.LocationTypeVectorStoreConnectorSharePointLocation:
                // res.VectorStoreConnector.Location.VectorStoreConnectorSharePointLocation is populated
            default:
                // Unknown type - use res.VectorStoreConnector.Location.GetUnknownRaw() for raw JSON
        }

    }
}

curl --request POST \
  --url https://apigw.mka1.com/api/v1/llm/vector_stores/connectors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "s3",
  "location": {
    "bucket": "<string>",
    "region": "<string>",
    "prefix": "",
    "endpoint": "<string>"
  },
  "credentials": {
    "access_key_id": "<string>",
    "secret_access_key": "<string>"
  },
  "name": "<string>",
  "include_patterns": [],
  "exclude_patterns": [],
  "chunking_strategy": {
    "type": "auto"
  },
  "auto_sync": true,
  "sync_interval_minutes": 5047,
  "vector_store_ids": []
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 's3',
    location: {bucket: '<string>', region: '<string>', prefix: '', endpoint: '<string>'},
    credentials: {access_key_id: '<string>', secret_access_key: '<string>'},
    name: '<string>',
    include_patterns: [],
    exclude_patterns: [],
    chunking_strategy: {type: 'auto'},
    auto_sync: true,
    sync_interval_minutes: 5047,
    vector_store_ids: []
  })
};

fetch('https://apigw.mka1.com/api/v1/llm/vector_stores/connectors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apigw.mka1.com/api/v1/llm/vector_stores/connectors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 's3',
    'location' => [
        'bucket' => '<string>',
        'region' => '<string>',
        'prefix' => '',
        'endpoint' => '<string>'
    ],
    'credentials' => [
        'access_key_id' => '<string>',
        'secret_access_key' => '<string>'
    ],
    'name' => '<string>',
    'include_patterns' => [
        
    ],
    'exclude_patterns' => [
        
    ],
    'chunking_strategy' => [
        'type' => 'auto'
    ],
    'auto_sync' => true,
    'sync_interval_minutes' => 5047,
    'vector_store_ids' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://apigw.mka1.com/api/v1/llm/vector_stores/connectors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"s3\",\n  \"location\": {\n    \"bucket\": \"<string>\",\n    \"region\": \"<string>\",\n    \"prefix\": \"\",\n    \"endpoint\": \"<string>\"\n  },\n  \"credentials\": {\n    \"access_key_id\": \"<string>\",\n    \"secret_access_key\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"include_patterns\": [],\n  \"exclude_patterns\": [],\n  \"chunking_strategy\": {\n    \"type\": \"auto\"\n  },\n  \"auto_sync\": true,\n  \"sync_interval_minutes\": 5047,\n  \"vector_store_ids\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apigw.mka1.com/api/v1/llm/vector_stores/connectors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"s3\",\n  \"location\": {\n    \"bucket\": \"<string>\",\n    \"region\": \"<string>\",\n    \"prefix\": \"\",\n    \"endpoint\": \"<string>\"\n  },\n  \"credentials\": {\n    \"access_key_id\": \"<string>\",\n    \"secret_access_key\": \"<string>\"\n  },\n  \"name\": \"<string>\",\n  \"include_patterns\": [],\n  \"exclude_patterns\": [],\n  \"chunking_strategy\": {\n    \"type\": \"auto\"\n  },\n  \"auto_sync\": true,\n  \"sync_interval_minutes\": 5047,\n  \"vector_store_ids\": []\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "object": "vector_store.connector",
  "type": "s3",
  "name": "<string>",
  "location": {
    "bucket": "<string>",
    "region": "<string>",
    "prefix": "",
    "endpoint": "<string>"
  },
  "credentials_configured": true,
  "api_key_id": "<string>",
  "include_patterns": [
    "<string>"
  ],
  "exclude_patterns": [
    "<string>"
  ],
  "chunking_strategy": {
    "type": "auto"
  },
  "auto_sync": true,
  "sync_interval_minutes": 0,
  "next_sync_at": 0,
  "status": "idle",
  "last_error": "<string>",
  "last_run": {
    "id": "<string>",
    "object": "vector_store.connector.run",
    "status": "running",
    "trigger": "schedule",
    "started_at": 0,
    "finished_at": 0,
    "added": 0,
    "updated": 0,
    "removed": 0,
    "restored": 0,
    "skipped": 0,
    "failed": 0,
    "error": "<string>"
  },
  "vector_store_ids": [
    "<string>"
  ],
  "created_at": 0,
  "updated_at": 0
}

Overview

Responses and conversations

Models and routing

Images and audio

Files and retrieval

Agents

Tools and sandbox

Evals and feedback

Compute

Repositories

Dataset generations

Organizations and access

Usage and budgets

Application utilities

Analytics

Legacy APIs

Additional APIs

Create a vector store connector

Authorizations

Headers

Body

Response