Cloudsway Search

POST/v1/api/cloudsway/search

Cloudsway SmartSearch is a web search API that returns ranked web results with optional full-text content and dynamic summaries.

Request body

Call this sync operation at its vendor-qualified URL. The model identity is encoded in the path; only operation-specific input fields belong in the request body.

stringqueryrequired

The search query string.

Length: 1 to unlimited

Optional<integer>max_results

Maximum number of results to return.

Range: 1 to 100

Default: 10

Optional<string>search_depth

basic: fast, low-latency search (~1s). advanced: multi-step reasoning with higher quality results (4-40s), costs more.

Allowed values: basic, advanced

Default: basic

Optional<string>topic

Content category to focus on.

Allowed values: general, news, academic, company, people, finance

Default: general

Optional<boolean>include_highlights

Return key excerpts relevant to the query.

Default: true

Optional<boolean>include_text

Return full page text content for each result.

Default: false

Optional<boolean>include_summary

Return a short summary of each result.

Default: false

Optional<integer>max_characters

Maximum characters for text content per result.

Range: 1 to 10000

Default: 3000

Optional<array<string>>include_domains

Only return results from these domains.

Optional<array<string>>exclude_domains

Exclude results from these domains.

Optional<string>start_date

Only return results published after this date. Format: YYYY-MM-DD.

Optional<string>end_date

Only return results published before this date. Format: YYYY-MM-DD.

Optional<string>country

Two-letter ISO country code for localized results.

Allowed values: US, GB, CN, JP, DE, FR, KR, IN, CA, AU, SG, BR, RU, IT, ES, NL, SE, CH, IL, AE

Response Schema

A synchronous completed response contains exactly one outputs item with only data. Failed and timeout responses contain error and never outputs.

stringidrequired

Opaque SandBase run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

stringmodelrequired

Public SandBase model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Contains exactly one item whose only field is data.

Optional<object | array>outputs[0].data

Operation-specific business payload. This reference uses an empty object when no safe example can be confirmed.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

API capabilities

array<string>capability_tagsrequired

Capabilities declared by the API registry.

Default: web-search

stringexecution_moderequired

Execution mode declared by the API registry.

Default: sync

pending response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"pending","model":"cloudsway/search"}

running response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"running","model":"cloudsway/search"}

completed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"completed","model":"cloudsway/search","outputs":[{"data":{"results":[{"title":"completed_data_results_0__title","url":"https://example.com/resource"}]}}]}

failed response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"failed","model":"cloudsway/search","error":{"type":"upstream_error","message":"upstream request failed"}}

timeout response

{"id":"f3d2e8a1-7c4b-4a12-9d2e-123456789abc","status":"timeout","model":"cloudsway/search","error":{"type":"upstream_error","message":"upstream request failed"}}

curl -X POST https://api.sandbase.ai/v1/api/cloudsway/search \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{\n
  "query": "OpenAI Codex documentation"
}'

Response200 OK

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "status": "completed",
  "model": "cloudsway/search",
  "outputs": [
    {
      "data": {
        "results": [
          {
            "title": "completed_data_results_0__title",
            "url": "https://example.com/resource"
          }
        ]
      }
    }
  ]
}