Skip to content
← Back to documentation
Technical Reference

Bocha

Web search API for AI agents, providing real-time web pages, images, and news.

CategoryArtificial Intelligence
Authenticationcustom
Version0.1.0
Published scopes0 published scopes
Last updatedSeptember 19, 2026

Overview

Bocha

This CDK catalogue package is pinned to @activepieces/piece-bocha-search@0.1.0 and declares 2 declared actions and no declared triggers. Its definition is derived from the exact reviewed Activepieces source.

Provider runtime verification is recorded separately when an approved test connection is exercised; this catalogue entry does not claim that verification.

Technical guide

Technical reference

  • Package: @activepieces/piece-bocha-search@0.1.0
  • Exact artifact digest: sha256:f0c0c7bebb8681f41e2f0dcd108ee8d995dae6aba997d0ceeb39c910176909ba
  • Source: the exact reviewed Activepieces source
  • Authentication, action and trigger schemas are taken from the exact pinned package.

Capability summary

Authenticationcustom
Supported objects2
Supported actions2
TriggersNone published

Authentication

Authentication method: custom

Authentication profiles

connection · custom
  • API Key Required · protected credential

Supported objects

ObjectReadWriteNotes
Web Search Yes No
Custom API Call Yes No

Supported actions

Web Search · Read

Search the web using Bocha.

web_search · Risk: low · Retry: safe

Inputs

  • query · string · Required, The search query.
  • freshness · string · Optional, Filter results by time range. Defaults to no limit.
  • summary · boolean · Optional, Include a text summary for each search result.
  • include · string · Optional, Limit search to specific domains. Separate multiple domains with | or , (max 100).
  • exclude · string · Optional, Exclude specific domains from search results. Separate multiple domains with | or , (max 100).
  • count · number · Optional, Number of results to return (1-50). Defaults to 10.
Custom API Call · Read

Make a custom API call to a specific endpoint

custom_api_call · Risk: low · Retry: safe

Inputs

  • url · object · Required
  • method · string · Required
  • headers · object · Optional, Authorization headers are injected automatically from your connection.
  • queryParams · object · Optional, Appended to the URL as ?key=value.
  • body_type · string · Optional
  • body · object · Optional
  • response_is_binary · boolean · Optional, Enable for files like PDFs, images, etc.
  • failsafe · boolean · Optional, On a failed request, output the error instead of failing the step.
  • timeout · number · Optional, Seconds to wait for a response. Empty: up to the flow limit (10 min).
  • followRedirects · boolean · Optional, Follow 3xx redirects instead of returning them as the response.

Setup

Setup

Create a tenant connection only in the consuming Studio instance when this connector is made available there. Credentials remain in that tenant's Vault-backed connection and are not stored in CDK package metadata.

Limitations

The package has passed deterministic offline package-load and contract validation. No provider credentials, provider API call or live webhook delivery is represented by this release state.