Skip to main content
POST
/
api
/
v2
/
resource
/
search
Search Resources
curl --request POST \
  --url https://app.octavehq.com/api/v2/resource/search \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "query": "pricing strategies for enterprise customers",
  "limit": 10
}
'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "name": "<string>",
      "url": "<string>",
      "content": "<string>",
      "score": 123
    }
  ],
  "total": 123
}

Authorizations

api_key
string
header
required

Body

application/json
query
string
required

Search query for semantic search across resources

Minimum string length: 1
Example:

"pricing strategies for enterprise customers"

limit
number
default:10

Maximum number of results to return (default: 10)

Example:

10

Response

Search results

_metadata
object
required
data
object[]
required
total
number
required