Skip to main content
GET
/
api
/
v2
/
resource
/
list
List Resources
curl --request GET \
  --url https://app.octavehq.com/api/v2/resource/list \
  --header 'api_key: <api-key>'
import requests

url = "https://app.octavehq.com/api/v2/resource/list"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://app.octavehq.com/api/v2/resource/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.octavehq.com/api/v2/resource/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.octavehq.com/api/v2/resource/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.octavehq.com/api/v2/resource/list")
  .header("api_key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/resource/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "identifier": "<string>",
      "workspaceOId": "<string>",
      "isParentResource": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "name": "<string>",
      "metadata": {
        "ragTaskIdentifier": "<string>",
        "externalFilePath": "<string>",
        "title": "<string>",
        "description": "<string>",
        "faviconUrl": "<string>",
        "logoUrl": "<string>",
        "statusCode": 123,
        "isWorkspacePrimarySource": false,
        "isMainResource": false,
        "asyncCrawlComplete": true,
        "originalFileName": "<string>",
        "driveFileUrl": "<string>",
        "driveFileLastModifiedTime": "<string>"
      },
      "settings": {
        "excludeFromReIndexing": true
      },
      "encodedData": "<string>",
      "ragDocumentId": "<string>",
      "lastIndexedAt": "<string>",
      "hasChildren": true,
      "totalChildren": 123,
      "storageData": {
        "ragTaskIdentifier": "<string>",
        "filePath": "<string>",
        "ragDocumentId": "<string>"
      },
      "uploadedByUserOId": "<string>"
    }
  ],
  "total": 123,
  "hasNext": true
}
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "message": "<string>"
}

Authorizations

api_key
string
header
required

Query Parameters

limit
number | null
default:20

Maximum number of resources to return (default: 20)

Example:

20

offset
number | null
default:0

Pagination offset (default: 0)

Example:

0

resourceType
enum<string>

Filter by resource type: URL, GOOGLE_DRIVE, or TEXT

Available options:
url,
google_drive,
text

Search resources by name (case-insensitive)

Example:

"landing page"

status
enum<string>

Filter by resource status: PENDING, UPLOADING, INDEXED, or FAILED

Available options:
pending,
uploading,
indexed,
failed

Response

List of resources

_metadata
object
required
data
object[]
required
total
number
required
hasNext
boolean
required