Get a Connector

GET 
/api/v1/connectors/:id

Get a Connector

Request

Path Parameters

id stringrequired

Responses

200

OK

application/json

Schema

Schema

anthropic

object

apiKey string

authToken string

baseURL string

aws

object

accessKeyID string

region string

secretAccessKey string

sessionToken string

azure

object

azureAuthorityHost string

azureClientID string

azureClientSecret string

azureTenantID string

azureopenai

object

apiKey string

apiVersion string

azureAdToken string

azureDeployment string

azureEndpoint string

organization string

project string

bedrock

object

accessKeyID string

region string

secretAccessKey string

sessionToken string

bigquery

object

serviceAccountJSON string
category string

chroma

object

database string

host string

port integer

tenant string
cluster string

cohere

object

apiKey string

baseURL string

environment string
createdAt date-time

custom

object

properties

object

property name* string

secretProperties string[]
error string

gcp

object

serviceAccountJSON string

groq

object

apiKey string

baseURL string
id string

mongodb

object

password string

uri string

user string

mysql

object

database string

host string

password string

port integer

user string
name string

ollama

object

host string

openai

object

apiKey string

baseURL string

pinecone

object

apiKey string

host string

postgres

object

database string

hostname string

password string

port string

username string

s3

object

accessKeyID string

region string

secretAccessKey string

sessionToken string

sagemaker

object

accessKeyID string

region string

secretAccessKey string

sessionToken string

snowflake

object

account string

database string

password string

schema string

user string

warehouse string
type string
updatedAt date-time

vertex

object

serviceAccountJSON string

weaviate

object

accessToken string

apiKey string

clientSecret string

grpcHost string

grpcPort integer

grpcSecure boolean

httpHost string

httpPort integer

httpSecure boolean

password string

username string

Example (from schema)

{
  "anthropic": {
    "apiKey": "string",
    "authToken": "string",
    "baseURL": "string"
  },
  "aws": {
    "accessKeyID": "string",
    "region": "string",
    "secretAccessKey": "string",
    "sessionToken": "string"
  },
  "azure": {
    "azureAuthorityHost": "string",
    "azureClientID": "string",
    "azureClientSecret": "string",
    "azureTenantID": "string"
  },
  "azureopenai": {
    "apiKey": "string",
    "apiVersion": "string",
    "azureAdToken": "string",
    "azureDeployment": "string",
    "azureEndpoint": "string",
    "organization": "string",
    "project": "string"
  },
  "bedrock": {
    "accessKeyID": "string",
    "region": "string",
    "secretAccessKey": "string",
    "sessionToken": "string"
  },
  "bigquery": {
    "serviceAccountJSON": "string"
  },
  "category": "string",
  "chroma": {
    "database": "string",
    "host": "string",
    "port": 0,
    "tenant": "string"
  },
  "cluster": "string",
  "cohere": {
    "apiKey": "string",
    "baseURL": "string",
    "environment": "string"
  },
  "createdAt": "2024-07-29T15:51:28.071Z",
  "custom": {
    "properties": {},
    "secretProperties": [
      "string"
    ]
  },
  "error": "string",
  "gcp": {
    "serviceAccountJSON": "string"
  },
  "groq": {
    "apiKey": "string",
    "baseURL": "string"
  },
  "id": "string",
  "mongodb": {
    "password": "string",
    "uri": "string",
    "user": "string"
  },
  "mysql": {
    "database": "string",
    "host": "string",
    "password": "string",
    "port": 0,
    "user": "string"
  },
  "name": "string",
  "ollama": {
    "host": "string"
  },
  "openai": {
    "apiKey": "string",
    "baseURL": "string"
  },
  "pinecone": {
    "apiKey": "string",
    "host": "string"
  },
  "postgres": {
    "database": "string",
    "hostname": "string",
    "password": "string",
    "port": "string",
    "username": "string"
  },
  "s3": {
    "accessKeyID": "string",
    "region": "string",
    "secretAccessKey": "string",
    "sessionToken": "string"
  },
  "sagemaker": {
    "accessKeyID": "string",
    "region": "string",
    "secretAccessKey": "string",
    "sessionToken": "string"
  },
  "snowflake": {
    "account": "string",
    "database": "string",
    "password": "string",
    "schema": "string",
    "user": "string",
    "warehouse": "string"
  },
  "type": "string",
  "updatedAt": "2024-07-29T15:51:28.071Z",
  "vertex": {
    "serviceAccountJSON": "string"
  },
  "weaviate": {
    "accessToken": "string",
    "apiKey": "string",
    "clientSecret": "string",
    "grpcHost": "string",
    "grpcPort": 0,
    "grpcSecure": true,
    "httpHost": "string",
    "httpPort": 0,
    "httpSecure": true,
    "password": "string",
    "username": "string"
  }
}

400

Bad Request

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

404

Not Found

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...