improvement(apollo): fix tool outputs to match Apollo API response shapes

Author: waleedlatif1

apps/sim/tools/apollo/account_bulk_create.ts

@@ -50,15 +50,21 @@ export const apolloAccountBulkCreateTool: ToolConfig<
     }
 
     const data = await response.json()
+    const createdAccounts = Array.isArray(data.created_accounts)
+      ? data.created_accounts
+      : Array.isArray(data.accounts)
+        ? data.accounts
+        : []
+    const existingAccounts = Array.isArray(data.existing_accounts) ? data.existing_accounts : []
 
     return {
       success: true,
       output: {
-        created_accounts: data.accounts || data.created_accounts || [],
-        failed_accounts: data.failed_accounts || [],
-        total_submitted: data.accounts?.length || 0,
-        created: data.created_accounts?.length || data.accounts?.length || 0,
-        failed: data.failed_accounts?.length || 0,
+        created_accounts: createdAccounts,
+        existing_accounts: existingAccounts,
+        total_submitted: createdAccounts.length + existingAccounts.length,
+        created: createdAccounts.length,
+        existing: existingAccounts.length,
       },
     }
   },
@@ -68,21 +74,21 @@ export const apolloAccountBulkCreateTool: ToolConfig<
       type: 'json',
       description: 'Array of newly created accounts',
     },
-    failed_accounts: {
+    existing_accounts: {
       type: 'json',
-      description: 'Array of accounts that failed to create',
+      description: 'Array of existing accounts returned by Apollo (when duplicates are detected)',
     },
     total_submitted: {
       type: 'number',
-      description: 'Total number of accounts submitted',
+      description: 'Total number of accounts in the response (created + existing)',
     },
     created: {
       type: 'number',
       description: 'Number of accounts successfully created',
     },
-    failed: {
+    existing: {
       type: 'number',
-      description: 'Number of accounts that failed to create',
+      description: 'Number of existing accounts found',
     },
   },
 }

apps/sim/tools/apollo/account_search.ts

@@ -100,7 +100,7 @@ export const apolloAccountSearchTool: ToolConfig<
     return {
       success: true,
       output: {
-        accounts: data.accounts ?? null,
+        accounts: data.accounts ?? [],
         pagination: data.pagination ?? null,
       },
     }
@@ -110,7 +110,6 @@ export const apolloAccountSearchTool: ToolConfig<
     accounts: {
       type: 'json',
       description: 'Array of accounts matching the search criteria',
-      optional: true,
     },
     pagination: { type: 'json', description: 'Pagination information', optional: true },
   },

apps/sim/tools/apollo/contact_search.ts

@@ -99,7 +99,7 @@ export const apolloContactSearchTool: ToolConfig<
     return {
       success: true,
       output: {
-        contacts: data.contacts ?? null,
+        contacts: data.contacts ?? [],
         pagination: data.pagination ?? null,
       },
     }
@@ -109,7 +109,6 @@ export const apolloContactSearchTool: ToolConfig<
     contacts: {
       type: 'json',
       description: 'Array of contacts matching the search criteria',
-      optional: true,
     },
     pagination: { type: 'json', description: 'Pagination information', optional: true },
   },

apps/sim/tools/apollo/opportunity_get.ts

@@ -47,14 +47,18 @@ export const apolloOpportunityGetTool: ToolConfig<
     return {
       success: true,
       output: {
-        opportunity: data.opportunity || {},
+        opportunity: data.opportunity ?? null,
         found: !!data.opportunity,
       },
     }
   },
 
   outputs: {
-    opportunity: { type: 'json', description: 'Complete opportunity data from Apollo' },
+    opportunity: {
+      type: 'json',
+      description: 'Complete opportunity data from Apollo',
+      optional: true,
+    },
     found: { type: 'boolean', description: 'Whether the opportunity was found' },
   },
 }

apps/sim/tools/apollo/people_bulk_enrich.ts

@@ -70,21 +70,46 @@ export const apolloPeopleBulkEnrichTool: ToolConfig<
     }
 
     const data = await response.json()
-    const people = data.people || data.matches || []
+    const matches = Array.isArray(data.matches)
+      ? data.matches
+      : Array.isArray(data.people)
+        ? data.people
+        : []
 
     return {
       success: true,
       output: {
-        people,
-        total: people.length,
-        enriched: people.filter((p: unknown) => p).length,
+        matches,
+        total_requested_enrichments: data.total_requested_enrichments ?? matches.length,
+        unique_enriched_records: data.unique_enriched_records ?? matches.filter(Boolean).length,
+        missing_records: data.missing_records ?? null,
+        credits_consumed: data.credits_consumed ?? null,
       },
     }
   },
 
   outputs: {
-    people: { type: 'json', description: 'Array of enriched people data' },
-    total: { type: 'number', description: 'Total number of people processed' },
-    enriched: { type: 'number', description: 'Number of people successfully enriched' },
+    matches: {
+      type: 'json',
+      description: 'Array of enriched people (null entries indicate no match)',
+    },
+    total_requested_enrichments: {
+      type: 'number',
+      description: 'Total number of records submitted for enrichment',
+    },
+    unique_enriched_records: {
+      type: 'number',
+      description: 'Number of records successfully enriched',
+    },
+    missing_records: {
+      type: 'number',
+      description: 'Number of records that could not be enriched',
+      optional: true,
+    },
+    credits_consumed: {
+      type: 'number',
+      description: 'Number of Apollo credits consumed by this request',
+      optional: true,
+    },
   },
 }

apps/sim/tools/apollo/people_enrich.ts

@@ -110,14 +110,18 @@ export const apolloPeopleEnrichTool: ToolConfig<
     return {
       success: true,
       output: {
-        person: data.person || {},
+        person: data.person ?? null,
         enriched: !!data.person,
       },
     }
   },
 
   outputs: {
-    person: { type: 'json', description: 'Enriched person data from Apollo' },
+    person: {
+      type: 'json',
+      description: 'Enriched person data from Apollo',
+      optional: true,
+    },
     enriched: { type: 'boolean', description: 'Whether the person was successfully enriched' },
   },
 }

apps/sim/tools/apollo/sequence_add_contacts.ts

@@ -131,7 +131,7 @@ export const apolloSequenceAddContactsTool: ToolConfig<
 
     const added = Array.isArray(data?.contacts?.added) ? data.contacts.added : []
     const skipped = Array.isArray(data?.contacts?.skipped) ? data.contacts.skipped : []
-    const skippedIds = data?.skipped_contact_ids ?? null
+    const skippedIds = Array.isArray(data?.skipped_contact_ids) ? data.skipped_contact_ids : null
 
     return {
       success: true,
@@ -158,7 +158,7 @@ export const apolloSequenceAddContactsTool: ToolConfig<
     },
     skipped_contact_ids: {
       type: 'json',
-      description: 'Hash mapping contact IDs to skip reason codes',
+      description: 'Array of contact IDs that were skipped',
       optional: true,
     },
     emailer_campaign: {

apps/sim/tools/apollo/task_search.ts

@@ -71,7 +71,7 @@ export const apolloTaskSearchTool: ToolConfig<ApolloTaskSearchParams, ApolloTask
     return {
       success: true,
       output: {
-        tasks: data.tasks ?? null,
+        tasks: data.tasks ?? [],
         pagination: data.pagination ?? null,
       },
     }
@@ -81,7 +81,6 @@ export const apolloTaskSearchTool: ToolConfig<ApolloTaskSearchParams, ApolloTask
     tasks: {
       type: 'json',
       description: 'Array of tasks matching the search criteria',
-      optional: true,
     },
     pagination: { type: 'json', description: 'Pagination information', optional: true },
   },

apps/sim/tools/apollo/types.ts

@@ -155,7 +155,7 @@ export interface ApolloPeopleEnrichParams extends ApolloBaseParams {
 
 export interface ApolloPeopleEnrichResponse extends ToolResponse {
   output: {
-    person: ApolloPerson
+    person: ApolloPerson | null
     enriched: boolean
   }
 }
@@ -179,9 +179,11 @@ export interface ApolloPeopleBulkEnrichParams extends ApolloBaseParams {
 
 export interface ApolloPeopleBulkEnrichResponse extends ToolResponse {
   output: {
-    people: ApolloPerson[]
-    total: number
-    enriched: number
+    matches: Array<ApolloPerson | null>
+    total_requested_enrichments: number
+    unique_enriched_records: number
+    missing_records: number | null
+    credits_consumed: number | null
   }
 }
 
@@ -355,7 +357,7 @@ export interface ApolloPagination {
 
 export interface ApolloContactSearchResponse extends ToolResponse {
   output: {
-    contacts: ApolloContact[] | null
+    contacts: ApolloContact[]
     pagination: ApolloPagination | null
   }
 }
@@ -410,7 +412,7 @@ export interface ApolloAccountSearchParams extends ApolloBaseParams {
 
 export interface ApolloAccountSearchResponse extends ToolResponse {
   output: {
-    accounts: ApolloAccount[] | null
+    accounts: ApolloAccount[]
     pagination: ApolloPagination | null
   }
 }
@@ -428,10 +430,10 @@ export interface ApolloAccountBulkCreateParams extends ApolloBaseParams {
 export interface ApolloAccountBulkCreateResponse extends ToolResponse {
   output: {
     created_accounts: ApolloAccount[]
-    failed_accounts: Array<{ name: string; error: string }>
+    existing_accounts: ApolloAccount[]
     total_submitted: number
     created: number
-    failed: number
+    existing: number
   }
 }
 
@@ -483,7 +485,7 @@ export interface ApolloSequenceAddContactsResponse extends ToolResponse {
   output: {
     added: ApolloSequenceAddedContact[]
     skipped: ApolloSequenceSkippedContact[]
-    skipped_contact_ids: Record<string, string> | null
+    skipped_contact_ids: string[] | null
     emailer_campaign: { id: string; name: string } | null
     sequence_id: string
     total_added: number
@@ -519,7 +521,7 @@ export interface ApolloTaskSearchParams extends ApolloBaseParams {
 
 export interface ApolloTaskSearchResponse extends ToolResponse {
   output: {
-    tasks: ApolloTask[] | null
+    tasks: ApolloTask[]
     pagination: ApolloPagination | null
   }
 }
@@ -528,11 +530,12 @@ export interface ApolloTaskSearchResponse extends ToolResponse {
 export interface ApolloEmailAccountsParams extends ApolloBaseParams {}
 
 export interface ApolloEmailAccount {
-  id: string
+  id: string | number
   email: string
   type?: string
   active?: boolean
   default?: boolean
+  linked_at?: string | null
 }
 
 export interface ApolloEmailAccountsResponse extends ToolResponse {
@@ -583,7 +586,7 @@ export interface ApolloOpportunityGetParams extends ApolloBaseParams {
 
 export interface ApolloOpportunityGetResponse extends ToolResponse {
   output: {
-    opportunity: ApolloOpportunity
+    opportunity: ApolloOpportunity | null
     found: boolean
   }
 }