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
    }
  ]
}
'
{
  "_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>"
  }
}

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.

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