Skip to main content

http

Call REST/HTTP APIs directly (no browser): read with get, change with post/put/patch/delete, or use the generic request when you need full control of method, headers, body and auth. download/upload move files.

Exact tools and parameters

catalog.describe_module http returns the real tools and every parameter, from the live registry. This page is the why and when; the catalog is the what.

Tools, at a glance: get, post, put, patch, delete, head, request, download, upload. The verb tools are convenience wrappers; request takes a method and does anything the verbs do.

When to use which​

  • A plain read or write to a known endpoint → the matching verb (get, post, …).
  • Unusual method, custom headers/auth, or streaming → request.
  • Fetching readable page content (search results, articles) → prefer web fetch, which returns clean text rather than raw bytes.

A working app​

Compiles as-is. The brain uses a Digitorn gateway model (the default - no API key of your own needed); see the note below to use your own key or a local model instead.

yaml
app:
  app_id: api_caller
  name: API Caller
runtime:
  entry_agent: main
agents:
  - id: main
    system_prompt: |
      Call REST APIs on the user's behalf: GET to read, POST/PUT/PATCH to
      change, download files when asked. Use request for anything unusual.
    brain:
      provider: openai
      backend: openai_compat
      model: mimo-v2.5-free   # a model the Digitorn gateway serves
      config:
        api_key: placeholder  # ignored in gateway mode
tools:
  modules:
    http: {}
  capabilities:
    grant:
      - module: http
        tools: [get, post, put, patch, delete, head, request, download, upload]
  • web - search + fetch readable content
  • browser - interactive browser control