Skip to main content

Add an HTTP tool

An HTTP tool lets an agent call a REST endpoint you describe — a company lookup, an internal API, a partner service. You define the request and how to read the response, and the agent calls it when the conversation needs it.

Add an HTTP tool when the endpoint is a one-off. If the external system offers an MCP server, register it as an integration instead and let it advertise its own tools. Learn more: MCP integration. If the service publishes an OpenAPI schema, you can generate its tools from the schema. Read more >>>

Add the tool​

  1. Go to the Agents section in the navigation panel.

  2. Open the prompt agent you want to extend.

  3. Open the Tools tab on the Build tab group.

  4. Click Add HTTP tool. This opens the "Add HTTP tool" panel, which creates the integration and its first tool in one pass.

  5. Fill out the tool fields.

    Field

    Field value

    Tool name

    The name the agent calls. Use something the model can map to an intent, for example, "lookup_company_by_domain."

    Integration name

    Optional name for the integration this flow creates. The panel always creates a new integration rather than adding to an existing one. Leave it empty and Creatio AI Studio derives the name from the tool.

    Description

    What the tool does and when to call it. The agent reads this to decide whether the tool applies, so treat it as configuration rather than documentation. Must be 2,000 characters or fewer.

    Base URL

    The root address of the service, for example, https://api.yourcompany.com. Creatio AI Studio resolves the host in DNS before it saves, so a placeholder address is rejected with "baseUrl host could not be resolved." Enter the real service address.

    Authentication

    How the request authenticates against the service. Set to "None" out of the box.

    HTTP Path

    The path appended to the base URL, for example, /v1/companies.

    HTTP Method

    The verb the request uses. Set to "GET" out of the box.

    Risk Level

    What the tool can do: "Read," "Write," or "Admin." Set to "Read" out of the box. Set it to match what the endpoint does — tool confirmation policies gate on this value where they are enabled for your organization.

    Body Template

    The request body to send, with placeholders the agent fills from the conversation. Applies to methods that carry a body.

    Response Path

    Which part of the response to hand back to the agent. Use it to return the useful field instead of the whole payload.

    Input Schema

    The parameters the agent must supply, as a JSON schema. This is what tells the model which arguments the tool takes.

  6. Map the input fields onto the request in the Request Parameters section, if the endpoint needs them there. Click Add parameter binding for each one, and bind it to a path placeholder, a query string value, or a request header.

  7. Click Add tool.

As a result, Creatio AI Studio creates the integration and registers the tool under it. The tool does not appear on the Tools tab, and the HTTP counter there stays at zero: an HTTP tool lives on the Integrations tab from this point on.

Important

The integration that the panel creates is available only to you and to users with the Manage security permission until you grant access to others on the Access tab of the integration. Runs that start without a signed-in user, such as channel or triggered runs, cannot use a restricted integration through a grant. If the agent serves a channel, turn off Restrict access on the Access tab of the integration so that everyone in the organization can use it. Learn more: Integrations.

Enable the tool​

A registered tool does nothing until it is enabled for the agent, and a new one arrives disabled.

  1. Open the Integrations tab on the Build tab group.
  2. Find the integration the previous procedure created, named after the tool unless you named it yourself.
  3. Select the checkbox in the Enabled column next to the tool name.
  4. Reference the tool in the system prompt if the agent needs guidance on when to call it. A clear Description is often enough on its own.
  5. Click Publish to publish the agent.

As a result, the agent can call the endpoint. Test it in the Preview panel — the trace shows the tool call and the arguments the model supplied. If the agent never calls the tool, the usual cause is the Description or the Input Schema field rather than the endpoint: the model chooses a tool from its description, and can only call it when the schema tells it which arguments to supply.

Important

Set the Risk Level field to match what the endpoint actually does. A tool that writes records but is registered as "Read" bypasses the confirmation policies that would otherwise gate it. Tool confirmation policies are enabled per organization and appear only where they have been turned on. Learn more: Set up tool confirmation.

Import tools from an OpenAPI schema​

If the service publishes an OpenAPI schema, you can generate its HTTP tools from the schema instead of describing each endpoint by hand. Tools are imported into an existing HTTP API integration, for example, the one the Add HTTP tool panel created.

  1. Go to the Integrations section in the navigation panel.

  2. Open the HTTP API integration that should hold the tools.

  3. Go to the Tools tab and click Import OpenAPI. This opens the "Import OpenAPI Schema" dialog.

  4. Fill out the import fields.

    Field

    Field value

    Schema Source

    Where the schema comes from: "URL" or "Raw Schema." Set to "URL" out of the box.

    Schema URL

    The address of the schema, for example, https://example.com/openapi.json. Shown when Schema Source is "URL."

    Schema Content

    The schema document pasted as text. Shown when Schema Source is "Raw Schema."

    Base URL Override

    The service address the tools call instead of the address the schema declares, for example, https://api.example.com. Required when the schema declares no server address.

  5. Click Import.

As a result, Creatio AI Studio generates the HTTP tools of the integration from the schema and reports how many tools it created, updated, and skipped. The imported tools carry the "OpenAPI" badge on the Tools tab of the integration. When an agent calls one of them, it sends the query and path parameters that the schema declares. When the service returns an error without a response body, the agent receives the HTTP status as an error it can report.

Enable the imported tools for the agent the same way as a tool you add by hand. Read more >>>

See also​

Tools in Creatio AI Studio

MCP integration

Create a prompt agent