FreeAgent + OpenAI Dots

Build a FreeAgent reader with OpenAI Dots Prepare a grounded billing review briefing

Use OpenAI Dots to build a separate read-only FreeAgent assistant with Agent200. Ground the billing review briefing in returned source data.

On this page
  1. Overview
  2. Before you start
  3. Setup steps
  4. Test your connection
  5. Instructions for AI agents
  6. FreeAgent tools
  7. How it works
  8. Troubleshooting
  9. FAQ

Overview

Build a separate billing review briefing application with Agent200. Use the runtime’s real schemas and preserve the authenticated user. This is an architecture guide, not a native installation in OpenAI Dots.

Start with one identified invoice. Preserve returned invoice, contact, status and amount fields; report missing data and keep the workflow read-only.

Provider reference: FreeAgent API.

Connector
FreeAgent
Works with
OpenAI Dots · Your own agent code
Authentication
Managed OAuth, per end user
Tools
5 tools
Model in examples
openai/gpt-5.6-sol

Before you start

  • An Agent200 API key. Create one on the API keys page of the dashboard.
  • FreeAgent enabled for your project. In the dashboard's Connectors settings, with the endpoints and scopes your agent needs.
  • An end user with a FreeAgent account. They approve access once, on FreeAgent's own page.
  • A model for your agent. The examples use openai/gpt-5.6-sol, through the same Agent200 API key.

Connect FreeAgent to OpenAI Dots

  1. 1

    Step 1: Create your Agent200 API key

    Create a key on the API keys page and store it securely.

    .env
    Conceptual example
    Store the Agent200 API key as an environment variable
    # Keep the key out of your code, prompts and chats.
    export AGENT200_API_KEY="paste-your-key-here"
  2. 2

    Step 2: Inspect the real tool definitions

    Confirm the actual FreeAgent read operations and input schemas in your runtime.

  3. 3

    Step 3: Connect the user’s FreeAgent account

    Preserve the same stable user identity during authorization and later requests.

    connect.js
    Conceptual example
    Let an end user connect their account (managed OAuth)
    // Each end user authorizes their own FreeAgent account, once.
    const connection = await agent200
      .user("user_123")
      .connect("freeagent");
    
    if (connection.authorizationUrl) {
      // Show this link to your user; Agent200 handles the rest.
      console.log(connection.authorizationUrl);
    }
  4. 4

    Step 4: Build and test the read-only answer

    Prepare the billing review briefing only from returned source data. The code example illustrates a sequence, not an SDK installation contract.

    run.js
    Conceptual example
    Run a request with the connector's tools
    const result = await agent200
      .user("user_123")
      .run({
        model: "openai/gpt-5.6-sol",
        input: "Which FreeAgent invoices are still unpaid",
        tools: ["freeagent"],
      });
    
    console.log(result.output);

Test your connection

Run one request to check everything is wired up.

Ask

Read the FreeAgent invoice I identify and prepare a billing review briefing. Name the source and use only invoice, contact, status and amount fields. State access gaps; do not change records.

What should come back

  • The selected invoice is identified.
  • Only the returned invoice, contact, status and amount fields are reported.
  • Access gaps and missing context are explicit; no source data is changed.

Check the selected invoice ID, account scope, read permission and pagination. Sandbox records are test data. Do not present a sandbox result as production revenue or an invoice status as a bank reconciliation.

Get your API key

Create a key in the Agent200 dashboard. It reaches FreeAgent and every other connector enabled for your project.

Read the SDK docs

Instructions for AI agents

Using a coding agent? Paste this brief into it, or give it the address of this page. It lists what to do, in order, to connect FreeAgent to OpenAI Dots.

Agent brief
Goal: connect FreeAgent to OpenAI Dots with Agent200.
Guide: https://www.agent200.com/connectors/freeagent/framework/openai-dots/

1. Get an Agent200 API key. If the developer has none, send them to https://agent200.com/platform/apikeys/ and ask them to choose "Create an API key". Read the key from the AGENT200_API_KEY environment variable. Never ask for it in chat, and never write it into code, prompts or logs.
2. Make sure FreeAgent is enabled for the project in the Agent200 dashboard (Connectors), with the endpoints and scopes the task needs.
3. Add the Agent200 SDK to the project and create a client with that key.
4. Give every request a stable id for the end user. Agent200 uses only that user's own connections.
5. Connect the user's FreeAgent account through Agent200. If Agent200 returns an authorization link, show it to the user and continue once they have approved access on FreeAgent.
6. Run requests through Agent200 with a model (for example openai/gpt-5.6-sol) and "freeagent" in the tools. The model decides when a FreeAgent tool is needed; Agent200 executes the call.
7. Check it works with this request: "Read the FreeAgent invoice I identify and prepare a billing review briefing. Name the source and use only invoice, contact, status and amount fields. State access gaps; do not change records."
   What should come back:
   - The selected invoice is identified.
   - Only the returned invoice, contact, status and amount fields are reported.
   - Access gaps and missing context are explicit; no source data is changed.
8. If a tool is missing or a call is refused, check the project's Connectors settings in the dashboard and the access the user granted in FreeAgent, then retry.

The code on the guide page is a conceptual example of the SDK. SDK reference: https://docs.igpt.ai/

The whole guide is also available as Markdown, for agents and LLMs: /connectors/freeagent/framework/openai-dots.md

FreeAgent tools OpenAI Dots can call

  • List invoices

    Read
    freeagent_list_invoices

    Find invoices in the authorized FreeAgent account.

  • Read an invoice

    Read
    freeagent_get_invoice

    Retrieve one invoice by its resource URL.

  • List contacts

    Read
    freeagent_list_contacts

    Find available contact records.

  • Read a contact

    Read
    freeagent_get_contact

    Retrieve one identified contact.

  • List expenses

    Read
    freeagent_list_expenses

    Review recorded expenses in scope.

How it works

  1. 01

    Your app sends the request

    It calls Agent200 with the model, instructions, the input, the end user's id and the FreeAgent tools.

  2. 02

    The model picks a tool

    The model decides whether a FreeAgent tool is needed, and with which arguments.

  3. 03

    Agent200 runs the call

    It uses that user's own FreeAgent connection, within the endpoints and scopes your project allows, and returns the result to the model.

  4. 04

    Your app gets the result

    Agent200 returns the completed result. Your app decides when the agent runs and what happens next.

Each user's own connection. Connections belong to individual end users. A request for one user never reaches another user's FreeAgent account.

Permissions at every level. Your project settings decide what the agent may request, the end user decides what they authorize, and FreeAgent enforces what its API grants.

Troubleshooting

The source cannot be read

Check the selected invoice ID, account scope, read permission and pagination. Sandbox records are test data. Do not present a sandbox result as production revenue or an invoice status as a bank reconciliation.

FAQ

How do I verify this result?

Compare the named invoice and returned invoice, contact, status and amount fields with the source. Treat missing information as missing, not as a fact.

Is this a native product integration?

This describes a separate application built with Agent200 and OpenAI Dots; it does not install a connector into the OpenAI Dots app.

Use FreeAgent with another framework

200 OK

FreeAgent, connected to OpenAI Dots.
One SDK. One API key.

Agent200 handles the OAuth, the tokens and every tool call. You keep your agent, your model and your code.

Book a demo.
See it in action.

Tell us who you are, then pick a time for a 1:1 session with an expert from our team.

We use your details only to email you about Agent200. See the Privacy Policy.

Pick a time. We'll take it from there.

A 1:1 session with an expert from our team, about what you are building.

Open in Calendly (opens in a new tab)