Read a Connector
GET /v1/connectors/{connector_id}
| Property | Value |
|---|---|
| Operation | get_connector |
| Group | Connectors |
| Scope | integrations:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A read of the platform catalog, which holds no Organization data. |
| Released in | 1.60.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Answers a Connector with its tools, Triggers, authentication, egress, compliance block and rate limits (1.60.0).
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/connectors/fhir_r4" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/connectors/fhir_r4`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/connectors/fhir_r4",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
connector_id | path | ConnectorId | yes | The id of a Connector (1.60.0): the snake_case slug of its manifest, 2 to 48 characters, platform-wide and stable across its versions. |
Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | Connector | |
400 | application/json | ErrorEnvelope | invalid_request |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
404 | application/json | ErrorEnvelope | not_found |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is Connector.
| Field | Type | Required | Description |
|---|---|---|---|
auth | array of ConnectorAuth | yes | |
category | ConnectorCategory | yes | |
compliance | ConnectorCompliance | yes | |
description | string | yes | |
egress | ConnectorEgress | yes | |
id | ConnectorId | yes | |
name | string | yes | |
object | "connector" | yes | |
rate_limits | ConnectorRateLimits | yes | |
sdk | string | yes | The @vocalai/connector-sdk versions the Connector is written for, a semver range. |
status | ConnectorStatus | yes | |
tools | array of ConnectorTool | yes | |
triggers | array of ConnectorTrigger | yes | |
version | string | yes | The manifest version (semver); a Connection pins its major version. |