---
canonical_url: "https://docs.composio.dev/toolkits/octen"
markdown_url: "https://docs.composio.dev/toolkits/octen.md"
product: "platform"
version: null
last_updated: null
---

# Octen

Search Octen's real-time web index, extract web content, and create text or multimodal embeddings.

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 9
- **Triggers:** 0
- **Slug:** `OCTEN`
- **Version:** 00000000_00

## Tools

### Broad Search

**Slug:** `OCTEN_BROAD_SEARCH`

Decompose 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Multimodal Embeddings

**Slug:** `OCTEN_CREATE_MULTIMODAL_EMBEDDINGS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fps` | number | No | Video sampling rate greater than 0 and at most 1 frame per second; Octen caps sampling at 64 frames. |
| `input` | object | Yes | Bounded text, image, and video content to embed. |
| `model` | string ("octen-vl-embedding" | "octen-vl-embedding-large") | Yes | 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. |
| `instruct` | string | No | Embedding instruction, billed as text tokens. Its characters and all text content together must not exceed 10,000. |
| `dimension` | integer | No | Output dimensions. Omit for the model maximum; standard supports at most 2,048 and large supports at most 4,096. |
| `enable_fusion` | boolean | No | Return one fused vector for all elements when true; otherwise return one vector per content element. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Text Embeddings

**Slug:** `OCTEN_CREATE_TEXT_EMBEDDINGS`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `input` | array | Yes | 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. |
| `model` | string ("octen-embedding-0.6b" | "octen-embedding-4b" | "octen-embedding-8b") | No | 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. |
| `dimension` | integer | No | 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. |
| `input_type` | string ("query" | "document") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract URL Content

**Slug:** `OCTEN_EXTRACT_URL_CONTENT`

Extract 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Businesses

**Slug:** `OCTEN_SEARCH_BUSINESSES`

Search 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Images

**Slug:** `OCTEN_SEARCH_IMAGES`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of image results to return (1-10). |
| `inputs` | array | Yes | Exactly one text query or one URL/base64 image input. |
| `safesearch` | string ("off" | "strict") | No | Explicit-content filtering: strict removes adult content; off disables filtering. |
| `exclude_domains` | array | No | Domains to exclude, matched against each result's source_page URL. |
| `include_domains` | array | No | Domains to include, matched against each result's source_page URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search News

**Slug:** `OCTEN_SEARCH_NEWS`

Search 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Videos

**Slug:** `OCTEN_SEARCH_VIDEOS`

INVITE-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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | 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. |
| `inputs` | array | Yes | 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. |
| `end_time` | string | No | 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. |
| `safesearch` | string ("off" | "strict") | No | 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. |
| `start_time` | string | No | 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. |
| `time_range` | string ("day" | "week" | "month" | "year" | "d" | "w" | "m" | "y") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Web

**Slug:** `OCTEN_SEARCH_WEB`

Search 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |