> ## Documentation Index > Fetch the complete documentation index at: https://docs.octen.ai/llms.txt > Use this file to discover all available pages before exploring further. # Pulse Search API Reference > Generates the most likely URLs for a query in about 10ms and returns them in ranked order. Lite mode returns URLs and titles; standard mode adds highlights, full content, and images. ## OpenAPI ````yaml /api-reference/openapi.json post /pulse-search openapi: 3.1.0 info: title: Octen API description: >- Octen API provides Broad Search, Web Search, Image Search, Video Search, Extract, Embeddings, VL Embeddings, Answer, and Deep Research services. The Web Search API searches ranked web results with optional filters, highlights, and full content. The Image Search API searches for images from a text query or an image. The Video Search API searches for videos from a text query. The Broad Search API decomposes a query into multiple sub-queries, searches them in parallel, and returns results grouped by sub-query. The Extract API extracts clean content from URLs, with optional query-focused highlights, page classification, and multimedia resources. The Embeddings API converts text into vector representations. The VL Embeddings API converts multimodal inputs into vector representations. The Answer API decomposes queries into multiple sub-queries for comprehensive search and synthesis. The Deep Research API runs a multi-round adaptive research pipeline that produces a structured research plan, executes iterative searches, and streams a final long-form report. The Pulse Search API generates the most likely URLs for a query in about 10ms, with optional highlights and full content in standard mode. version: 1.0.0 servers: - url: https://api.octen.ai security: - bearerAuth: [] - apiKeyAuth: [] paths: /pulse-search: post: summary: Pulse Search description: >- Generates the most likely URLs for a query in about 10ms and returns them in ranked order. Lite mode returns URLs and titles; standard mode adds highlights, full content, and images. operationId: pulse-search requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PulseSearchRequest' examples: basic: summary: Basic Pulse Search value: query: wikipedia count: 3 standardHighlights: summary: Standard Mode + Highlights value: query: python programming language mode: standard count: 3 highlight: enable: true max_tokens: 100 fullContent: summary: Full Content Enabled value: query: python list methods mode: standard count: 2 full_content: enable: true max_tokens: 1000 responses: '200': description: Successful pulse search response content: application/json: schema: $ref: '#/components/schemas/PulseSearchResponse' examples: lite: summary: Lite Mode value: code: 0 msg: success request_id: req_abc123def456 data: query: wikipedia results: - title: Wikipedia The Free Encyclopedia url: wikipedia.org - title: Wikipedia, the free encyclopedia url: en.wikipedia.org/wiki/Main_Page - title: Wikipedia url: en.wikipedia.org/wiki/Wikipedia meta: usage: num_search_queries: 1 full_content_extra_count: 0 billed_mode: lite latency: 3 warning: '' standard: summary: Standard Mode value: code: 0 msg: success request_id: req_abc123def456 data: query: python programming language results: - title: Python (programming language) url: >- https://en.wikipedia.org/wiki/Python_(programming_language) highlight: >- Python(programming language) … Python is a high-level,general-purpose programming language that emphasizes code readability,simplicity,and ease-of-writing with the use of significant indentation,[38]an extensive("batteries-included")standard library,and garbage collection. … Python is widely taught as an introductory programming language. … The Python Language Reference. … Python(programming language) full_content: '' authors: Contributors to Wikimedia projects time_published: '2026-10-02T22:31:00Z' time_last_crawled: '2026-10-02T23:04:18Z' favicon: >- https://en.wikipedia.org/static/apple-touch/wikipedia.png - title: Welcome to Python.org url: https://www.python.org/ highlight: >- Python knows the usual control flow statements that other languages speak—if,for,while and range—with some of its own twists,of course. … Lists(known as arrays in other languages)are one of the compound data types that Python understands. … Hello,I'm Python! … Experienced programmers in any other language can pick up Python very quickly,and beginners find the clean syntax and indentation structure easy to learn. … Python is a programming language that lets you work quickly and integrate systems more effectively. full_content: '' authors: '' time_published: '2026-10-26T00:00:00Z' time_last_crawled: '2026-10-27T09:19:55Z' favicon: >- https://www.python.org/static/apple-touch-icon-144x144-precomposed.png - title: Introduction to Python url: https://www.w3schools.com/python/python_intro.asp highlight: >- Python Introduction What is Python? Python is a popular programming language. … Python can connect to database systems. … Python has a simple syntax similar to the English language. … Python has syntax that allows developers to write programs with fewer lines than some other programming languages. … Python Syntax compared to other programming languages Python was designed for readability,and has some similarities to the English language with influence from mathematics. … Python uses new lines to complete a command,as opposed to other programming languages which often use semicolons or parentheses. full_content: '' authors: '' time_published: '' time_last_crawled: '2026-10-26T15:37:08Z' favicon: https://www.w3schools.com/apple-touch-icon.png meta: usage: num_search_queries: 1 full_content_extra_count: 0 billed_mode: standard latency: 29 warning: '' '400': description: Invalid or missing parameter. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 400 msg: Invalid params. Missing parameter query request_id: req_abc123def456 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/InsufficientBalance' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' security: - bearerAuthNoPayment: [] - apiKeyAuthNoPayment: [] components: schemas: PulseSearchRequest: type: object required: - query properties: query: type: string maxLength: 500 description: The search query. mode: type: string enum: - lite - standard default: lite description: >- Processing mode. `lite` returns the URL and title of each result. `standard` also returns highlights, full content, and images. count: type: integer default: 5 minimum: 1 maximum: 10 description: Number of results to return. highlight: $ref: '#/components/schemas/PulseSearchHighlightOptions' full_content: $ref: '#/components/schemas/PulseSearchFullContentOptions' safesearch: type: string enum: - 'off' - strict default: strict description: >- Controls filtering of explicit/adult content. `off` disables filtering; `strict` drops all adult content. include_images: type: boolean default: false description: >- Whether to include images in each result. Has no effect in lite mode. PulseSearchResponse: type: object properties: code: type: integer description: Business status code. 0 indicates success. msg: type: string description: A message describing the result. request_id: type: string description: The unique identifier for this request. data: $ref: '#/components/schemas/PulseSearchData' meta: $ref: '#/components/schemas/PulseSearchMeta' ErrorResponse: type: object properties: code: type: integer description: Business status code. Non-zero values indicate an error. msg: type: string description: A message describing the error. request_id: type: string description: Unique identifier for the request. required: - code - msg - request_id PulseSearchHighlightOptions: type: object description: >- Controls highlight extraction from result pages. Has no effect in lite mode. properties: enable: type: boolean default: true description: If true, returns query-relevant highlight in each result. max_tokens: type: integer default: 512 minimum: 100 maximum: 20000 description: Max tokens returned per highlight. PulseSearchFullContentOptions: type: object description: >- Controls whether to return the full raw content of each result page. Has no effect in lite mode. properties: enable: type: boolean default: false description: If true, returns full_content for each result. max_tokens: type: integer default: 2048 minimum: 100 maximum: 100000 description: Maximum tokens of full content included per result. PulseSearchData: type: object description: The main response payload. properties: query: type: string description: The original query. results: type: array description: A list of search results. items: $ref: '#/components/schemas/PulseSearchResult' PulseSearchMeta: type: object description: Additional metadata for the search request. properties: usage: $ref: '#/components/schemas/PulseSearchUsage' latency: type: number description: Response time in milliseconds. warning: type: string nullable: true description: Warning message, if any. PulseSearchResult: type: object description: A single search result. properties: title: type: string nullable: true description: The title of the result page. url: type: string description: >- The URL of the result page. In lite mode, the URL has no scheme, such as `wikipedia.org`. highlight: type: string description: >- Query-relevant highlight snippets. Returned only if highlight.enable is true. Standard mode only. full_content: type: string description: >- Full raw page content. Returned only if full_content.enable is true. Standard mode only. authors: type: string description: Website name or author. Standard mode only. time_published: type: string format: date-time description: Publish time in ISO 8601. Standard mode only. time_last_crawled: type: string format: date-time description: Last crawl time in ISO 8601. Standard mode only. favicon: type: string description: The favicon URL of the result site. Standard mode only. cover_image: type: object description: >- The page cover image. Returned only when `include_images` is true and the page has a cover image. Standard mode only. properties: url: type: string description: The cover image URL. description: type: string description: Text description of the cover image. images: type: array description: >- In-body images of the page, in order of appearance. Returned only when `include_images` is true. Standard mode only. items: type: object properties: url: type: string description: The image URL. description: type: string description: Text description of the image. PulseSearchUsage: type: object description: Usage information for the search request. properties: num_search_queries: type: integer description: Number of search queries executed. full_content_extra_count: type: integer description: Billable full_content results beyond the free allowance. billed_mode: type: string enum: - lite - standard description: >- The mode this request is billed at. A standard request is billed at `lite` when page details are not available for any result. responses: Unauthorized: description: Invalid API Key — Returned when the API key is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 401 msg: Invalid API Key request_id: req_abc123def456 InsufficientBalance: description: >- Insufficient balance in account — Returned when the account balance is insufficient to complete the request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 403 msg: Insufficient balance in account request_id: req_abc123def456 RateLimited: description: >- Exceeding the rate limit — Returned when the request exceeds the configured rate limit. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 429 msg: Exceeding the rate limit request_id: req_abc123def456 InternalError: description: Internal error — Returned when an unexpected server-side error occurs. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: 500 msg: Internal error request_id: req_abc123def456 securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer token used for request authentication. Alternatively, you can send the API key in the `x-api-key` header. Note: A payment method is required to use the API. apiKeyAuth: type: apiKey in: header name: x-api-key description: >- API key used for request authentication. Alternatively, you can send the key as a Bearer token in the `Authorization` header. Note: A payment method is required to use the API. bearerAuthNoPayment: type: http scheme: bearer description: >- Bearer token used for request authentication. Alternatively, you can send the API key in the `x-api-key` header. apiKeyAuthNoPayment: type: apiKey in: header name: x-api-key description: >- API key used for request authentication. Alternatively, you can send the key as a Bearer token in the `Authorization` header. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.