How to connect an API
Describe what you need
Tell the agent what API you want to use and what it should do:If you have the API docs, share the link so the agent can read them:
Add your API key
If the API requires authentication, store your key in Project Settings > Saved Secrets.
- Go to Project Settings > Saved Secrets
- Click Add a new secret
- Use the name the agent tells you (it needs to match exactly)
- Paste your API key
Not all APIs require keys. Many public APIs work without credentials.
Examples
Troubleshooting
If your API integration isn’t working:- Check that your API key is correct and active in Saved Secrets
- Make sure you haven’t exceeded the API’s rate limits
- Verify you’re using the right endpoints (share the API docs with the agent if needed)
- Describe the error to the agent and it will help fix it