Build and connect
Connect Alloy through APIs
Use API access to upload knowledge, manage storage, trigger workflows, and connect external products or backend systems to Alloy.
When to use API access
Use API access when work starts outside the Alloy app. A product event, backend job, customer action, or internal system can send data into Alloy and start the right process.
Common examples include uploading files to organization storage, creating folders, moving or renaming files, downloading stored files, or triggering a workflow from another system.
Private organization API
Alloy's private API is scoped to an organization and uses an organization private API key in the `api-key` header.
The current private API includes storage routes and workflow trigger routes. Storage routes can list folders, upload files, read metadata, download files, create folders, rename, move, and delete files or folders. Trigger routes can start a workflow by workflow ID with a JSON payload.
AI teammate API channel
AI teammates can also be configured with the `API` channel. When an AI teammate uses this channel, the AI teammate's detail page includes an API tab with an endpoint, request examples, a built-in request tester, and request logs filtered from workflow runs.
Use this when a specific AI teammate needs to be callable from another product or backend process.
Important behavior to know
Private storage uploads currently allow files up to 10 MB. If a file with the same name already exists at the target path, the upload overwrites it.
Workflow triggers return a run ID when the workflow starts successfully. If the workflow is missing or does not have a configured starting step, the API returns an error instead of starting work.
Frequently asked questions
Does the private API use bearer tokens?+
Not currently. The private API uses the raw organization private API key in the `api-key` header.
Can the API trigger workflows?+
Yes. The private trigger route can start a workflow by workflow ID and pass a JSON payload into the run.
Can an AI teammate have its own API endpoint?+
Yes. AI teammates using the `API` channel show an API tab with endpoint details, examples, a tester, and request logs.