---
title: "HTTP API tools"
description: "Connect a public HTTPS service and expose only approved actions to an agent."
url: "https://documentation.verbatik.com/integrations/http-api/"
---

# HTTP API tools

Connect a public HTTPS service and expose only approved actions to an agent.

Use an HTTP API connection for a service you operate or are authorized to access. A saved connection supplies endpoint and credentials; an agent tool supplies the allowed method, relative path and JSON parameter schema.

## Connect your API

1. Open **Integrations** and create a connection with provider **HTTP API**.
2. Enter a name and your service’s public HTTPS endpoint. Localhost, private-network hosts and embedded URL credentials are not supported.
3. Add an access token or **Secret headers as JSON** only if the service requires them. Credentials are encrypted for this workspace.
4. Enter a read-only test path such as `health`. This must be a relative path on the saved service, not a different URL.
5. Save and run **Test connection**. Use an endpoint that can be checked without creating records or sending messages.
6. Choose **Add tool to an agent**. Define the tool name, description, method, relative path and parameter schema, then publish the agent.

## Define an action carefully

Describe what a tool does, what identifiers it requires and which fields must be confirmed with the caller. Use a read action for lookups and a separate write action for changes. Never pass credentials as model-generated parameters.

Parameter schemas must be JSON Schema objects. Remote references, asynchronous schemas and regular-expression schemas are not supported. The saved schema and arguments have bounded sizes; keep schemas small and task-specific.

## Verify results

Return a clear success state and durable record ID for writes. A generic HTTP success with an application error should not be presented as a completed booking or CRM update. Use your service’s own idempotency and conflict controls for mutations; verify unknown outcomes before retrying.

Connecting a tool does not expose every endpoint on the service. Only the tools assigned to a published agent are available during its conversations.
