AI agents

Building Factorial integrations with an AI coding agent (Claude Code, Codex, Cursor, etc.)? Install the factorial-api-sdks skill so the agent knows the SDKs cold: correct method for every endpoint, typed webhook catalog, auth and pagination patterns. No copy-pasting docs into prompts.

What it is

An Agents Skill that teaches agents how to use the Factorial SDKs. It ships separately from the npm and PyPI packages, so installing it never touches your app dependencies. It works with the TypeScript and Python SDKs alike.

Install

npx skills add factorialco/factorial-api-sdks --skill factorial-api-sdks

Run this in your project. The agent picks up the skill automatically when you ask it to work with the Factorial API.

What the agent gets

  • Endpoint → SDK-call index — every API endpoint mapped to the exact SDK method, so the agent calls client.timeoff.leaves.create(...) instead of inventing an HTTP request.
  • Typed webhook catalog — all events with their payload types, ready to wire up handlers.
  • Conventions baked in — auth (apiKey vs token), cursor pagination (list / paginate / all), and how SDK versions track dated API versions.

The reference content is regenerated on every SDK release, so it never drifts from the version of the SDK you have installed.

When to use it

Install it at the start of any project where an AI agent will touch the Factorial API. It pays off most when building integrations, wiring webhooks, or exploring endpoints you haven't used before.


New to the SDKs themselves? Start with the SDKs page. Source and issues: github.com/factorialco/factorial-api-sdks.