API reference · Cloudsway

cloudsway/search

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDcloudsway/search

Input Schema

13 parameters · 1 required · 12 optional

Parameter	Type	Required	Description
`query`	string	Required	The search query string. · Min length: 1
`topic`	string	Optional	Content category to focus on. · Options: general, news, academic, company, people, finance · Default: "general" generalnewsacademiccompanypeoplefinance
`country`	string	Optional	Two-letter ISO country code for localized results. · Options: US, GB, CN, JP, DE, FR, KR, IN, CA, AU, SG, BR, RU, IT, ES, NL, SE, CH, IL, AE USGBCNJPDEFRKRINCAAUSGBRRUITESNLSECHILAE
`end_date`	string	Optional	Only return results published before this date. Format: YYYY-MM-DD.
`start_date`	string	Optional	Only return results published after this date. Format: YYYY-MM-DD.
`max_results`	integer	Optional	Maximum number of results to return. · Min: 1 · Max: 100 · Default: 10
`include_text`	boolean	Optional	Return full page text content for each result. · Default: false
`search_depth`	string	Optional	basic: fast, low-latency search (~1s). advanced: multi-step reasoning with higher quality results (4-40s), costs more. · Options: basic, advanced · Default: "basic" basicadvanced
`max_characters`	integer	Optional	Maximum characters for text content per result. · Min: 1 · Max: 10000 · Default: 3000
`exclude_domains`	string[]	Optional	Exclude results from these domains.
`include_domains`	string[]	Optional	Only return results from these domains.
`include_summary`	boolean	Optional	Return a short summary of each result. · Default: false
`include_highlights`	boolean	Optional	Return key excerpts relevant to the query. · Default: true

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Code Examples

Ready-to-run snippets

curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "cloudsway/search",
  "query": "latest developments in large language models",
  "topic": "general",
  "max_results": 10,
  "include_text": false,
  "search_depth": "basic",
  "max_characters": 3000,
  "include_summary": false,
  "include_highlights": true,
  "prompt": "a beautiful sunset over mountains"
}'

← Back to Cloudsway Search