Skip to content

Docs / All tools / Base tools

web.fill_form

Fill out a web form, show a preview, and submit it after confirmation.

40 credits. Per form sent. 0 when cancelled.

Example prompt

Send this to your AI app when Heelo is connected:

Fill out the contact form at https://example.com/contact with my details

Input fields

FieldTypeDescription
urlstringThe page containing the form to fill
dataobjectField hints, e.g. {'email': '[email protected]'}
instructionsstringFree-text guidance for filling the form
filesobjectField hint -> file to upload, given as an https URL (preferred; fetched securely) or a sandbox-relative path. E.g. {'resume': 'https://.../cv.pdf'}
auto_submitbooleanSubmit without the review-and-confirm gate
querystringNL-router free text (a URL is extracted from it)
end_user_idstring
session_idstring
messagestring

Output fields

The fields in data when status is success.

FieldType
submittedboolean
statusstring
summaryarray of object
messagestring

Code

The call with the input fields that the tool needs. Set HEELO_API_KEY to your API key.

import os
import requests

response = requests.post(
    "https://toolsprimitives.uk/v1/tools/web.fill_form/invoke",
    headers={"Authorization": f"Bearer {os.environ['HEELO_API_KEY']}"},
    json={"input": {
        "url": "https://example.com/contact",
    }},
    timeout=120,
)
response.raise_for_status()
print(response.json())