Skip to main content
POST
/
api
/
v2
/
agents
/
experiment
/
create
Create Agent Experiment
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/experiment/create \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "name": "<string>",
  "agentOIds": [
    "<string>"
  ],
  "description": "<string>",
  "weights": [
    {
      "oId": "<string>",
      "weight": 123
    }
  ]
}
'
import requests

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

payload = {
    "name": "<string>",
    "agentOIds": ["<string>"],
    "description": "<string>",
    "weights": [
        {
            "oId": "<string>",
            "weight": 123
        }
    ]
}
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({
    name: '<string>',
    agentOIds: ['<string>'],
    description: '<string>',
    weights: [{oId: '<string>', weight: 123}]
  })
};

fetch('https://app.octavehq.com/api/v2/agents/experiment/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/agents/experiment/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([
    'name' => '<string>',
    'agentOIds' => [
        '<string>'
    ],
    'description' => '<string>',
    'weights' => [
        [
                'oId' => '<string>',
                'weight' => 123
        ]
    ]
  ]),
  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/agents/experiment/create"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"agentOIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"weights\": [\n    {\n      \"oId\": \"<string>\",\n      \"weight\": 123\n    }\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/agents/experiment/create")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"agentOIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"weights\": [\n    {\n      \"oId\": \"<string>\",\n      \"weight\": 123\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.octavehq.com/api/v2/agents/experiment/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  \"name\": \"<string>\",\n  \"agentOIds\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"weights\": [\n    {\n      \"oId\": \"<string>\",\n      \"weight\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "oId": "<string>",
  "name": "<string>",
  "agents": [
    {
      "oId": "<string>",
      "name": "<string>",
      "costToRun": 123
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "description": "<string>",
  "weights": [
    {
      "oId": "<string>",
      "weight": 123
    }
  ],
  "user": {
    "oId": "<string>",
    "firstName": "<string>",
    "lastName": "<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

Agent experiment creation input

Input for creating an agent experiment

name
string
required
agentType
enum<string>
required
Available options:
PROSPECTOR,
CONTENT,
EMAIL,
ENRICH_PERSON,
ENRICH_COMPANY,
QUALIFY_PERSON,
QUALIFY_COMPANY,
CALL_PREP,
CONTEXT
runStrategy
enum<string>
required
Available options:
RANDOM,
ROUND_ROBIN,
WEIGHTED
agentOIds
string[]
required
description
string
weights
object[]

Response

Agent experiment created successfully

_metadata
object
required
oId
string
required
name
string
required
agentType
enum<string>
required
Available options:
PROSPECTOR,
CONTENT,
EMAIL,
ENRICH_PERSON,
ENRICH_COMPANY,
QUALIFY_PERSON,
QUALIFY_COMPANY,
CALL_PREP,
CONTEXT
runStrategy
enum<string>
required
Available options:
RANDOM,
ROUND_ROBIN,
WEIGHTED
agents
object[]
required
createdAt
string
required
updatedAt
string
required
description
string
weights
object[] | null
user
object | null