Skip to main content
Octen logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: OCTEN
  • Version: 00000000_00

Tools

Slug: OCTEN_BROAD_SEARCHDecompose one question into up to 30 sub-queries and search Octen’s live web index concurrently. Returns each non-deduplicated result group and the native usage envelope. Cost fans out: one invocation may bill multiple search calls plus full-content overage. This action makes one request and does not automatically retry ambiguous failures.

Input Parameters

string
required
Question Octen should decompose into multiple web-search queries.
integer
Maximum generated sub-queries (1-30). Each generated query can become a separately metered search call, so larger values multiply cost.
object
Complete Web Search options applied independently to every generated sub-query. Counts and full-content charges fan out across all groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_CREATE_MULTIMODAL_EMBEDDINGSCreate independent or fused embeddings from up to 20 text, image, and URL-video elements. This is one metered, non-idempotent computation: standard-model text and media cost $0.05/$0.12 per 1M tokens, while large-model text and media cost $0.10/$0.25 per 1M tokens. The instruction is billed as text. The action sends one request and does not retry ambiguous failures.

Input Parameters

number
Video sampling rate greater than 0 and at most 1 frame per second; Octen caps sampling at 64 frames.
object
required
Bounded text, image, and video content to embed.
string ("octen-vl-embedding" | "octen-vl-embedding-large")
required
Embedding model. octen-vl-embedding supports up to 2,048 dimensions and costs $0.05 per 1M text tokens and $0.12 per 1M image/video tokens; octen-vl-embedding-large supports up to 4,096 dimensions and costs $0.10 and $0.25 per 1M tokens respectively.
string
Embedding instruction, billed as text tokens. Its characters and all text content together must not exceed 10,000.
integer
Output dimensions. Omit for the model maximum; standard supports at most 2,048 and large supports at most 4,096.
boolean
Return one fused vector for all elements when true; otherwise return one vector per content element.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_CREATE_TEXT_EMBEDDINGSCreate indexed text embeddings for up to 1,000 inputs with Octen in one metered request. Billing per 1 million input tokens is $0.01 for 0.6b, $0.04 for 4b, or $0.07 for 8b; query mode also bills its prepended retrieval instruction. Replaying an ambiguous request can incur the token charge again, so do not retry it automatically.

Input Parameters

array
required
Texts to embed (at most 1,000; each at most 10,000 characters). The complete serialized request body must not exceed 2 MB. Input order maps to each returned result index.
string ("octen-embedding-0.6b" | "octen-embedding-4b" | "octen-embedding-8b")
Embedding model. Per 1 million input tokens, Octen documents prices of $0.01 for 0.6b, $0.04 for 4b, and $0.07 for 8b. Maximum dimensions are 1,024, 2,560, and 4,096 respectively.
integer
Output dimensions. Omit for the selected model’s maximum; cannot exceed 1,024 for 0.6b, 2,560 for 4b, or 4,096 for 8b.
string ("query" | "document")
Use query for retrieval queries or document for corpus text. Query mode prepends a retrieval instruction that Octen includes in input_tokens; null or omission adds no special prompt.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_EXTRACT_URL_CONTENTExtract content and optional media or links from up to 20 URLs in one metered request. Every URL’s success or failed status is returned; only successful URLs are billed by resolved mode. Do not retry an ambiguous whole batch, because successful URLs may be billed again; inspect item errors and retry only known failed URLs when safe.

Input Parameters

string ("standard" | "advanced" | "auto")
Extraction mode. Advanced costs more; auto may resolve and bill each successful URL as standard or advanced.
array
required
URLs to extract in one batch (at most 20, each at most 2,048 characters).
string
Relevance query. When supplied, Octen returns highlights instead of full_content.
string ("markdown" | "text")
Output format for extracted content or highlights.
integer
Per-URL extraction timeout in seconds (1-60), distinct from the action’s network timeout.
boolean
Include extracted audio metadata when available.
Controls extracted links and their per-item limit.
boolean
Include extracted image metadata when available.
boolean
Include extracted video metadata when available.
integer
Maximum acceptable cached-content age in seconds (300-31,536,000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_SEARCH_BUSINESSESSearch Octen’s web index once for business pages and optional company or person cards. Domain, time, and language filters affect ranked results only. Calls cost $5 per 1,000; full content after the first 10 results costs $0.50 per 1,000 results. This action does not automatically retry ambiguous failures.

Input Parameters

integer
Maximum ranked results returned (1-100).
string
required
Business search query; supports site:<domain> and -site:<domain> operators for ranked results.
string
ISO 8601 end time for ranked results only; overrides time_range.
object
Company and person entity-card settings.
array
ISO 639-1 languages used to restrict ranked results only; entity cards are not language-filtered.
object
Highlight extraction settings for ranked results.
string
ISO 8601 start time for ranked results only; overrides time_range.
string ("auto" | "published" | "crawled")
Timestamp used to time-filter ranked results only.
string ("day" | "week" | "month" | "year" | "d" | "w" | "m" | "y")
Relative window for ranked results only. Explicit start_time or end_time takes precedence.
object
Full-page content settings for ranked results. Content beyond the first 10 results costs $0.50 per 1,000 results.
array
Domains to exclude from ranked results only. Exclusions take precedence; entity cards are not domain-filtered.
array
Domains to include in ranked results only; entity cards are not domain-filtered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_SEARCH_IMAGESSearch Octen’s web image index from exactly one text query or reference image. This paid action costs $2 per 1,000 image-search calls. It sends one billable request with no automatic retries; do not replay an ambiguous failure because the search may be charged again.

Input Parameters

integer
Number of image results to return (1-10).
array
required
Exactly one text query or one URL/base64 image input.
string ("off" | "strict")
Explicit-content filtering: strict removes adult content; off disables filtering.
array
Domains to exclude, matched against each result’s source_page URL.
array
Domains to include, matched against each result’s source_page URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_SEARCH_NEWSSearch live news once for ranked articles and optional event subjects. News Search costs $3 per 1,000 calls; full content beyond the first 10 results per search costs $0.50 per 1,000 results. The native usage envelope reports text and subject search counts. This metered action makes one request and does not automatically retry ambiguous failures.

Input Parameters

integer
Maximum flat news results returned (1-100); does not limit subjects.
string
required
News search query. Supports site:<domain> and -site:<domain> operators; those domain filters affect results only, not subjects.
string
ISO 8601 upper time bound for articles and subjects; explicit bounds take precedence over time_range.
array
ISO 639-1 language codes restricting both results and subjects.
object
Subject grouping settings. Omission uses Octen’s defaults: enabled, up to 2 subjects, and up to 5 sub-events per subject.
object
Highlight settings; when omitted, highlighting defaults on at 512 tokens.
string
ISO 8601 lower time bound for articles and subjects; explicit bounds take precedence over time_range.
string ("auto" | "published" | "crawled")
Timestamp used to filter articles and subjects. Published uses time_published; crawled uses time_last_crawled.
string ("day" | "week" | "month" | "year" | "d" | "w" | "m" | "y")
Relative window for articles and subjects. Explicit start_time or end_time takes precedence when supplied.
object
Full-content settings; omitted defaults off. When enabled, content after the first 10 results per search costs $0.50 per 1,000 results.
array
Domains to exclude from flat results only (at most 1,200). Exclusions take precedence over inclusions and do not affect subjects.
array
Domains to include in flat results only (at most 1,200); subject grouping does not support domain filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_SEARCH_VIDEOSINVITE-ONLY BETA: search the web for videos only after confirming the Octen account has Video Search entitlement. Each call costs $5 per 1,000 calls. The action sends one metered request and does not retry automatically after an ambiguous response.

Input Parameters

integer
Number of video results to return (1-10). Invite-only beta: an entitled Octen account is required. Video Search costs $5 per 1,000 calls, and this action does not retry automatically.
array
required
Required array containing at most one text input. Invite-only beta: an entitled Octen account is required. Video Search costs $5 per 1,000 calls, and this action does not retry automatically.
string
ISO 8601 publish-time upper bound; takes precedence over time_range. Invite-only beta: an entitled Octen account is required. Video Search costs $5 per 1,000 calls, and this action does not retry automatically.
string ("off" | "strict")
Explicit-content filtering: strict drops all adult content; off disables filtering. Invite-only beta: an entitled Octen account is required. Video Search costs $5 per 1,000 calls, and this action does not retry automatically.
string
ISO 8601 publish-time lower bound; takes precedence over time_range. Invite-only beta: an entitled Octen account is required. Video Search costs $5 per 1,000 calls, and this action does not retry automatically.
string ("day" | "week" | "month" | "year" | "d" | "w" | "m" | "y")
Relative publish-time window. start_time or end_time takes precedence when supplied. Invite-only beta: an entitled Octen account is required. Video Search costs $5 per 1,000 calls, and this action does not retry automatically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OCTEN_SEARCH_WEBSearch Octen’s live web index once for ranked pages, with bounded filters, highlights, optional full content, and usage metadata. This metered call has no pagination; do not retry automatically after an ambiguous response.

Input Parameters

integer
Maximum results returned for each search query (1-100).
string
required
Search query for Octen’s live web index; supports site:<domain> and -site:<domain> operators.
string ("markdown" | "text")
Formatting used for returned highlights.
string
Inclusive ISO 8601 upper bound; takes precedence over time_range.
array
ISO 639-1 language codes used to restrict results.
object
Highlight extraction settings.
string ("off" | "strict")
Safe-search filtering mode.
string
Inclusive ISO 8601 lower bound; takes precedence over time_range.
string ("auto" | "published" | "crawled")
Timestamp Octen uses for time filtering.
string ("day" | "week" | "month" | "year" | "d" | "w" | "m" | "y")
Relative time window. Explicit time bounds take precedence.
array
Strings that must not appear in result page text (at most 5).
object
Optional full-page content settings.
array
Strings that must appear in result page text (at most 5).
boolean
Include available image metadata in each result.
array
Domains to exclude. Exclusions take precedence over inclusions.
array
Domains to include. Exclusions take precedence over inclusions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not