External

Open in CMS

The External knowledge screen lists the other knowledge bases this agent searches during a conversation, next to its own documents. Found in the agent sidebar under Knowledge β†’ External. For how it works and when to use it, see External Knowledge.

Provider list

Add providerOpens the type picker. Turned off when the agent already has 5 providers.
ProviderThe provider's name, with its What information to look up here under it. Click a row to open it.
SourceThe other agent's name (Agent Search API) or the endpoint's host (REST API).
ResultsHow many results are asked for in each search.
StatusActive; Off (switched off here); Search API off (the other agent's Search API is off or it became personal); Key revoked (the other agent revoked this provider's key); Agent deleted.
OnSwitches the provider on or off at once.
Row menuEdit, Test (opens the provider at its test), Make a new key (only when the key was revoked), Remove (asks first; an agent provider's key is revoked on the other agent).

With no providers, an empty state explains the feature and offers Add provider.

Type picker

Card
Another agent's Search APISearch another agent you manage. Endpoint and key are filled in. 1 credit per search, charged to that agent's organization.
REST APIAny search service with the Search API contract. You enter the endpoint and key.
Knowledge gatewayMarked Coming soon; cannot be picked.

Provider form

Source (Another agent's Search API)

AgentAgents you manage whose Search API is on, with their organization. Cannot be changed after the provider is added: remove it and add a new one.
EndpointThe agent's Knowledge Search API address, with a copy button. Filled in for you.
API key"Made automatically when you add the provider", then its last four characters. It is listed on the other agent's Search API page under Used by other agents.
Enforced codes noticeShown when the other agent adds permission codes to every search anyway.

Source (REST API)

EndpointRequired. An https:// URL reachable on the internet.
API keyRequired when adding. Stored encrypted and never shown again; when editing, leave it empty to keep the saved key.
Send the key asX-Api-Key header or Authorization: Bearer.

What the agent uses it for

NameRequired, up to 60 characters. Shown in citations.
What information to look up hereRequired, 10 to 500 characters. The agent reads it to decide when to search this provider.
Use this provider in conversationsSwitch it off to stop using the provider without removing it.
PermissionsAgent provider: codes picked from the other agent's permission list. REST provider: type a code and press Enter. Sent with every search.
Search results1 to 20, default 5. When this agent's reranker is on, results are reranked and cut to its number of search results.

Test

Test questionThe question to search for.
Run testRuns one search with the form's values and lists the results (title, section, text, distance) in the provider's order, without reranking. A failure says why. An agent provider can be tested once it is added; a REST provider also before.

The form asks before closing with unsaved changes. After you add a provider, it stays open on the new provider so you can test it.

  • Channels β†’ Search API β†’ Used by other agents on the other agent: the keys made for providers, with Revoke. See Search API screen.
  • Knowledge β†’ Retrieval: the reranker that also applies to provider results.