Capability

Custom API Connector (template)

A starting point for connecting any API that uses an API key: stores the key, registers the API and adds a skill that fetches records and proposes them as entities. Set the base URL, key and target entity type when you install.

What your agent can do with it

  • generic_apiAuthenticated HTTP access to the provider API.
  • {{name}} fetch-and-proposeFetches records from the provider API and proposes each as an entity (proposal-gated). Calls the required tool by name via callProvider('generic_api', ...).

What you will need

Asked for at install. Stored in your pod, never on our servers.

  • API keyThe bearer API key for the provider. Stored server-encrypted in the vault; never persisted in the template.
  • Base URLThe provider's API base URL, e.g. https://api.example.com/v1
  • Target entity profileOptionalThe profileSlug the skill proposes fetched records as.
  • {{name}} API keySecretAPI key for the generic-apikey connector.