API Resources

What API resources are for

API resources make external data available as readable context. They are useful when an agent needs to fetch reference data from a business API without performing a write action.

Unlike tools, API resources are GET only. Use them for lookup and context retrieval. Use Tools for actions that create, update, or delete data.

Create an API resource

1. Open Configuration.
2. Select the API resources tab.
3. Click Create API resource.
4. Fill in Name, Description, URL Template, and Arguments Schema (JSON).
5. Set Cache TTL (seconds) if the response can be reused for a short time.
6. Select the right Shared with scopes.
7. Save the resource.

The resource appears in the list with method GET.

Authentication

API resources can use secrets from the Vault. Select vault secrets instead of writing sensitive values directly in the resource configuration.

When editing an existing resource, an existing secret can stay hidden. Select a new secret only when you want to replace it.

Use API resources in chat

When a resource is shared with the selected group or model, it can be used during chat. From Chat settings, use Exclude API resources to keep only the resources that should be available for the current conversation.

Cache TTL

Cache TTL (seconds) controls how long a successful GET response can be reused. Use 0 when the answer must always be fresh.

What to verify

• The active team is correct.
• The resource is shared with the right team, custom model, or group model.
• The JSON argument schema is valid.
• Required secrets exist in the vault.
• The target API can answer a GET request.
• A non-zero cache TTL is not hiding a recent change.