> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Resources

> Search across global resources using semantic search. Returns resources ranked by relevance to the query.



## OpenAPI

````yaml post /api/v2/resource/search
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/resource/search:
    post:
      tags:
        - Resource
      summary: Search Resources
      description: >-
        Search across global resources using semantic search. Returns resources
        ranked by relevance to the query.
      operationId: searchResources
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
                  minLength: 1
                  description: Search query for semantic search across resources
                  example: pricing strategies for enterprise customers
                limit:
                  type: number
                  default: 10
                  description: 'Maximum number of results to return (default: 10)'
                  example: 10
              required:
                - query
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        oId:
                          type: string
                          description: Resource OId
                        name:
                          type: string
                          description: Resource name
                        url:
                          type: string
                          nullable: true
                          description: URL if this is a URL resource
                        content:
                          type: string
                          nullable: true
                          description: Matching content excerpt
                        score:
                          type: number
                          nullable: true
                          description: Relevance score
                      required:
                        - oId
                        - name
                  total:
                    type: number
                required:
                  - _metadata
                  - data
                  - total
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          description: API usage
          example: 0
        requestId:
          type: string
          description: Request ID
          example: requestId
        message:
          type: string
          description: Message
          example: message
        timestamp:
          type: string
          description: Timestamp
          example: '2021-01-01T00:00:00.000Z'
      required:
        - requestId
        - timestamp
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````