For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
User GuideDeveloper GuidesAPI Reference
User GuideDeveloper GuidesAPI Reference
    • Overview
  • Runtype API
      • GETList integrations
      • POSTReserve a new integration
      • GETList integrations by category
      • GETGet integration credential status
      • POSTInstall Slack integration
      • POSTRotate Slack credentials
      • POSTInstall Telegram integration
      • GETCheck managed Telegram bot availability
      • POSTInitiate managed Telegram bot creation
      • POSTRotate managed Telegram bot token
      • DELCancel managed Telegram bot request
      • POSTConfirm managed Telegram bot rename
      • POSTReject managed Telegram bot rename
      • GETGet managed Telegram bot request status
      • GETList configured integration tools
      • GETList Vectorize configurations
      • POSTCreate Vectorize configuration
      • POSTCreate Vectorize index
      • POSTList Vectorize indexes
      • POSTTest new Vectorize configuration
      • GETGet Vectorize configuration
      • PUTUpdate Vectorize configuration
      • DELDelete Vectorize configuration
      • POSTTest saved Vectorize configuration
      • GETList Weaviate configurations
      • POSTCreate Weaviate configuration
      • POSTTest new Weaviate configuration
      • GETGet Weaviate configuration
      • PUTUpdate Weaviate configuration
      • DELDelete Weaviate configuration
      • POSTList Weaviate collections
      • POSTTest Weaviate connection
      • GETGet integration details
      • POSTSave integration credentials
      • DELDelete integration credentials
      • GETList tools for an integration
      • GETGet an integration tool
Dashboard
LogoLogo
Runtype APIIntegrations

Test new Vectorize configuration

POST
/v1/integrations/vectorize/test
POST
/v1/integrations/vectorize/test
$curl -X POST https://api.runtype.com/v1/integrations/vectorize/test \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "accountId": "abcdef1234567890abcdef1234567890",
>  "apiToken": "cf-api-token-here",
>  "indexName": "my-embeddings",
>  "name": "Test Connection"
>}'
1{
2  "success": true,
3  "error": "string",
4  "indexInfo": {
5    "dimensions": 1.1,
6    "metric": "string",
7    "name": "string",
8    "vectorCount": 1.1
9  }
10}
Test the connection to a Cloudflare Vectorize configuration before saving it.
Was this page helpful?
Previous

Get Vectorize configuration

Next
Built with

Authentication

AuthorizationBearer
API key or Clerk session token

Request

This endpoint expects an object.
accountIdstringRequired>=10 characters
apiTokenstringRequired>=1 character
indexNamestringRequired>=1 character
namestringRequired1-100 characters
timeoutdoubleOptional1000-120000

Response

Connection test result
successboolean
errorstring
indexInfoobject or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error