Skip to main content
POST
/
api
/
v2
/
resource
/
create
Create Resource
curl --request POST \
  --url https://app.octavehq.com/api/v2/resource/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "mode": "text",
  "text": "This is the content of my landing page...",
  "name": "Product Landing Page",
  "metadata": {
    "customField": "value"
  }
}
'
import requests

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

payload = {
"mode": "text",
"text": "This is the content of my landing page...",
"name": "Product Landing Page",
"metadata": { "customField": "value" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mode: 'text',
text: 'This is the content of my landing page...',
name: 'Product Landing Page',
metadata: {customField: 'value'}
})
};

fetch('https://app.octavehq.com/api/v2/resource/create', 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/create",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'mode' => 'text',
'text' => 'This is the content of my landing page...',
'name' => 'Product Landing Page',
'metadata' => [
'customField' => 'value'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)

func main() {

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

payload := strings.NewReader("{\n \"mode\": \"text\",\n \"text\": \"This is the content of my landing page...\",\n \"name\": \"Product Landing Page\",\n \"metadata\": {\n \"customField\": \"value\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.octavehq.com/api/v2/resource/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"mode\": \"text\",\n \"text\": \"This is the content of my landing page...\",\n \"name\": \"Product Landing Page\",\n \"metadata\": {\n \"customField\": \"value\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mode\": \"text\",\n \"text\": \"This is the content of my landing page...\",\n \"name\": \"Product Landing Page\",\n \"metadata\": {\n \"customField\": \"value\"\n }\n}"

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,
    "isGlobal": 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>"
  }
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}
{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}

Authorizations

api_key
string
header
required

Body

application/json
mode
enum<string>
required

Create a text resource

Available options:
text
text
string
required

The text content of the resource

Minimum string length: 1
Example:

"This is the content of my landing page..."

name
string

Display name for the resource

Example:

"Product Landing Page"

metadata
object

Optional metadata to attach to the resource

Example:
{ "customField": "value" }

Response

Resource created successfully

_metadata
object
required
data
object
required