POST
/
api
/
v2
/
agents
/
generate-content
/
run
Content Agent
curl --request POST \
  --url https://app.octavehq.com/api/v2/agents/generate-content/run \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "email": "john.doe@example.com",
  "jobTitle": "<string>",
  "companyDomain": "example.com",
  "companyName": "<string>",
  "firstName": "<string>",
  "linkedInProfile": "<string>",
  "runtimeContext": "<any>",
  "url": "<string>",
  "agentOId": "agent_123",
  "experimentOId": "experiment_123"
}'
{
  "_metadata": {
    "usage": 0,
    "requestId": "requestId",
    "message": "message",
    "timestamp": "2021-01-01T00:00:00.000Z"
  },
  "found": true,
  "message": "Additional information",
  "data": {
    "content": "<string>",
    "jsonContent": {},
    "product": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Product Internal Name",
      "description": "Product Description",
      "primaryUrl": "https://www.product.com",
      "data": {
        "type": "PRODUCT",
        "internalName": "<string>",
        "summary": "<string>",
        "capabilities": [
          "Capability 1",
          "Capability 2"
        ],
        "differentiatedValue": [
          "Differentiated Value 1",
          "Differentiated Value 2"
        ],
        "statusQuo": [
          "Status Quo 1",
          "Status Quo 2"
        ],
        "challengesAddressed": [
          "Challenge 1",
          "Challenge 2"
        ],
        "customerBenefits": [
          "Benefit 1",
          "Benefit 2"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "playbook": {
      "oId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "type": "LEGACY",
      "keyInsight": [
        "<string>"
      ],
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "persona": {
      "oId": "<string>",
      "name": "<string>",
      "internalName": "Sally the Sales Leader",
      "description": "<string>",
      "data": {
        "internalName": "<string>",
        "primaryResponsibilities": [
          "Responsibility 1",
          "Responsibility 2"
        ],
        "painPoints": [
          "Pain Point 1",
          "Pain Point 2"
        ],
        "keyConcerns": [
          "Concern 1",
          "Concern 2"
        ],
        "keyObjectives": [
          "Objective 1",
          "Objective 2"
        ],
        "commonJobTitles": [
          "Job Title 1",
          "Job Title 2"
        ],
        "whyTheyMatterToUs": [
          "Reason 1",
          "Reason 2"
        ],
        "whyWeMatterToThem": [
          "Reason 1",
          "Reason 2"
        ],
        "customFields": [
          {
            "title": "<string>",
            "value": [
              "<string>"
            ]
          }
        ]
      },
      "qualifyingQuestions": [
        {
          "question": "<string>",
          "rationale": "<string>",
          "fitType": "GOOD",
          "weight": "MEDIUM",
          "archivedAt": "<string>"
        }
      ],
      "activeSequences": 123,
      "sentEmails": 123,
      "matchConfidence": "LOW",
      "matchAnalysis": "<string>"
    },
    "useCases": [
      {
        "oId": "<string>",
        "name": "<string>",
        "internalName": "Use Case Internal Name",
        "description": "Use Case Description",
        "primaryUrl": "https://www.use-case.com",
        "data": {
          "summary": "<string>",
          "scenarios": [
            "<string>"
          ],
          "desiredOutcomes": [
            "<string>"
          ],
          "businessDrivers": [
            "<string>"
          ],
          "customFields": [
            {
              "title": "<string>",
              "value": [
                "<string>"
              ]
            }
          ]
        },
        "scenarios": [
          "<string>"
        ],
        "desiredOutcomes": [
          "<string>"
        ],
        "matchConfidence": "LOW",
        "matchAnalysis": "<string>"
      }
    ],
    "referenceCustomers": [
      {
        "name": "",
        "oId": "<string>",
        "matchConfidence": "LOW",
        "matchAnalysis": "<string>",
        "howTheyUseProduct": "",
        "howTheyBenefitFromProduct": "",
        "howWeImpactedTheirBusiness": [],
        "keyStats": []
      }
    ],
    "valueProps": [
      {
        "oId": "<string>",
        "title": "<string>",
        "details": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "evidence": [
          "<string>"
        ]
      }
    ],
    "annotations": {
      "annotations": [
        {
          "type": "<string>",
          "meta": "<any>",
          "title": "<string>",
          "description": "<string>",
          "url": "<string>"
        }
      ],
      "metadata": "<any>"
    }
  }
}

Authorizations

api_key
string
header
required

Body

application/json

Generate content input

The body is of type object.

Response

200
application/json

Generate content successful

The response is of type object.