import {z} from 'zod' export type GetApiV2PromptsArgs = {companyId?: number | undefined, context?: ('analytics' | 'api' | 'companies' | 'company' | 'documentation' | 'enrichment' | 'landing' | 'list' | 'similarity') | undefined, feature?: ('ask' | 'cleanup' | 'enrich' | 'product' | 'search' | 'similar') | undefined, limit?: number | undefined, listId?: number | undefined, model?: ('small' | 'large') | undefined, page?: number | undefined, prompt?: string | undefined, search?: string | undefined, size?: number | undefined}; export type GetApiV2PromptsOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const paginationMeta = z.object({cost: z.number(), credits: z.number(), currentPage: z.number(), firstPage: z.number(), freeRequest: z.boolean(), lastPage: z.number(), maxScrollResultsReached: z.boolean().optional(), perPage: z.number(), total: z.number()}); export const segmentationCondition = z.object({attribute: z.enum(["about.businessType", "about.industries", "about.industry", "about.name", "about.totalEmployees", "about.yearFounded", "ai.search", "analytics.monthlyVisitors", "apps", "codes.naics", "codes.sic", "contacts", "domain.domain", "domain.tld", "finances.revenue", "finances.stockExchange", "locations.headquarters.city.code", "locations.headquarters.continent.code", "locations.headquarters.country.code", "locations.headquarters.county.code", "locations.headquarters.state.code", "meta.listIds", "meta.score", "meta.syncedAt", "socials", "socials.linkedin.id", "technologies.active", "technologies.categories", "urls"]), blockedOperator: z.boolean().optional(), operator: z.enum(["and", "or"]), sign: z.enum(["equals", "exactEquals", "greater", "lower", "notEquals"]), values: z.array(z.union([z.string(), z.number()]))}); export const lLMAnswer = z.object({companyId: z.number(), explanation: z.string().optional(), fields: z.array(z.object({description: z.string().optional(), key: z.string(), type: z.enum(["array|boolean", "array|number", "array|string", "boolean", "number", "string"]), values: z.array(z.string()).optional()})).optional(), grounded: z.boolean().optional(), output: z.record(z.string(), z.unknown()), question: z.string(), score: z.number()}); export const prompt = z.object({companyId: z.number().optional(), context: z.enum(["analytics", "api", "companies", "company", "documentation", "enrichment", "landing", "list", "similarity"]), createdAt: z.string().optional(), data: z.object({all: z.boolean().optional(), count: z.number().optional(), domains: z.array(z.string()).optional(), explain: z.boolean().optional(), fields: z.array(z.object({description: z.string().optional(), key: z.string(), type: z.enum(["array|boolean", "array|number", "array|string", "boolean", "number", "string"]), values: z.array(z.string()).optional()})).optional(), model: z.enum(["small", "large"]).optional(), names: z.array(z.string()).optional(), query: z.array(segmentationCondition).optional(), question: z.string().optional(), segmentation: z.boolean().optional()}).optional(), feature: z.enum(["ask", "cleanup", "enrich", "product", "search", "similar"]).optional(), hits: z.number().optional(), id: z.number(), model: z.enum(["small", "large"]).optional(), prompt: z.string(), promptKey: z.string(), response: z.union([z.object({all: z.boolean().optional(), cost: z.number().optional(), count: z.number().optional(), domain: z.string().optional(), error: z.string().optional(), action: z.object({cost: z.number().optional(), data: z.object({answer: lLMAnswer, domains: z.array(z.string()).optional(), fields: z.array(z.object({description: z.string().optional(), key: z.string(), type: z.enum(["array|boolean", "array|number", "array|string", "boolean", "number", "string"]), values: z.array(z.string()).optional()})), job: z.literal("ask-list"), query: z.array(segmentationCondition).optional(), question: z.string()}).optional(), listId: z.number().optional(), promptId: z.number(), status: z.literal("pending"), type: z.literal("jobs:request")}).optional(), answer: z.object({explanation: z.string().optional(), output: z.record(z.string(), z.unknown()), score: z.number()}).optional()}), z.object({all: z.boolean().optional(), cost: z.number().optional(), count: z.number().optional(), domain: z.string().optional(), error: z.string().optional(), action: z.object({cost: z.literal(0).optional(), data: z.object({domains: z.array(z.string()).optional(), job: z.literal("cleanup-list"), query: z.array(segmentationCondition).optional()}).optional(), listId: z.number().optional(), promptId: z.number(), status: z.literal("pending"), type: z.literal("jobs:request")}).optional()}), z.object({all: z.boolean().optional(), cost: z.number().optional(), count: z.number().optional(), domain: z.string().optional(), error: z.string().optional(), action: z.object({cost: z.number().optional(), data: z.object({domains: z.array(z.string()).optional(), job: z.enum(["enrich-companies", "enrich-list"]), query: z.array(segmentationCondition).optional()}), listId: z.number().optional(), promptId: z.number(), status: z.literal("pending"), type: z.literal("jobs:request")}).optional()}), z.object({all: z.boolean().optional(), cost: z.number().optional(), count: z.number().optional(), domain: z.string().optional(), error: z.string().optional(), domains: z.array(z.string()).optional(), listId: z.number().optional(), query: z.array(segmentationCondition).optional()}), z.object({all: z.boolean().optional(), cost: z.number().optional(), count: z.number().optional(), domain: z.string().optional(), error: z.string().optional(), domains: z.array(z.string()).optional()})]).optional(), updatedAt: z.string().optional()}); export const getApiV2PromptsResponse = z.object({meta: paginationMeta, prompts: z.array(prompt)}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Fetch prompts history. * * GET /v2/prompts */ export const getApiV2Prompts = async (args: GetApiV2PromptsArgs, options?: GetApiV2PromptsOptions) => { const {baseUrl = "https://api.thecompaniesapi.com", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.companyId != null) query.append("companyId", String(args.companyId)) if (args.context != null) query.append("context", String(args.context)) if (args.feature != null) query.append("feature", String(args.feature)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.listId != null) query.append("listId", String(args.listId)) if (args.model != null) query.append("model", String(args.model)) if (args.page != null) query.append("page", String(args.page)) if (args.prompt != null) query.append("prompt", String(args.prompt)) if (args.search != null) query.append("search", String(args.search)) if (args.size != null) query.append("size", String(args.size)) if (apiKey !== undefined) headers.set("Authorization", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v2/prompts${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV2PromptsResponse, await res.json()) };