Agents

Create a company headcount growth over baseline agent

Creates a Headcount growth over baseline agent (company-headcount-growth-over-baseline). Delivers companies that grew companyHeadcountGrowthFromBaseline percent over baselineHeadcount within timeframe. With start: false (the default) a DRAFT is saved — status initializing, nothing billed: read it back with GET /business/agents/{agentId}, adjust it with PATCH /business/agents/{agentId}, then start it with POST /business/agents/{agentId}/activate. With start: true the agent is created AND started in one call: its dedicated results list is created, credits are checked and spent, and the provider subscriptions are set up. Either way the answer is 201 { agent: { id, type, name, status, started } } — the same shape for every agent kind, draft or started. Poll GET /business/agents for status and contactsFound, and read the delivered rows with the Lists endpoints via the agent's listId. Free-plan accounts hold at most 10 agents, drafts included (403 AGENT_LIMIT_REACHED). Every field below is validated by the agents service: a rejected field answers 422 VALIDATION_FAILED, naming it in param and describing every failure in message. listName must not collide with an existing list or agent name (409 LIST_NAME_TAKEN), and starting without enough credits answers 402 INSUFFICIENT_CREDITS without creating anything.

Errors:

  • 422 VALIDATION_FAILED — The request was rejected by validation. Either this endpoint's own request validation (a malformed body), or the agent config itself: a field missing, out of range or not one of the accepted values, or a business rule broken (an expirationDate that is not in the future, more industries than the kind accepts, a notification count out of range). param names the first offending field and message lists every failure.
  • 409 LIST_NAME_TAKEN — listName is already used by one of your lists or agents. Pick another name.
  • 402 INSUFFICIENT_CREDITS — The workspace does not have enough credits to start this agent. Nothing was created or spent.
  • 403 AGENT_LIMIT_REACHED — Free-plan accounts may hold at most 10 agents, drafts included. Delete an agent or upgrade the plan.
  • 400 INVALID_REQUEST — The agents service rejected the request for a reason this API does not model specifically. The request is not retryable unchanged.
  • 429 RATE_LIMITED — The agents bucket is exhausted: 30 requests per minute or 2,000 per day per token owner, shared by every /business/agents operation (a 429 raised by the agents service is relayed with this code too). Retry after the Retry-After header.
  • 500 UNEXPECTED_ERROR — The agents service failed (5xx, refused service credential, or a timeout after 60s) or the rate limiter was unavailable. Retry later; quote request_id to support.

Requires one of the following token scopes: agents.

post/business/agents/company-headcount-growth-over-baseline

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/agents/company-headcount-growth-over-baseline
  • Auth: HTTP basic

Request body

startboolean

true creates AND activates the agent (spends credits); false (default) saves a draft to activate later.

listNamestring required

Name for BOTH the agent and the results list it creates. Must be unique across your agents: a name already in use is rejected with 409 LIST_NAME_TAKEN.

regionsstring[] required

Headquarters location of the company, as a LinkedIn geography: either a country ("United States") or a sub-national area ("California, United States"). Use exact values from GET /business/agents/autocomplete?field=region. The upstream stores the string as sent and never checks it against a list, so any other value is accepted, the create still answers 201, and the agent then silently matches nothing. Exactly one value is allowed here (min 1, max 1); to cover several, run one agent per value.

timeframestring[] required

The interval the growth is measured over. Use one of exactly: YoY, MoM, QoQ, 6M, 2Y. Long forms are also accepted, case-insensitively, and normalised before the provider call ("year over year" and "12 months" become YoY, "month over month" MoM, "quarter over quarter" QoQ, "6 months" 6M, "2 years" 2Y); anything else is passed through unchanged and rejected by the provider. Exactly one value is allowed (min 1, max 1).

industriesstring[] required

Industry of the company. Use exact values from GET /business/agents/autocomplete?field=industry (for example "Software Development", "Financial Services"). Any other wording is first resolved to the closest supported LinkedIn industry ("tech" becomes "Technology, Information and Internet"), and a value with no match is dropped rather than rejected, so the filter silently widens instead of failing. Exactly one value is allowed here (min 1, max 1); to cover several, run one agent per value.

baselineHeadcountnumber[] required

The historical headcount to measure growth from: an absolute employee count, not a percentage, for example [75] or [1000]. Exactly one number is allowed (min 1, max 1); a second entry is rejected with 422 VALIDATION_FAILED.

companyHeadcountGrowthFromBaselinenumber[] required

The growth over baselineHeadcount that triggers a match, in PERCENT: [25] means the headcount has to be 25% above the baseline. Exactly one number is allowed (min 1, max 1); a second entry is rejected with 422 VALIDATION_FAILED.

expirationDatestring nullable

Date the agent stops running, as YYYY-MM-DD (for example "2026-12-31"), and in the future. Pass null to run until you pause or delete it; omit it for the default of one month from creation.

maxContactsinteger

Cap on the total number of results this agent delivers into its list. Omit for no cap.

maxCreditSpendinteger

Maximum credits this agent may spend in a single run or refresh (1000 to 200000); delivery-driven monitors stop once their total delivered results reach it. Omit for no limit.

notificationCountinteger

Maximum results the agent may deliver in a single run. Must be a positive multiple of 50.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.