Alfa API
Articles to help you integrate and use our API effectively.
Articles
- How do I run a workplan to produce a report?
- After creating a workplan, how do I know it's ready?
- How do I upload and manage custom datasets?
- What is a "workplan" vs a "report"?
- How do I upload custom documents for analysis?
- How reproducible are report results across multiple runs?
- Can workplans be scheduled or automated?
- Are threads suitable for complex analysis or automation?
- What happens if a workplan references a deleted dataset or document?
- Can I delete a workplan, and what happens to associated reports?
- How large can document uploads be, and how does ALFA handle them?
- How do I retrieve report results for downstream processing?
- What are the status values for reports, and what do they mean?
- Is there a sample IPYNB (Jupyter Notebook) that walks through each of the ALFA “Tool Calls” for a single-security workflow?
- How do I list all workplans and their metadata?
- How do I edit or manage an existing workplan?
- Are there limitations or edge cases I should be aware of?
- Can workplans call other workplans?
- What are the daily, monthly, concurrent, or other rate limits for the ALFA APIs?
- How do I use threads instead of workplans, and when should I?
- How can I track token usage?
- Can workplans combine multiple data sources such as documents and datasets?
- How do I retrieve tables, charts, or artifacts created in threads?
- What are tool calls, and why are they important?
- Can I cancel a running report, and why would I?
- How do I create my first workplan?