Skip to main content

RequestCompanyIntelligenceReportInput

No description

input RequestCompanyIntelligenceReportInput {
  companyId: ID!
  templateId: ID!
  name: String
  toolsConfig: IntelligenceReportToolsConfigInput
  idempotencyKey: String
}

Fields​

RequestCompanyIntelligenceReportInput.companyId ● ID! non-null scalar​

The identifier of the company the report is about

RequestCompanyIntelligenceReportInput.templateId ● ID! non-null scalar​

Identifier of the template the report should be based on

RequestCompanyIntelligenceReportInput.name ● String scalar​

Name of the generated report. Defaults to the template name

RequestCompanyIntelligenceReportInput.toolsConfig ● IntelligenceReportToolsConfigInput input​

Configuration of tools that can be used during report generation. Omit or pass null to use the default tools: WEB_SEARCH. When provided, exactly the listed tools are requested; pass an empty tools list to generate the report without tools. Idempotency compares tool ids after this default is applied.

RequestCompanyIntelligenceReportInput.idempotencyKey ● String scalar​

Optional client-supplied idempotency key, scoped per organization and requesting user. Retrying with the same idempotencyKey and the same input returns the original report — including while the original is still inside its cooldown window, and a concurrent retry whose original is still in flight converges on the original in-progress report. The key persists for the lifetime of the report. Omit to disable idempotency — each call without an idempotencyKey is a fresh request. Reusing the key for a different company, or with any other different input, returns an IdempotencyKeyConflictError.

Member Of​

requestCompanyIntelligenceReport mutation