Apideck Connector API

Name: Connector API
Brand: Connector API
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsMonitoring ObservabilityapiKey10 EndpointsREST

Install Jentic One Beta

Connect the Connector API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Connector API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Connector API.

List the connectors Apideck Unify supports along with logo, status, and supported unified APIs

Read the unified APIs (CRM, ATS, Accounting, etc.) and which connectors expose each one

Inspect the resource list for a connector or unified API to see what is supported

GET STARTED

Start building with Connector API

Explore with Jentic

View OpenAPI Document

For Agents

Inspect Apideck Unify's connector catalogue: list connectors, see which unified APIs each implements, read documentation, and fetch the schema for any resource.

Use for: List all connectors Apideck supports, Find connectors that implement the CRM unified API, Get the resource schema for the contact object on the HubSpot connector, Read the documentation for the Salesforce connector

Not supported: Does not perform business operations on connected systems - use for inspecting the Apideck Unify connector catalogue, schemas, and coverage only.

Use Cases

Patterns agents use Connector API for, with concrete tasks.

★ In-App Integration Catalogue

Render a live integration catalogue inside an application without hard-coding the connector list. /connector/connectors returns logos, names, statuses, and supported unified APIs, so the in-app picker shows whatever Apideck currently supports, including new connectors added since the build. Common pattern for SaaS apps that want to advertise depth of integration without a content-update release for each new connector.

GET /connector/connectors and render each connector with logo, name, and the unified APIs it implements

Pre-Auth Coverage Check

Before prompting a customer to authorise a connector, check whether the connector implements the resources you actually need. /connector/apis/{id}/resources/{resource_id}/coverage returns the connector list that supports a resource, so an app can warn the customer that, for example, NetSuite supports Invoices but not Aged Debtors before they grant access.

GET /connector/apis/accounting/resources/aged-debtors/coverage to see which accounting connectors support the Aged Debtors report

Runtime Schema Inspection

Before serializing a request body, fetch the live schema for the resource and connector pair. /connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema returns the JSON schema, and /example returns a sample payload so a code generator or LLM tool can validate input shape against the actual connector definition rather than a stale local copy.

GET /connector/connectors/hubspot/resources/contact/unified_api/crm/schema to fetch the live HubSpot contact schema

AI Agent Capability Discovery

Give an AI agent a tool to ask 'which connectors can do X?' before it picks a unified API. Through Jentic, the agent searches for an intent like 'list crm connectors' and gets the matching Connector API operation. The agent uses the response to recommend the right connector to the user before authorisation.

Search Jentic for 'list connectors that support crm', load the /connector/apis/{id} schema with id=crm, and execute to return the supporting connector list

Key Endpoints

10 endpoints — the apideck connector api is the meta-api that describes the integrations apideck unify supports.

METHOD

PATH

DESCRIPTION

GET

/connector/connectors

List all connectors Apideck supports

GET

/connector/connectors/{id}

Read a single connector by id

GET

/connector/connectors/{id}/docs/{doc_id}

Read the documentation page for a connector

GET

/connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema

Fetch the JSON schema for a resource on a connector

GET

/connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/example

Fetch an example payload for a resource on a connector

GET

/connector/apis

List Apideck unified APIs

GET

/connector/apis/{id}/resources/{resource_id}/coverage

Show connector coverage for a resource of a unified API

GET

/connector/connectors

List all connectors Apideck supports

GET

/connector/connectors/{id}

Read a single connector by id

GET

/connector/connectors/{id}/docs/{doc_id}

Read the documentation page for a connector

GET

/connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema

Fetch the JSON schema for a resource on a connector

GET

/connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/example

Fetch an example payload for a resource on a connector

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Your Apideck API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'inspect a connector's schema' or 'check API coverage for a resource', and Jentic returns the matching Apideck Connector operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Connector API through Jentic.

What authentication does the Apideck Connector API use?

Apideck requires Authorization with a bearer API key and x-apideck-app-id with your Unify application id. The x-apideck-consumer-id header is required by most Apideck calls but is not needed for the Connector meta-API since it describes integrations, not customer data. Through Jentic all values are stored encrypted in the vault and injected at execution time.

Which integrations are listed by the Apideck Connector API?

Every connector that Apideck Unify supports across CRM, ATS, Accounting, HRIS, Customer Support, Ecommerce, File Storage, Issue Tracking, Lead, POS, SMS, and Webhook unified APIs. GET /connector/connectors returns the live list with logo URL, status (live, beta, deprecated), and the unified APIs each connector implements.

Can I fetch the schema for a connector resource at runtime?

Yes. GET /connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema returns the JSON schema for that resource on that connector. Pair it with the matching /example endpoint to get a sample payload for validation or LLM prompt context.

What are the rate limits for the Apideck Connector API?

The Connector meta-API enforces standard Apideck Unify rate limits and returns HTTP 429 on throttling. The endpoints are read-only and cacheable, so most apps cache responses for an hour to reduce request volume.

How do I check connector coverage through Jentic?

Search Jentic for 'check apideck connector coverage', load the /connector/apis/{id}/resources/{resource_id}/coverage schema, and execute with the unified API id (crm, ats, accounting, etc.) and the resource id to see the supporting connector list.

Is the Apideck Connector API free?

The Connector meta-API is included with any Apideck Unify plan, including the free tier. See https://www.apideck.com/pricing for the current tiers and per-consumer pricing for the data-plane unified APIs.

Can I limit what my agent is allowed to do with the Apideck Connector API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. Since this API carries the connector id in the URL path (/connector/connectors/{id}/...), you can pin the agent to a single connector so it only reads that connector's docs and schemas and nothing else. The Connector API is inspection-only, so even with every operation allowed it never runs a business operation against your connected systems.