Getting started with the API

The Ferrith API lets your own systems do what a person does in the workspace — start a workflow, upload the documents it needs, follow the run as it happens, and collect the result — using an API key issued by a workspace admin. It is available on the Automation plan.

Where the full reference is

The complete, interactive reference — every endpoint, every request and response shape, with "try it" calls against your own workspace — is served by the API itself. Open it from the Interactive API reference link in the sidebar, click Authorize, and paste your key. Because the reference runs on the API's own address, your key never passes through this site.

What you need

• A workspace on the Automation plan.
• An API key, created by a workspace admin under Workspace → API keys. A key is shown once, at creation; it carries a fixed set of scopes and an optional expiry, and it can be revoked at any time.
• The key is sent as a bearer token on every call: Authorization: Bearer fck_EXAMPLE_REPLACE_WITH_YOUR_KEY.

Coming in this section

The step-by-step pages — keys and scopes, your first call, starting and following a run, uploading documents, rendered outputs, using the OpenAI SDK, and the limits and error shapes — are being written against the live API and appear here as each is verified.