Octave integration (AI, Marketing). Imported from open-connector.
https://app.octavehq.com/api/v2/api-key/validate
/api/v2/agents/list
| Param | Type | Required | Description |
|---|---|---|---|
| type | string | optional | The Octave agent type identifier. |
| query | string | optional | Query used to filter the agents returned by Octave. |
| offset | integer | optional | Offset of the first agent to return. |
| limit | integer | optional | Maximum number of agents to return. |
| orderField | string | optional | Field used to order returned agents. |
| orderDirection | string | optional | Direction used to order returned agents. |
| includeExperiments | boolean | optional | Whether to include experiments when listing EMAIL or CONTENT agents. |
/api/v2/agents/get
| Param | Type | Required | Description |
|---|---|---|---|
| oId | string | required | The Octave agent OId. |
/api/v2/agents/types
/api/v2/agents/languages
/api/v2/agents/enrich-company/run
| Param | Type | Required | Description |
|---|---|---|---|
| agentOId | string | required | The Octave agent OId. Find it in the Agents section of the Octave dashboard. |
| companyDomain | string | optional | Company domain to process. |
| companyName | string | optional | Company name to process. |
| crmAccountId | string | optional | CRM account ID associated with the company. |
| runtimeContext | string | optional | Runtime context forwarded to Octave for the agent run. |
| includeFullAnnotation | boolean | optional | Whether Octave should return full annotation data including metadata. |
/api/v2/agents/enrich-person/run
| Param | Type | Required | Description |
|---|---|---|---|
| agentOId | string | required | The Octave agent OId. Find it in the Agents section of the Octave dashboard. |
| string | optional | Email address of the person to process. | |
| firstName | string | optional | First name of the person to process. |
| lastName | string | optional | Last name of the person to process. |
| jobTitle | string | optional | Job title of the person to process. |
| companyDomain | string | optional | Company domain associated with the person. |
| companyName | string | optional | Company name associated with the person. |
| linkedInProfile | string | optional | LinkedIn profile URL of the person. |
| crmContactId | string | optional | CRM contact ID associated with the person. |
| crmLeadId | string | optional | CRM lead ID associated with the person. |
| crmAccountId | string | optional | CRM account ID associated with the person. |
| runtimeContext | string | optional | Runtime context forwarded to Octave for the agent run. |
| includeFullAnnotation | boolean | optional | Whether Octave should return full annotation data including metadata. |
/api/v2/agents/qualify-company/run
| Param | Type | Required | Description |
|---|---|---|---|
| agentOId | string | required | The Octave agent OId. Find it in the Agents section of the Octave dashboard. |
| companyDomain | string | optional | Company domain to process. |
| companyName | string | optional | Company name to process. |
| crmAccountId | string | optional | CRM account ID associated with the company. |
| runtimeContext | string | optional | Runtime context forwarded to Octave for the agent run. |
| includeFullAnnotation | boolean | optional | Whether Octave should return full annotation data including metadata. |
/api/v2/agents/qualify-person/run
| Param | Type | Required | Description |
|---|---|---|---|
| agentOId | string | required | The Octave agent OId. Find it in the Agents section of the Octave dashboard. |
| string | optional | Email address of the person to process. | |
| firstName | string | optional | First name of the person to process. |
| lastName | string | optional | Last name of the person to process. |
| jobTitle | string | optional | Job title of the person to process. |
| companyDomain | string | optional | Company domain associated with the person. |
| companyName | string | optional | Company name associated with the person. |
| linkedInProfile | string | optional | LinkedIn profile URL of the person. |
| crmContactId | string | optional | CRM contact ID associated with the person. |
| crmLeadId | string | optional | CRM lead ID associated with the person. |
| crmAccountId | string | optional | CRM account ID associated with the person. |
| runtimeContext | string | optional | Runtime context forwarded to Octave for the agent run. |
| includeFullAnnotation | boolean | optional | Whether Octave should return full annotation data including metadata. |
/api/v2/agents/call-prep/run
| Param | Type | Required | Description |
|---|---|---|---|
| agentOId | string | required | The Octave agent OId. Find it in the Agents section of the Octave dashboard. |
| string | optional | Email address of the person to process. | |
| firstName | string | optional | First name of the person to process. |
| lastName | string | optional | Last name of the person to process. |
| jobTitle | string | optional | Job title of the person to process. |
| companyDomain | string | optional | Company domain associated with the person. |
| companyName | string | optional | Company name associated with the person. |
| linkedInProfile | string | optional | LinkedIn profile URL of the person. |
| crmContactId | string | optional | CRM contact ID associated with the person. |
| crmLeadId | string | optional | CRM lead ID associated with the person. |
| crmAccountId | string | optional | CRM account ID associated with the person. |
| runtimeContext | string | optional | Runtime context forwarded to Octave for the agent run. |
| includeFullAnnotation | boolean | optional | Whether Octave should return full annotation data including metadata. |
/api/v2/agents/context/run
| Param | Type | Required | Description |
|---|---|---|---|
| agentOId | string | required | The Octave agent OId for the preset context configuration. |
| query | string | optional | Question or task to fetch context for. |
| runtimeContext | string | optional | Runtime context string used by Octave when query is not provided. |
| additionalContext | object | optional | Optional person, company, and detail context for an Octave context agent run. |