Skip to main content
This page collects working configurations for popular services so you can copy one, swap in your own values, and connect it as a REST API source. Each example shows the config.json you’d write, the matching curl request it produces, and the kind of endpoints the agent can then reach. Only the fields shown are required—Synti fills in the rest.
The curl snippets are illustrative: they show the request Synti’s HTTP tool constructs on your behalf. You don’t run them yourself. Your token or key is entered once, encrypted on disk, and attached automatically.

Bearer token

The most common pattern. Services like GitHub, OpenAI, and Stripe accept a token in the Authorization header.
With this in place the agent can list repositories via GET /user/repos, open issues via POST /repos/{owner}/{repo}/issues, and inspect pull requests. Two more bearer examples:

Custom header

Some services expect the key in a header of their own naming. Set authType to header and name it with headerName.

Query parameter

Older services often want the key in the URL. Use authType: "query" and name the parameter with queryParam; Synti appends ?key={api_key} to each request.

Basic authentication

Services like Twilio use a username and password pair—for Twilio, the Account SID and Auth Token.

Controlling the request

When the agent calls an API, it can set the HTTP method, path, query parameters, and body. For anything other than JSON, two special parameters let it send raw content:

Choosing a test endpoint

testEndpoint validates the source right after you connect it. Good choices require authentication, return quickly, and are always available—/user, /me, /health, or a capped list like /items?limit=1. Avoid anything that writes or deletes data, since Synti calls it during validation.
Once connected, run /source reload {slug} to re-test a source after changing its configuration, and /tools -v to confirm the HTTP tool is available.