> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Test new Weaviate configuration

POST https://api.runtype.com/v1/integrations/weaviate/test
Content-Type: application/json

Test the connection to a Weaviate instance before saving the configuration.

Reference: https://docs.runtype.com/api-reference/runtype-api/integrations/test-new-weaviate-configuration

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Body (application/json)

This endpoint expects an object.

- `apiKey` (string, required)
- `name` (string, required)
- `url` (string, required)
- `headers` (map from string to string, optional)
- `settings` (V1IntegrationsWeaviateTestPostRequestBodyContentApplicationJsonSchemaSettings, optional)

## Response

### 200

Connection test result

- `success` (boolean, required)
- `error` (string, optional)
- `schema` (V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchema, optional)

## Errors

### 400 Bad Request Error

Connection failure

- `success` (boolean, required)
- `error` (string, optional)
- `schema` (V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchema, optional)

### 401 Unauthorized Error

Unauthorized or auth failure

- `success` (boolean, required)
- `error` (string, optional)
- `schema` (V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchema, optional)

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `success` (boolean, required)
- `error` (string, optional)
- `schema` (V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchema, optional)

## Types

### V1IntegrationsWeaviateTestPostRequestBodyContentApplicationJsonSchemaSettings

- `defaultClass` (string, optional)
- `generativeModule` (string, optional)
- `vectorizer` (string, optional)

### V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchema

- `classes` (list of V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchemaClassesItems, required)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1IntegrationsWeaviateTestPostResponsesContentApplicationJsonSchemaSchemaClassesItems

- `properties` (double, required)
- `description` (string, optional)
- `name` (string, optional)
- `vectorizer` (string, optional)

## Examples

**Request**

```json
{
  "apiKey": "wv-your-api-key-here",
  "name": "Test Connection",
  "url": "https://my-cluster.weaviate.network"
}
```

**Response**

```json
{
  "success": true,
  "error": "string",
  "schema": {
    "classes": [
      {
        "properties": 1.1,
        "description": "string",
        "name": "string",
        "vectorizer": "string"
      }
    ]
  }
}
```

**SDK Code**

```python Test New Weaviate Connection
import requests

url = "https://api.runtype.com/v1/integrations/weaviate/test"

payload = {
    "apiKey": "wv-your-api-key-here",
    "name": "Test Connection",
    "url": "https://my-cluster.weaviate.network"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Test New Weaviate Connection
const url = 'https://api.runtype.com/v1/integrations/weaviate/test';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"apiKey":"wv-your-api-key-here","name":"Test Connection","url":"https://my-cluster.weaviate.network"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Test New Weaviate Connection
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/integrations/weaviate/test"

	payload := strings.NewReader("{\n  \"apiKey\": \"wv-your-api-key-here\",\n  \"name\": \"Test Connection\",\n  \"url\": \"https://my-cluster.weaviate.network\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Test New Weaviate Connection
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/integrations/weaviate/test")

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  \"apiKey\": \"wv-your-api-key-here\",\n  \"name\": \"Test Connection\",\n  \"url\": \"https://my-cluster.weaviate.network\"\n}"

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

```java Test New Weaviate Connection
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/integrations/weaviate/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"apiKey\": \"wv-your-api-key-here\",\n  \"name\": \"Test Connection\",\n  \"url\": \"https://my-cluster.weaviate.network\"\n}")
  .asString();
```

```php Test New Weaviate Connection
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/integrations/weaviate/test', [
  'body' => '{
  "apiKey": "wv-your-api-key-here",
  "name": "Test Connection",
  "url": "https://my-cluster.weaviate.network"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Test New Weaviate Connection
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/integrations/weaviate/test");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"apiKey\": \"wv-your-api-key-here\",\n  \"name\": \"Test Connection\",\n  \"url\": \"https://my-cluster.weaviate.network\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Test New Weaviate Connection
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "apiKey": "wv-your-api-key-here",
  "name": "Test Connection",
  "url": "https://my-cluster.weaviate.network"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/integrations/weaviate/test")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```