IMPORTANT: Your IT Admin needs to allowlist “api.halcyon.io” within the settings of your Enterprise/Teams AI assistant before you complete the steps below. Read this article for guidance.
Keep your key safe: Each route below saves your key as a plain-text file so your assistant can read it. Anything with access to that folder can read the key too. When you’re done with a project, delete the file and delete the key on the API Keys page.
Claude
Cowork
This route gives Claude Cowork a folder on your computer that holds your Halcyon API key and the API spec.
- Create an API key in Halcyon. Log in, click your avatar in the top right, and go to API keys → Create API key. Give it a name you’ll recognize and press Create Key.
- Copy the key. This is the only time the key will appear. Click Copy key, and keep it somewhere safe, like a password manager or a secrets manager.
- Create a folder on your desktop. This is where your API key and API docs live for Claude Cowork to read.
- Save the key as plain text. Open TextEdit (Mac) or NotePad (Windows), paste the key into a new document. (If you’re on Mac/TextEdit, choose Format → Make Plain Text. A rich-text file would wrap the key in formatting and it wouldn’t work.) Name it something you’ll remember and save it to the new folder.
- Download the API spec. Go to api.halcyon.io, press Download OpenAPI Document → json, and move the file into the same folder.
- Test the connection. Instruct Claude to read from the folder on your desktop and ping the Halcyon API.
- Start working. You’re connected. Use Claude to interact with Halcyon’s platform and plug its data directly into your workflows. Each link cites filings directly from Halcyon; follow them for quick verification. Try some sample prompts here.
You can disable or delete your key at any time. We recommend periodically rotating API keys as a security best practice.
Watch the interactive guide below:
Code
This route gives Claude Code a folder on your computer that holds your Halcyon API key and the API spec.
- Create an API key in Halcyon. Log in, click your avatar in the top right, and go to API keys → Create API key. Give it a name you’ll recognize and press Create Key.
- Copy the key. This is the only time the key will appear. Click Copy key, and keep it somewhere safe, like a password manager or a secrets manager.
- Create a folder on your desktop. This is where your API key and API docs live for Claude Code to read.
- Save the key as plain text. Open TextEdit (Mac) or NotePad (Windows), paste the key into a new document. (If you’re on Mac/TextEdit, choose Format → Make Plain Text. A rich-text file would wrap the key in formatting and it wouldn’t work.) Name it something you’ll remember and save it to the new folder.
- Download the API spec. Go to api.halcyon.io, press Download OpenAPI Document → json, and move the file into the same folder.
- Test the connection. Toggle to Claude Code, then instruct Claude to read from the folder on your desktop and ping the Halcyon API.
- Start working. You’re connected. Use Claude to interact with Halcyon’s platform and plug its data directly into your workflows. Try some sample prompts here.
You can disable or delete your key at any time. We recommend periodically rotating API keys as a security best practice.
Watch the interactive guide below:
ChatGPT
Work
This route gives ChatGPT Work a folder on your computer that holds your Halcyon API key and the API spec.
- Create an API key in Halcyon. Log in, click your avatar in the top right, and go to API keys → Create API key. Give it a name you’ll recognize and press Create Key.
- Copy the key. This is the only time the key will appear. Click Copy key, and keep it somewhere safe, like a password manager or a secrets manager.
- Create a folder on your desktop. This is where your API key and API docs live for Claude Code to read.
- Save the key as plain text. Open TextEdit (Mac) or NotePad (Windows), paste the key into a new document. (If you’re on Mac/TextEdit, choose Format → Make Plain Text. A rich-text file would wrap the key in formatting and it wouldn’t work.) Name it something you’ll remember and save it to the new folder.
- Download the API spec. Go to api.halcyon.io, press Download OpenAPI Document → json, and move the file into the same folder.
- Test the connection. Toggle to Claude Code, then instruct Claude to read from the folder on your desktop and ping the Halcyon API.
- Start working. You’re connected. Use Claude to interact with Halcyon’s platform and plug its data directly into your workflows. Try some sample prompts here.
You can disable or delete your key at any time. We recommend periodically rotating API keys as a security best practice.
Watch the interactive guide below:
Codex
This route gives GPT Codex a folder on your computer that holds your Halcyon API key and the API spec.
- Create an API key in Halcyon. Log in, click your avatar in the top right, and go to API keys → Create API key. Give it a name you’ll recognize and press Create Key.
- Copy the key. This is the only time the key will appear. Click Copy key, and keep it somewhere safe, like a password manager or a secrets manager.
- Create a folder on your desktop. This is where your API key and API docs live for Claude Cowork to read.
- Save the key as plain text. Open TextEdit (Mac) or NotePad (Windows), paste the key into a new document. (If you’re on Mac/TextEdit, choose Format → Make Plain Text. A rich-text file would wrap the key in formatting and it wouldn’t work.) Name it something you’ll remember and save it to the new folder.
- Download the API spec. Go to api.halcyon.io, press Download OpenAPI Document → json, and move the file into the same folder.
- Test the connection. Instruct Claude to read from the folder on your desktop and ping the Halcyon API.
- Start working. You’re connected. Use Claude to interact with Halcyon’s platform and plug its data directly into your workflows. Each link cites filings directly from Halcyon; follow them for quick verification. Try some sample prompts here.
You can disable or delete your key at any time. We recommend periodically rotating API keys as a security best practice.
Watch the interactive guide below:
Gemini
Task
This route gives Gemini a folder on your computer that holds your Halcyon API key and the API spec.
- Create an API key in Halcyon. Log in, click your avatar in the top right, and go to API keys → Create API key. Give it a name you’ll recognize and press Create Key.
- Copy the key. This is the only time the key will appear. Click Copy key, and keep it somewhere safe, like a password manager or a secrets manager.
- Create a folder on your desktop. This is where your API key and API docs live for Claude Cowork to read.
- Save the key as plain text. Open TextEdit (Mac) or NotePad (Windows), paste the key into a new document. (If you’re on Mac/TextEdit, choose Format → Make Plain Text. A rich-text file would wrap the key in formatting and it wouldn’t work.) Name it something you’ll remember and save it to the new folder.
- Download the API spec. Go to api.halcyon.io, press Download OpenAPI Document → json, and move the file into the same folder.
- Test the connection. Instruct Claude to read from the folder on your desktop and ping the Halcyon API.
- Start working. You’re connected. Use Claude to interact with Halcyon’s platform and plug its data directly into your workflows. Each link cites filings directly from Halcyon; follow them for quick verification. Try some sample prompts here.
You can disable or delete your key at any time. We recommend periodically rotating API keys as a security best practice.
Antigravity
This route gives Google Antigravity a folder on your computer that holds your Halcyon API key and the API spec.
- Create an API key in Halcyon. Log in, click your avatar in the top right, and go to API keys → Create API key. Give it a name you’ll recognize and press Create Key.
- Copy the key. This is the only time the key will appear. Click Copy key, and keep it somewhere safe, like a password manager or a secrets manager.
- Create a folder on your desktop. This is where your API key and API docs live for Claude Cowork to read.
- Save the key as plain text. Open TextEdit (Mac) or NotePad (Windows), paste the key into a new document. (If you’re on Mac/TextEdit, choose Format → Make Plain Text. A rich-text file would wrap the key in formatting and it wouldn’t work.) Name it something you’ll remember and save it to the new folder.
- Download the API spec. Go to api.halcyon.io, press Download OpenAPI Document → json, and move the file into the same folder.
- Test the connection. Instruct Claude to read from the folder on your desktop and ping the Halcyon API.
- Start working. You’re connected. Use Claude to interact with Halcyon’s platform and plug its data directly into your workflows. Each link cites filings directly from Halcyon; follow them for quick verification. Try some sample prompts here.
You can disable or delete your key at any time. We recommend periodically rotating API keys as a security best practice.
