Test a source connection

client.promptly.sources.test(, ?): SourceTestResponse { message, success, tools }

POST/api/promptly/sources/{sourceId}/test

Verify the source connection is working properly

ParametersExpand Collapse

sourceID: string

formatuuid

ReturnsExpand Collapse

SourceTestResponse { message, success, tools }

message?: string

success?: boolean

tools?: Array<Tool { description, inputSchema, name } >

description?: string

inputSchema?: unknown

JSON Schema for tool parameters

name?: string

Test a source connection

import _0ct from '0ct';

const client = new _0ct({
  apiKey: process.env['0CT_API_KEY'], // This is the default and can be omitted
});

const response = await client.promptly.sources.test('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.message);

{
  "message": "message",
  "success": true,
  "tools": [
    {
      "description": "description",
      "inputSchema": {},
      "name": "name"
    }
  ]
}

Returns Examples

{
  "message": "message",
  "success": true,
  "tools": [
    {
      "description": "description",
      "inputSchema": {},
      "name": "name"
    }
  ]
}