Fiber AI SDK

https://github.com/fiber-ai/typescript-sdk
Admin
Official TypeScript/JavaScript SDK for the Fiber AI API that enables searching and enriching...
Tokens:113,748
Snippets:621
Trust Score:4.7
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /quickstart

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Retrieves the quickstart script for getting started with the API. This operation is unauthenticated.

```APIDOC
## GET /quickstart

### Description
Retrieves the quickstart script for getting started with the API.

### Method
GET

### Endpoint
/quickstart

### Authentication
Unauthenticated

### Rate Limit
None

### Cost
Unauthenticated
```

--------------------------------

### Quick Start: getOrgCredits, companySearch, and peopleSearch

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/README.md

Quick start example showing how to check organization credits, search for companies, and search for people using the @fiberai/sdk. The employeeCountV2 range uses bucket-valued bounds (0, 1, 10, 50, 200, 500, 1000, 5000, 10000, or null). Successful responses include a chargeInfo envelope with cost details; prefer it over static pricing tables.

```typescript
import { peopleSearch, companySearch, getOrgCredits } from "@fiberai/sdk";

// Check your organization's credit balance
const credits = await getOrgCredits({
  query: { apiKey: "your-api-key" },
});

console.log(`Available credits: ${credits.data?.output.available}`);

// Search for companies
const companies = await companySearch({
  body: {
    apiKey: "your-api-key",
    searchParams: {
      industriesV2: {
        anyOf: ["Software", "Information Technology"],
      },
      // Bucket-valued range. Allowed bounds: 0 | 1 | 10 | 50 | 200 | 500 | 1000 | 5000 | 10000 | null.
      employeeCountV2: {
        lowerBoundExclusive: 50,
        upperBoundInclusive: 1000,
      },
      headquartersCountryCode: {
        anyOf: ["USA"],
      },
    },
    pageSize: 25,
  },
});

// Search for people
const people = await peopleSearch({
  body: {
    apiKey: "your-api-key",
    searchParams: {
      jobTitleV2: {
        anyOf: [
          { type: "term", term: "CEO" },
          { type: "term", term: "CTO" },
          { type: "static-groups", groups: ["c-suite"] },
        ],
      },
      country3LetterCode: { anyOf: ["USA"] },
    },
    pageSize: 25,
  },
});

// Every successful response also carries a `chargeInfo` envelope alongside
// `output`. Source of truth for cost — prefer this over the static table below.
console.log(people.data?.chargeInfo);
// e.g. { method: 'charged-now', creditsCharged: 25, lowCreditAlert: null }
```

--------------------------------

### Google Maps search workflow example

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

A complete example demonstrating how to initiate a search, check its progress, and poll for results once completed.

```typescript
import { googleMapsSearch, checkGoogleMapsResults, pollGoogleMapsResults } from "@fiberai/sdk";

// Example 1 — start search
const search = await googleMapsSearch({
  body: {
    apiKey: process.env.FIBERAI_API_KEY!,
    query: "coffee shops",
    maxResults: 100,
    strategy: { strategy: "specific-areas", unionAll: [{
      regionType: "circle", center: { latitude: 37.7749, longitude: -122.4194 }, radiusMiles: 10,
    }]},
  },
});
const searchID = search.data!.output.searchID;

// Example 2 — check, then poll results
const progress = await checkGoogleMapsResults({ body: { apiKey: process.env.FIBERAI_API_KEY!, searchID } });
if (progress.data?.output.status === "COMPLETED") {
  const results = await pollGoogleMapsResults({ body: { apiKey: process.env.FIBERAI_API_KEY!, searchID, pageSize: 50 } });
  results.data?.output.results.forEach((place) => console.log(place.name, place.address, place.rating));
}
```

--------------------------------

### companySearch usage examples

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-search.md

Examples demonstrating basic search with pagination and error handling with throwOnError.

```ts
import { companySearch } from "@fiberai/sdk";

// Example 1 — basic search + pagination
let cursor: string | null | undefined = null;
do {
  const res = await companySearch({
    body: {
      apiKey: process.env.FIBERAI_API_KEY!,
      searchParams: {
        industriesV2: { anyOf: ["Software", "Information Technology"] },
        employeeCountV2: { lowerBoundExclusive: 50, upperBoundInclusive: 1000 },
        headquartersCountryCode: { anyOf: ["USA"] },
      },
      pageSize: 25,
      cursor,
    },
  });
  if (res.error) break;
  res.data!.output.data.forEach((c) => console.log(c.preferred_name, c.domains));
  cursor = res.data!.output.nextCursor;
} while (cursor);

// Example 2 — throwOnError + chargeInfo
try {
  const res = await companySearch({
    body: { apiKey: process.env.FIBERAI_API_KEY!, searchParams: {}, pageSize: 10 },
    throwOnError: true,
  });
  console.log(res.data.output.data.length, res.data.chargeInfo.creditsCharged);
} catch (error) {
  console.error("companySearch failed:", error);
}
```

--------------------------------

### Install @fiberai/sdk with npm, yarn, or pnpm

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/README.md

Install the @fiberai/sdk package using npm, yarn, or pnpm. Requires Node.js 18.0.0 or higher.

```bash
npm install @fiberai/sdk
# or
yarn add @fiberai/sdk
# or
pnpm add @fiberai/sdk
```

--------------------------------

### Start and poll depth chart, get company revenue with @fiberai/sdk

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

Use this TypeScript snippet to start a depth chart for a company, poll for the report, and fetch a revenue estimate. It requires the FIBERAI_API_KEY environment variable and the @fiberai/sdk package. The depth chart example logs the chart output, while the revenue example handles errors by logging the response status and error, or logs the revenue band and confidence on success.

```ts
import { startDepthChart, pollDepthChart, getCompanyRevenue } from "@fiberai/sdk";

// Example 1 — depth chart (start → poll)
const started = await startDepthChart({
  body: { apiKey: process.env.FIBERAI_API_KEY!, company: { identifier: "domain", value: "openai.com" } },
});
const chart = await pollDepthChart({ body: { apiKey: process.env.FIBERAI_API_KEY!, reportId: started.data!.output.reportId } });
console.log(chart.data?.output); // { status, summary: [...], markdown, ... }

// Example 2 — revenue estimate with error branch
const rev = await getCompanyRevenue({
  body: { apiKey: process.env.FIBERAI_API_KEY!, companyMetadata: { name: "Acme Corp", domain: "acme.com" } },
});
if (rev.error) console.error(rev.response.status, rev.error);
else console.log(rev.data!.output); // revenue band & confidence
```

--------------------------------

### Usage examples for accountSendOtp

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Two examples: sending an OTP and handling errors. The first sends a request with an email and logs the verificationId and next path. The second checks for a 409 conflict error indicating an existing account.

```typescript
import { accountSendOtp } from "@fiberai/sdk";

// Example 1 — send OTP
const res = await accountSendOtp({ body: { email: "dev@example.com" } });
if (res.data) {
  console.log(res.data.output.verificationId, "→", res.data.output.next.path);
  // pass verificationId to accountVerifyOtp below
}

// Example 2 — error handling
const r2 = await accountSendOtp({ body: { email: "dev@example.com" } });
if (r2.error) {
  if (r2.response.status === 409) console.error("account already exists");
  else console.error(r2.response.status, r2.error);
}
```

--------------------------------

### accountVerifyOtp - complete signup and get live API key

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Complete signup by verifying the OTP sent to the user's email. The response contains a live API key (starts with `sk_live_`) that must be stored securely because it cannot be retrieved later. Also returns `409`/`410` errors.

```ts
body: { verificationId: string; otp: string }
```

```ts
import { accountSendOtp, accountVerifyOtp } from "@fiberai/sdk";

const sent = await accountSendOtp({ body: { email: "dev@example.com" } });
const otp = "123456"; // from the email inbox
const r = await accountVerifyOtp({ body: { verificationId: sent.data!.output.verificationId, otp } });
console.log("live key:", r.data?.output.apiKey);
console.log("sandbox key:", r.data?.output.sandboxApiKey);
console.log("trial credits:", r.data?.output.creditsAwarded);
```

--------------------------------

### syncQuickContactReveal usage examples

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-enrichment.md

Two usage examples for syncQuickContactReveal. The first uses default settings and logs the profile, emails, and phones. The second sets patience to 'HIGH' and throwOnError to true, catching the parsed 4xx/5xx error body or fetch exception. Requires the FIBERAI_API_KEY environment variable.

```ts
import { syncQuickContactReveal } from "@fiberai/sdk";

// Example 1 — default bounce validation
const res = await syncQuickContactReveal({
  body: {
    apiKey: process.env.FIBERAI_API_KEY!,
    linkedinUrl: "https://www.linkedin.com/in/example",
    enrichmentType: { getWorkEmails: true, getPersonalEmails: true, getPhoneNumbers: true },
  },
});
if (res.data) {
  const out = res.data.output;
  console.log("profile:", out.profile.name);
  console.log("emails:", out.profile.emails);       // status 'valid' = deliverable
  console.log("phones:", out.profile.phoneNumbers);
}

// Example 2 — patience tuning + 402 handling with throwOnError
try {
  const r = await syncQuickContactReveal({
    body: { apiKey: process.env.FIBERAI_API_KEY!, linkedinUrl: "williamhgates",
            enrichmentType: { getWorkEmails: true }, patience: "HIGH" },
    throwOnError: true,
  });
  console.log(r.data.output.profile.emails);
} catch (error) {
  // thrown error is the parsed 4xx/5xx body or a fetch exception
  console.error(error);
}
```

--------------------------------

### profileLiveEnrich usage examples

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-live.md

Usage examples for profileLiveEnrich. The first performs a basic call and narrows the discriminated union, logging the profile name, summary, and experiences. The second enables detailed education and work experience, uses throwOnError, and catches failures.

```ts
import { profileLiveEnrich } from "@fiberai/sdk";

// Example 1 — basic call with discriminated-union narrowing
const res = await profileLiveEnrich({
  body: { apiKey: process.env.FIBERAI_API_KEY!, identifier: "https://www.linkedin.com/in/example" },
});
const out = res.data?.output;
if (out?.found) {
  console.log(out.profile.name, out.profile.summary);
  console.log(out.profile.experiences.map((e) => `${e.title} @ ${e.company_name}`));
} else if (out) {
  console.warn("not found:", out.message);
}

// Example 2 — подробный fetch with throwOnError
try {
  const r = await profileLiveEnrich({
    body: { apiKey: process.env.FIBERAI_API_KEY!, identifier: "ACwAAA-001MBbIvJon",
            getDetailedEducation: true, getDetailedWorkExperience: true },
    throwOnError: true,
  });
  if (r.data.output.found) console.log(r.data.output.profile.name);
} catch (error) {
  console.error("live enrich failed:", error);
}
```

--------------------------------

### startLocalBusinessSearch

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

Starts a local business search for companies matching the provided criteria.

```APIDOC
## startLocalBusinessSearch

### Description
Starts a local business search for companies matching the provided criteria.

### Method
POST

### Endpoint
/startLocalBusinessSearch

### Parameters
#### Request Body
- **apiKey** (string) - Required - API key for authentication.
- **companies** (Array<{ companyName: string; companyWebsite?: string | null; city?: string; state?: string; country?: string; ... }>) - Required - List of companies to search.
- **jobTitles** (Array<string> | null) - Optional - Job titles to filter contacts.
- **strictJobTitleMatch** (boolean) - Optional - Whether to enforce strict job title matching.
- **contactPreferences** ({ companyEmails?: boolean; companyPhones?: boolean; personEmails?: boolean; personPhones?: boolean }) - Optional - Preferences for contact information.

### Response
#### Success Response (200)
- **researchRunId** (string) - Identifier for the research run.

#### Response Example
{
  "researchRunId": "string"
}
```

--------------------------------

### Pass API key in POST body and GET query

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/README.md

Shows how to pass the API key for POST requests (in the body) and GET requests (as a query parameter). Use this pattern for every API call.

```typescript
// POST request example
await companySearch({
  body: {
    apiKey: process.env.FIBERAI_API_KEY,
    searchParams: {
      /* ... */
    },
  },
});

// GET request example
await getOrgCredits({
  query: { apiKey: process.env.FIBERAI_API_KEY },
});
```

--------------------------------

### POST /v1/depth-chart/start

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

Starts a depth chart operation. Rate limited to 30 requests per minute and costs credits.

```APIDOC
## POST /v1/depth-chart/start

### Description
Starts a depth chart operation.

### Method
POST

### Endpoint
/v1/depth-chart/start

### Parameters
#### Request Body
- API key (string) - Required - API key in the body.

### Response
#### Success Response (200)
- Operation start confirmation.

### Rate Limit
30/min

### Cost
credits
```

--------------------------------

### GET /v1/auto-topup/settings

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Retrieves the current auto top-up settings. This operation is free and does not consume credits.

```APIDOC
## GET /v1/auto-topup/settings

### Description
Retrieves the current auto top-up settings.

### Method
GET

### Endpoint
/v1/auto-topup/settings

### Authentication
API key in query

### Rate Limit
10/min

### Cost
FREE
```

--------------------------------

### Search companies with filters and get count

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/README.md

Performs an advanced company search with filters for industry, size, location, funding, and keywords. Also shows how to get the total count with companyCount and how to paginate using the cursor.

```typescript
import { companySearch, companyCount } from "@fiberai/sdk";

// Advanced company search
const result = await companySearch({
  body: {
    apiKey: process.env.FIBERAI_API_KEY,
    searchParams: {
      // Industry filters
      industriesV2: {
        anyOf: ["Software", "Cloud"],
      },

      // Size filters
      employeeCountV2: {
        lowerBoundExclusive: 50,
        upperBoundInclusive: 500,
      },

      // Location filters
      headquartersCountryCode: {
        anyOf: ["USA"],
      },

      // Funding filters
      totalFundingUSD: {
        lowerBound: 1000000,
      },

      // Keywords filter
      keywords: {
        containsAny: ["venture-backed-startup"],
      },
    },
    pageSize: 50,
    cursor: null, // For pagination
  },
});

console.log(`Found ${result.data?.output.data.length} companies`);
console.log(
  `Cursor for next page: ${result.data?.output.nextCursor ?? "none"}`,
);

// Get total count before searching
const count = await companyCount({
  body: {
    apiKey: process.env.FIBERAI_API_KEY,
    searchParams: {
      /* same filters */
    },
  },
});

console.log(`Total companies matching: ${count.data?.output.count}`);
```

--------------------------------

### startBatchLiveEnrich

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-live.md

Starts a batch live enrichment task for profiles or companies. Returns a task ID for polling.

```APIDOC
## startBatchLiveEnrich

### Description
Starts a batch live enrichment operation for multiple profiles or companies. Returns a task ID that can be used with pollBatchLiveEnrich to retrieve results.

### Method
POST

### Endpoint
Not specified in source.

### Parameters
#### Request Body
- **apiKey** (string) - Required - Fiber API key
- **type** ('PROFILE' | 'COMPANY') - Required - The type of entities to enrich
- **identifiers** (Array<string>) - Required - List of identifiers to enrich

### Request Example
{
  "body": {
    "apiKey": "YOUR_API_KEY",
    "type": "COMPANY",
    "identifiers": ["microsoft", "apple"]
  }
}

### Response
#### Success Response (200)
- **output** (object) - Contains task id for polling

#### Response Example
{
  "output": {
    "taskId": "string"
  }
}
```

--------------------------------

### Registering request, response, and error interceptors

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/client.md

Shows how to register request, response, and error interceptors on a client. The first example logs outgoing requests and incoming responses, then removes the request interceptor by its id. The second example handles fetch network failures and returns a status string or the error message.

```ts
// Example 1 — request logging + response timing
const id = client.interceptors.request.use((request, opts) => {
  console.log(`>> ${opts.method} ${request.url}`);
  return request;
});
client.interceptors.response.use(async (response, request) => {
  console.log(`<< ${response.status}`);
  return response;
});
// later
client.interceptors.request.eject(id);
```

```ts
// Example 2 — inject an error interceptor (fetch network failures)
client.interceptors.error.use((error, response) => {
  console.error("transport failure:", error);
  return response instanceof Response ? `http ${response.status}` : String(error);
});
```

--------------------------------

### GET /v1/enums/accelerators

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-utilities.md

Returns the list of accelerator programs for filtering. This endpoint is free and does not consume credits.

```APIDOC
## [GET] /v1/enums/accelerators

### Description
Returns the list of accelerator programs for filtering. This endpoint is free and does not consume credits.

### Method
GET

### Endpoint
/v1/enums/accelerators

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **output** (array) - List of accelerator program strings.
- **chargeInfo** (object) - Charge information for the request.
- **warnings** (array) - Optional warnings.
- **advice** (string) - Optional advice.

#### Response Example
{
  "output": ["Y Combinator", "Techstars", "500 Startups"],
  "chargeInfo": {},
  "warnings": [],
  "advice": ""
}
```

--------------------------------

### GET /v1/audiences

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Lists all audiences. This operation is free of charge.

```APIDOC
## GET /v1/audiences

### Description
Lists all audiences. This operation is free of charge.

### Method
GET

### Endpoint
/v1/audiences

### Response
#### Success Response (200)
- **audiences** (array) - List of audiences.

#### Response Example
{
  "audiences": []
}
```

--------------------------------

### startDepthChart

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

Starts a depth chart report for a company, providing an employee breakdown by department and seniority.

```APIDOC
## startDepthChart

### Description
Starts a depth chart report for a company, providing an employee breakdown by department and seniority.

### Method
POST

### Endpoint
/startDepthChart

### Parameters
#### Request Body
- **apiKey** (string) - Required - API key for authentication.
- **company** ({ identifier, value }) - Required - Company identifier and value.
- **functions** (Array<string> | null) - Optional - List of functions to include.

### Response
#### Success Response (200)
- **reportId** (string) - Identifier for the report.

#### Response Example
{
  "reportId": "string"
}
```

--------------------------------

### GET /v1/tracker/overview

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-trackers.md

Retrieves an overview of tracker data. This operation is free and has a rate limit of 120 requests per minute.

```APIDOC
## GET /v1/tracker/overview

### Description
Retrieves an overview of tracker data.

### Method
GET

### Endpoint
/v1/tracker/overview

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **overview** (object) - Overview data.

#### Response Example
{
  "overview": {}
}
```

--------------------------------

### POST path.audienceId

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Starts the build process for an audience. Returns an output with the audience ID, a status of 'BUILDING', and a message. Poll `getAudienceStatus` until the status is terminal.

```APIDOC
## POST path.audienceId

### Description
Starts the build process for an audience. Returns an output with the audience ID, a status of 'BUILDING', and a message. Poll `getAudienceStatus` until the status is terminal.

### Method
POST

### Endpoint
`path.audienceId`

### Parameters
#### Path Parameters
- **audienceId** (string) - Required - The ID of the audience to build.

#### Request Body
- **apiKey** (string) - Required - Fiber API key.

### Request Example
```json
{
  "apiKey": "YOUR_API_KEY"
}
```

### Response
#### Success Response (200)
- **output** (object) - Contains the build result.
  - **audienceId** (string) - The ID of the audience.
  - **status** (string) - Always 'BUILDING'.
  - **message** (string) - A message about the build.

#### Response Example
```json
{
  "output": {
    "audienceId": "audience_123",
    "status": "BUILDING",
    "message": "Build started"
  }
}
```

```

--------------------------------

### GET /v1/tracker/rules

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-trackers.md

Lists available tracker rules. This operation is free and has a rate limit of 120 requests per minute.

```APIDOC
## GET /v1/tracker/rules

### Description
Lists available tracker rules.

### Method
GET

### Endpoint
/v1/tracker/rules

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **rules** (array) - List of available rules.

#### Response Example
{
  "rules": []
}
```

--------------------------------

### Create a profile saved search

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-saved-search.md

Example of creating a saved search for profiles with specific company and job title filters.

```ts
import { createSavedSearch } from "@fiberai/sdk";

// Example 1 — profile saved search
const created = await createSavedSearch({
  body: {
    apiKey: process.env.FIBERAI_API_KEY!,
    name: "New VP Sales at Software companies",
    searchParams: {
      type: "profiles",
      companySearchParams: { industriesV2: { anyOf: ["Software"] } },
      profileSearchParams: { jobTitleV2: { anyOf: [{ type: "term", term: "VP of Sales" }] } },
      maxNewProfilesPerRun: 200,
    },
    spawnFrequencyDays: 7,
  },
});
const savedSearchId = created.data!.output.id;
```

--------------------------------

### GET /v1/webhooks/event-types

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Lists all available webhook event types with descriptions and example payloads. This is used to know which event types can be subscribed to.

```APIDOC
## GET /v1/webhooks/event-types

### Description
Lists all available webhook event types with descriptions and example payloads. This is used to know which event types can be subscribed to.

### Method
GET

### Endpoint
/v1/webhooks/event-types

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - API key for authentication.

### Response
#### Success Response (200)
- **output.eventTypes** (Array<{ eventType; description; group; examplePayload }>) - List of event types.

#### Response Example
{
  "output": {
    "eventTypes": [
      {
        "eventType": "string",
        "description": "string",
        "group": "string",
        "examplePayload": {}
      }
    ]
  }
}
```

--------------------------------

### Create tracker list and manage signals

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-trackers.md

Example showing how to create a tracker list with a headcount growth rule, add companies to it, and list detected signals.

```ts
import { createTrackerCompanyList, addTrackerCompanies, listTrackerSignals } from "@fiberai/sdk";

// Example 1 — create with a headcount rule
const list = await createTrackerCompanyList({
  body: {
    apiKey: process.env.FIBERAI_API_KEY!,
    name: "High-growth targets",
    refreshIntervalDays: 7,
    trackingRules: [{
      type: "headcount_growth_percent",
      entityType: "company",
      direction: "grew",
      minPercentChange: 20,
    }],
  },
});
const listId = list.data!.output.id;

// Example 2 — populate and list detected signals
await addTrackerCompanies({
  body: {
    apiKey: process.env.FIBERAI_API_KEY!,
    companies: [{ linkedinUrl: "https://www.linkedin.com/company/openai" }],
    initialSignals: { lookbackPeriodDays: 90 },
  },
  path: { listId },
});
const signals = await listTrackerSignals({ query: { apiKey: process.env.FIBERAI_API_KEY! }, path: { listId } });
// TrackerSignalOutput items: { id, entityId, entityType: 'company'|'person', linkedinIdentifier,
//                               linkedinSlug, linkedinUrl, type, description, ... }
```

--------------------------------

### GET /v1/audiences/{audienceId}/status

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Retrieves the status of a specific audience. This operation is free of charge.

```APIDOC
## GET /v1/audiences/{audienceId}/status

### Description
Retrieves the status of a specific audience. This operation is free of charge.

### Method
GET

### Endpoint
/v1/audiences/{audienceId}/status

### Parameters
#### Path Parameters
- **audienceId** (string) - Required - The unique identifier of the audience.

### Response
#### Success Response (200)
- **status** (string) - The current status of the audience.

#### Response Example
{
  "status": "string"
}
```

--------------------------------

### GET /v1/audiences/{audienceId}/prospects

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Retrieves the prospects associated with a specific audience. This operation is free of charge.

```APIDOC
## GET /v1/audiences/{audienceId}/prospects

### Description
Retrieves the prospects associated with a specific audience. This operation is free of charge.

### Method
GET

### Endpoint
/v1/audiences/{audienceId}/prospects

### Parameters
#### Path Parameters
- **audienceId** (string) - Required - The unique identifier of the audience.

### Response
#### Success Response (200)
- **prospects** (array) - List of prospects.

#### Response Example
{
  "prospects": []
}
```

--------------------------------

### accountVerifyOtp

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Completes the signup process by verifying the OTP sent to the user's email, and returns a live API key along with sandbox key and trial credits. The live API key starts with sk_live_ and must be stored securely as it cannot be retrieved later.

```APIDOC
## POST /v1/account/verify-otp

### Description
Completes the signup process by verifying the OTP sent to the user's email, and returns a live API key along with sandbox key and trial credits. The live API key starts with sk_live_ and must be stored securely as it cannot be retrieved later.

### Method
POST

### Endpoint
/v1/account/verify-otp

### Parameters
#### Request Body
- **verificationId** (string) - Required - The verification ID returned from the send OTP step.
- **otp** (string) - Required - The one-time password sent to the user's email.

### Request Example
{
  "verificationId": "string",
  "otp": "string"
}

### Response
#### Success Response (200)
- **status** (string) - Always 'created'.
- **apiKey** (string) - The live API key, starts with sk_live_.
- **sandboxApiKey** (string | null) - Optional sandbox API key.
- **creditsAwarded** (number) - Number of trial credits awarded.
- **organizationId** (string) - The organization ID.
- **message** (string) - A message describing the result.

#### Response Example
{
  "status": "created",
  "apiKey": "sk_live_...",
  "sandboxApiKey": "sk_sandbox_...",
  "creditsAwarded": 100,
  "organizationId": "org_123",
  "message": "Account created successfully"
}

### Errors
- **409** - Conflict error.
- **410** - Gone error.
```

--------------------------------

### companyLiveEnrich usage example

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-live.md

Example of calling companyLiveEnrich with a LinkedIn URL to retrieve company headline and follower count.

```ts
import { companyLiveEnrich } from "@fiberai/sdk";

const res = await companyLiveEnrich({
  body: { apiKey: process.env.FIBERAI_API_KEY!, type: "liUrl", value: "https://www.linkedin.com/company/microsoft" },
});
console.log(res.data?.output.company.headline);
console.log(res.data?.output.company.follower_count);
```

--------------------------------

### Import SDK Client and Configuration Helpers

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/client.md

Import the pre-configured shared client instance, the client factory, and associated type definitions from the SDK package.

```ts
// pre-configured shared instance (base URL https://api.fiber.ai)
import { client } from "@fiberai/sdk";
// factory + config helpers and all client types
import { createClient, createConfig, type Client, type Config, type ClientOptions, type CreateClientConfig, type RequestOptions, type Options, type TDataShape } from "@fiberai/sdk";
```

--------------------------------

### Create audience and poll status with createAudience and getAudienceStatus

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Example usage of createAudience to create an audience and getAudienceStatus to poll its status. Requires the FIBERAI_API_KEY environment variable. The created audience ID is used in the path parameter for the status check.

```typescript
import { createAudience, getAudienceStatus } from "@fiberai/sdk";

// Example 1 — create
const created = await createAudience({
  body: { apiKey: process.env.FIBERAI_API_KEY!, name: "Series A startups" },
});
const audienceId = created.data!.output.audienceId;

// Example 2 — poll status
const status = await getAudienceStatus({
  query: { apiKey: process.env.FIBERAI_API_KEY! },
  path: { audienceId },
});
console.log(status.data?.output.status);
```

--------------------------------

### GET /v1/audiences/{audienceId}/companies

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Retrieves the companies associated with a specific audience. This operation is free of charge.

```APIDOC
## GET /v1/audiences/{audienceId}/companies

### Description
Retrieves the companies associated with a specific audience. This operation is free of charge.

### Method
GET

### Endpoint
/v1/audiences/{audienceId}/companies

### Parameters
#### Path Parameters
- **audienceId** (string) - Required - The unique identifier of the audience.

### Response
#### Success Response (200)
- **companies** (array) - List of companies.

#### Response Example
{
  "companies": []
}
```

--------------------------------

### POST /v1/local-business-search/start

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

Starts a local business search operation. Rate limited to 10 requests per minute and costs credits.

```APIDOC
## POST /v1/local-business-search/start

### Description
Starts a local business search operation.

### Method
POST

### Endpoint
/v1/local-business-search/start

### Parameters
#### Request Body
- API key (string) - Required - API key in the body.

### Response
#### Success Response (200)
- Operation start confirmation.

### Rate Limit
10/min

### Cost
credits
```

--------------------------------

### flightSearch usage example

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-travel.md

Example of calling the flightSearch function from the @fiberai/sdk package. It uses the API key from environment variables and logs flight price and duration for each result.

```typescript
import { flightSearch } from "@fiberai/sdk";

const flights = await flightSearch({
  body: {
    apiKey: process.env.FIBERAI_API_KEY!,
    travelClass: "economy",
    adults: 1,
    sortBy: "price",
    // trip legs omitted for brevity — see FlightSearchData
  },
});
flights.data?.output?.data?.forEach((f) => console.log(f.price, f.durationMinutes));
```

--------------------------------

### POST /v1/api-keys/create-sandbox

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Creates a sandbox API key. This operation is free and does not consume credits.

```APIDOC
## POST /v1/api-keys/create-sandbox

### Description
Creates a sandbox API key.

### Method
POST

### Endpoint
/v1/api-keys/create-sandbox

### Authentication
API key in body

### Rate Limit
30/min

### Cost
FREE
```

--------------------------------

### Create Independent and Per-Request Clients

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/client.md

Examples of creating a secondary client for multi-tenant applications and a client configured to throw errors on HTTP failures.

```ts
import { createClient } from "@fiberai/sdk";

// Example 1 — second, independent client (multi-tenant apps)
const tenantA = createClient({ baseUrl: "https://api.fiber.ai", headers: { "X-Tenant": "a" } });
const res = await tenantA.get({ url: "/v1/get-org-credits", query: { apiKey: process.env.FIBERAI_API_KEY_A } });

// Example 2 — per-request client + error branch on HTTP status
const myClient = createClient({ throwOnError: true });
try {
  const data = await myClient.post({ url: "/v1/company-search", body: { apiKey: process.env.FIBERAI_API_KEY, searchParams: {}, pageSize: 1 } });
  console.log(data.output.data.length);
} catch (err) {
  console.error("request failed", err); // thrown because throwOnError: true
}
```

--------------------------------

### Create, list, and delete webhook endpoints with @fiberai/sdk

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Use this snippet to create a webhook endpoint, list all endpoints, and delete the created one. The signing secret is returned only once and should be stored immediately. The example uses the FiberAI SDK with an API key from the FIBERAI_API_KEY environment variable.

```ts
import { createWebhookEndpoint, listWebhookEndpoints, deleteWebhookEndpoint } from "@fiberai/sdk";

const created = await createWebhookEndpoint({
  body: { apiKey: process.env.FIBERAI_API_KEY!, url: "https://app.example.com/hooks/fiber",
          eventTypes: ["reveal.completed", "saved_search.run_completed"] },
});
console.log("secret (store it):", created.data?.output.signingSecret);

const list = await listWebhookEndpoints({ query: { apiKey: process.env.FIBERAI_API_KEY! } });
list.data?.output.forEach((ep) => console.log(ep.endpointId, ep.url, ep.eventTypes));

await deleteWebhookEndpoint({
  query: { apiKey: process.env.FIBERAI_API_KEY! },
  path: { endpointId: created.data!.output.endpointId },
});
```

--------------------------------

### GET /health

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Checks the health status of the API. This operation is unauthenticated.

```APIDOC
## GET /health

### Description
Checks the health status of the API.

### Method
GET

### Endpoint
/health

### Authentication
Unauthenticated

### Rate Limit
None

### Cost
Unauthenticated
```

--------------------------------

### Custom fetch and URL building

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/client.md

Demonstrates how to configure a custom fetch implementation and generate a full request URL using buildUrl.

```ts
// Example: custom fetch + buildUrl (full request URL before sending)
client.setConfig({ fetch: myInstrumentedFetch });
console.log(client.buildUrl({ url: "/v1/company-search", query: { apiKey: "sk-live-…" } }));
// https://api.fiber.ai/v1/company-search?apiKey=sk-live-…
```

--------------------------------

### POST /v1/mosaic/start

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-data.md

Starts a Mosaic AI enrichment operation. Rate limited to 20 requests per minute and costs credits.

```APIDOC
## POST /v1/mosaic/start

### Description
Starts a Mosaic AI enrichment operation.

### Method
POST

### Endpoint
/v1/mosaic/start

### Parameters
#### Request Body
- API key (string) - Required - API key in the body.

### Response
#### Success Response (200)
- Operation start confirmation.

### Rate Limit
20/min

### Cost
credits
```

--------------------------------

### GET /openapi.json

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Retrieves the OpenAPI specification for the API. This operation is unauthenticated.

```APIDOC
## GET /openapi.json

### Description
Retrieves the OpenAPI specification for the API.

### Method
GET

### Endpoint
/openapi.json

### Authentication
Unauthenticated

### Rate Limit
None

### Cost
Unauthenticated
```

--------------------------------

### createConfig implementation

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/client.md

The implementation of createConfig, showing the default configuration values and how the override is merged.

```typescript
export const createConfig = <T extends ClientOptions = ClientOptions>(override = {}) => ({
  ...jsonBodySerializer,      // bodySerializer: JSON.stringify (bigint-safe)
  headers: defaultHeaders,    // { 'Content-Type': 'application/json' }
  parseAs: 'auto',
  querySerializer: defaultQuerySerializer, // form/explode arrays, deepObject objects, allowReserved: false
  ...override,
});
```

--------------------------------

### GET /v1/tracker/company-lists/{listId}/signals

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-trackers.md

Lists detected signals for a tracker list.

```APIDOC
## GET /v1/tracker/company-lists/{listId}/signals

### Description
Lists detected signals for a tracker list.

### Method
GET

### Endpoint
/v1/tracker/company-lists/{listId}/signals

### Parameters
#### Path Parameters
- **listId** (string) - Required - The ID of the tracker list

#### Query Parameters
- **apiKey** (string) - Required - Fiber API key

### Request Example
{
  "query": {
    "apiKey": "string"
  },
  "path": {
    "listId": "string"
  }
}

### Response
#### Success Response (200)
- **items** (Array) - List of tracker signal outputs
  - **id** (string) - Signal ID
  - **entityId** (string) - Entity ID
  - **entityType** (string) - 'company' or 'person'
  - **linkedinIdentifier** (string) - LinkedIn identifier
  - **linkedinSlug** (string) - LinkedIn slug
  - **linkedinUrl** (string) - LinkedIn URL
  - **type** (string) - Signal type
  - **description** (string) - Signal description

#### Response Example
{
  "items": [
    {
      "id": "string",
      "entityId": "string",
      "entityType": "company",
      "linkedinIdentifier": "string",
      "linkedinSlug": "string",
      "linkedinUrl": "string",
      "type": "string",
      "description": "string"
    }
  ]
}
```

--------------------------------

### GET /v1/webhooks/endpoints

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Lists all webhook endpoints. This operation is free and does not consume credits.

```APIDOC
## GET /v1/webhooks/endpoints

### Description
Lists all webhook endpoints.

### Method
GET

### Endpoint
/v1/webhooks/endpoints

### Authentication
API key in query

### Rate Limit
120/min

### Cost
FREE
```

--------------------------------

### POST /v1/tracker/fire-dummy/{listId}

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-trackers.md

Fires a dummy event for a tracker list. This operation is free and has a rate limit of 120 requests per minute.

```APIDOC
## POST /v1/tracker/fire-dummy/{listId}

### Description
Fires a dummy event for a tracker list.

### Method
POST

### Endpoint
/v1/tracker/fire-dummy/{listId}

### Parameters
#### Path Parameters
- **listId** (string) - Required - ID of the list.

#### Request Body
- **apiKey** (string) - Required - API key for authentication.

### Request Example
{
  "apiKey": "your-api-key"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the dummy event was fired.

#### Response Example
{
  "success": true
}
```

--------------------------------

### createConfig

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/client.md

Creates a default client configuration object and merges the provided override. It sets sensible defaults for body serialization, headers, parsing, and query serialization.

```APIDOC
## `createConfig`

### Description
Creates a default client configuration object and merges the provided override. It sets sensible defaults for body serialization, headers, parsing, and query serialization.

### Signature
```ts
export const createConfig = <T extends ClientOptions = ClientOptions>(
  override: Config<Omit<ClientOptions, keyof T> & T> = {},
): Config<Omit<ClientOptions, keyof T> & T>
```

### Parameters
- **override** (`Config<Omit<ClientOptions, keyof T> & T>`) - Optional. Configuration overrides to merge with the defaults.

### Returns
- **Config<Omit<ClientOptions, keyof T> & T>** - The merged configuration object.

### Default Configuration
- `bodySerializer`: `JSON.stringify` (bigint-safe)
- `headers`: `{ 'Content-Type': 'application/json' }`
- `parseAs`: `'auto'`
- `querySerializer`: form/explode arrays, deepObject objects, `allowReserved: false`

### Example
```ts
const config = createConfig({ baseUrl: 'https://api.example.com' });
```
```

--------------------------------

### GET /v1/audiences/{audienceId}/status

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-audiences.md

Retrieves the current status of an audience by its ID.

```APIDOC
## GET /v1/audiences/{audienceId}/status

### Description
Retrieves the current status of an audience by its ID.

### Method
GET

### Endpoint
/v1/audiences/{audienceId}/status

### Parameters
#### Path Parameters
- **audienceId** (string) - Required - The ID of the audience

#### Query Parameters
- **apiKey** (string) - Required - Fiber API key

### Response
#### Success Response (200)
- **audienceId** (string) - The ID of the audience
- **name** (string) - The name of the audience
- **status** ('NORMAL' | 'HEALING_COMPANIES' | 'DRAFT' | 'BUILDING' | 'SAVING_COMPANIES' | 'SAVING_PROSPECTS' | 'LINKING_PROSPECTS_WITH_COMPANIES' | 'FAILED') - The current status of the audience
- **creationMethod** ('NORMAL' | 'COMPANY_UPLOAD' | 'PROSPECT_UPLOAD' | 'START_FROM_PROSPECTS' | ...) - How the audience was created

#### Response Example
{
  "audienceId": "aud_123",
  "name": "Series A startups",
  "status": "BUILDING",
  "creationMethod": "NORMAL"
}

```

--------------------------------

### Create and manage job change lists

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-trackers.md

Demonstrates creating a new job change list, adding a profile to it, and listing all existing job change lists using the Fiber AI SDK.

```ts
import { createJobChangeList, addProfilesToList, listAllJobChangeLists } from "@fiberai/sdk";

const list = await createJobChangeList({ body: { apiKey: process.env.FIBERAI_API_KEY!, name: "Target PMs" } });
const id = list.data!.output.jobChangeListId;
await addProfilesToList({
  body: { apiKey: process.env.FIBERAI_API_KEY!, jobChangeListId: id,
          profiles: [{ linkedinUrl: "https://www.linkedin.com/in/example" }] },
});
(await listAllJobChangeLists({ body: { apiKey: process.env.FIBERAI_API_KEY! } }))
  .data?.output.forEach((l) => console.log(l.jobChangeListId, l.name));
```

--------------------------------

### POST /v1/auto-topup/configure

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-account.md

Updates the auto top-up settings. This operation is free and does not consume credits.

```APIDOC
## POST /v1/auto-topup/configure

### Description
Updates the auto top-up settings.

### Method
POST

### Endpoint
/v1/auto-topup/configure

### Authentication
API key in body

### Rate Limit
10/min

### Cost
FREE
```

--------------------------------

### POST /v1/contact-details/exhaustive/poll

Source: https://github.com/fiber-ai/typescript-sdk/blob/main/_autodocs/api-reference/operations-enrichment.md

Polls the result of an exhaustive contact enrichment job that was started asynchronously.

```APIDOC
## POST /v1/contact-details/exhaustive/poll

### Description
Polls the result of an exhaustive contact enrichment job that was started asynchronously.

### Method
POST

### Endpoint
/v1/contact-details/exhaustive/poll

### Parameters
#### Request Body
- **jobId** (string) - Required - The identifier of the job to poll.

### Response
#### Success Response (200)
- **status** (string) - The status of the job (e.g., completed, pending).
- **email** (string) - The revealed email address, if available.
- **phone** (string) - The revealed phone number, if available.

#### Response Example
{
  "status": "completed",
  "email": "john.doe@example.com",
  "phone": "+1234567890"
}
```
Tokens:
Raw