← Tools Reference

Octave

Octave integration (AI, Marketing). Imported from open-connector.

API key11 toolshttps://app.octavehq.com
GET
octave_validate_api_key
Validate the Octave API key and return workspace metadata.

/api/v2/api-key/validate

GET
octave_list_agents
List Octave agents in the current workspace.

/api/v2/agents/list

7 parameters
ParamTypeRequiredDescription
typestringoptionalThe Octave agent type identifier.
querystringoptionalQuery used to filter the agents returned by Octave.
offsetintegeroptionalOffset of the first agent to return.
limitintegeroptionalMaximum number of agents to return.
orderFieldstringoptionalField used to order returned agents.
orderDirectionstringoptionalDirection used to order returned agents.
includeExperimentsbooleanoptionalWhether to include experiments when listing EMAIL or CONTENT agents.
GET
octave_get_agent
Get one Octave agent by OId.

/api/v2/agents/get

1 parameter
ParamTypeRequiredDescription
oIdstringrequiredThe Octave agent OId.
GET
octave_list_agent_types
List Octave agent types available to the workspace.

/api/v2/agents/types

GET
octave_list_languages
List languages supported by Octave agents.

/api/v2/agents/languages

POST
octave_run_enrich_company_agent
Run an Octave company enrichment agent synchronously.

/api/v2/agents/enrich-company/run

6 parameters
ParamTypeRequiredDescription
agentOIdstringrequiredThe Octave agent OId. Find it in the Agents section of the Octave dashboard.
companyDomainstringoptionalCompany domain to process.
companyNamestringoptionalCompany name to process.
crmAccountIdstringoptionalCRM account ID associated with the company.
runtimeContextstringoptionalRuntime context forwarded to Octave for the agent run.
includeFullAnnotationbooleanoptionalWhether Octave should return full annotation data including metadata.
POST
octave_run_enrich_person_agent
Run an Octave person enrichment agent synchronously.

/api/v2/agents/enrich-person/run

13 parameters
ParamTypeRequiredDescription
agentOIdstringrequiredThe Octave agent OId. Find it in the Agents section of the Octave dashboard.
emailstringoptionalEmail address of the person to process.
firstNamestringoptionalFirst name of the person to process.
lastNamestringoptionalLast name of the person to process.
jobTitlestringoptionalJob title of the person to process.
companyDomainstringoptionalCompany domain associated with the person.
companyNamestringoptionalCompany name associated with the person.
linkedInProfilestringoptionalLinkedIn profile URL of the person.
crmContactIdstringoptionalCRM contact ID associated with the person.
crmLeadIdstringoptionalCRM lead ID associated with the person.
crmAccountIdstringoptionalCRM account ID associated with the person.
runtimeContextstringoptionalRuntime context forwarded to Octave for the agent run.
includeFullAnnotationbooleanoptionalWhether Octave should return full annotation data including metadata.
POST
octave_run_qualify_company_agent
Run an Octave company qualification agent synchronously.

/api/v2/agents/qualify-company/run

6 parameters
ParamTypeRequiredDescription
agentOIdstringrequiredThe Octave agent OId. Find it in the Agents section of the Octave dashboard.
companyDomainstringoptionalCompany domain to process.
companyNamestringoptionalCompany name to process.
crmAccountIdstringoptionalCRM account ID associated with the company.
runtimeContextstringoptionalRuntime context forwarded to Octave for the agent run.
includeFullAnnotationbooleanoptionalWhether Octave should return full annotation data including metadata.
POST
octave_run_qualify_person_agent
Run an Octave person qualification agent synchronously.

/api/v2/agents/qualify-person/run

13 parameters
ParamTypeRequiredDescription
agentOIdstringrequiredThe Octave agent OId. Find it in the Agents section of the Octave dashboard.
emailstringoptionalEmail address of the person to process.
firstNamestringoptionalFirst name of the person to process.
lastNamestringoptionalLast name of the person to process.
jobTitlestringoptionalJob title of the person to process.
companyDomainstringoptionalCompany domain associated with the person.
companyNamestringoptionalCompany name associated with the person.
linkedInProfilestringoptionalLinkedIn profile URL of the person.
crmContactIdstringoptionalCRM contact ID associated with the person.
crmLeadIdstringoptionalCRM lead ID associated with the person.
crmAccountIdstringoptionalCRM account ID associated with the person.
runtimeContextstringoptionalRuntime context forwarded to Octave for the agent run.
includeFullAnnotationbooleanoptionalWhether Octave should return full annotation data including metadata.
POST
octave_run_call_prep_agent
Run an Octave call prep agent synchronously.

/api/v2/agents/call-prep/run

13 parameters
ParamTypeRequiredDescription
agentOIdstringrequiredThe Octave agent OId. Find it in the Agents section of the Octave dashboard.
emailstringoptionalEmail address of the person to process.
firstNamestringoptionalFirst name of the person to process.
lastNamestringoptionalLast name of the person to process.
jobTitlestringoptionalJob title of the person to process.
companyDomainstringoptionalCompany domain associated with the person.
companyNamestringoptionalCompany name associated with the person.
linkedInProfilestringoptionalLinkedIn profile URL of the person.
crmContactIdstringoptionalCRM contact ID associated with the person.
crmLeadIdstringoptionalCRM lead ID associated with the person.
crmAccountIdstringoptionalCRM account ID associated with the person.
runtimeContextstringoptionalRuntime context forwarded to Octave for the agent run.
includeFullAnnotationbooleanoptionalWhether Octave should return full annotation data including metadata.
POST
octave_run_context_agent
Run an Octave context agent synchronously.

/api/v2/agents/context/run

4 parameters
ParamTypeRequiredDescription
agentOIdstringrequiredThe Octave agent OId for the preset context configuration.
querystringoptionalQuestion or task to fetch context for.
runtimeContextstringoptionalRuntime context string used by Octave when query is not provided.
additionalContextobjectoptionalOptional person, company, and detail context for an Octave context agent run.