Octagon

Appearance

Integrate Octagon API with AI Coding Tools ​

This guide explains how to leverage AI Coding Tools like Cursor, Windsurf, Claude Code and others to generate integration code for the Octagon API. Using AI Coding Tools can significantly speed up your development process by quickly scaffolding API integration code tailored to your specific needs.

Using our llms.txt with AI Coding Tools ​

We provide a comprehensive llms.txt file that contains structured information about the Octagon API following the llms.txt standard. This file helps AI Coding Tools understand our API capabilities in detail.

Step 1: Copy the llms.txt Content ​

Copy the entire content of our llms.txt file at the root of our documentation site.

Step 2: Paste into Your AI Coding Tool Conversation ​

Begin your conversation with your AI Coding Tool by pasting the entire content of the llms.txt file and adding a clear instruction about what you want to build. For example:

Using the API documentation below, please help me create Python code to query the Octagon SEC Filings Agent to analyze Apple's latest 10-K filing and extract revenue by product segment for the last 3 years.

[Paste the entire llms.txt file here]

Example Prompts for Code Generation ​

Here are some effective prompts to use with AI Coding Tools for generating Octagon API integration code:

Basic API Integration ​

Based on the Octagon API documentation, generate Python code to authenticate and make a basic request to the SEC Filings Agent to analyze Apple's revenue growth over the past 3 years.

[Paste the entire llms.txt file here]

Multi-Agent Research Workflow ​

Using the Octagon API, create a JavaScript application that first uses the Companies Agent to look up basic information about Tesla, then uses the SEC Filings Agent to extract their R&D expenses over the last 4 quarters, and finally uses the Stock Data Agent to correlate R&D spending with stock performance.

[Paste the entire llms.txt file here]

OpenAI SDK Integration ​

Show me how to integrate Octagon's Transcripts Agent and Financials Agent into an OpenAI Agents SDK workflow that analyzes earnings calls for tech companies and correlates management statements with actual financial performance.

[Paste the entire llms.txt file here]

Web Application Integration ​

Create a React component that uses the Octagon API to search for and display financial data about a company. It should include a search box for the company name and display key metrics from the Financials Agent.

[Paste the entire llms.txt file here]

Why Use AI Coding Tools for API Integration? ​

AI Coding Tools excel at generating code and can help you:

  1. Quickly prototype Octagon API integrations for different use cases
  2. Understand implementation details through generated examples
  3. Troubleshoot errors in your existing implementation
  4. Explore alternative approaches to solve the same problem
  5. Translate code between programming languages (e.g., Python to JavaScript)

Preparing Your AI Coding Tools Session ​

To get the best results when asking an AI Coding Tool to generate Octagon API integration code:

  1. Begin a new conversation specifically for this task
  2. Provide context about what you're trying to build
  3. Share our llms.txt file for detailed API understanding (see below)
  4. Be specific about your requirements (programming language, framework, etc.)

Best Practices for AI Coding Tools-Generated Code ​

While AI Coding Tools can generate functional code, follow these best practices:

  1. Review the generated code thoroughly before implementation
  2. Test all authentication and error handling logic
  3. Sanitize user inputs that will be sent to the API
  4. Store API keys securely using environment variables
  5. Implement proper error handling for API requests
  6. Add appropriate comments to explain complex sections
  7. Validate against the latest documentation as APIs can change

Troubleshooting with AI Coding Tools ​

If you encounter issues with your Octagon API integration, you can also use AI Coding Tools for troubleshooting:

I'm getting the following error when calling the Octagon API: 

[paste error]

Here's my current code: 

[paste code]

Can you help me fix it?

Example Use Cases ​

Here are some common use cases where AI Coding Tools can help generate code:

  1. Financial dashboards displaying company metrics from various Octagon agents
  2. Research report generators that compile insights from multiple agents
  3. Investment screening tools that filter companies based on financial criteria
  4. Earnings analysis applications that process and visualize transcript insights
  5. Competitive analysis tools that compare companies in the same sector
  6. Exit activity tools that analyzes valuation trends in IPOs and M&As
  7. Private debt tools that compile data on private debt and lenders

Next Steps ​