Built in

Any API with a key

Any HTTPS API that takes a key or token in a header, a query parameter or the URL path. Your agent declares it with each value as a Secret; you paste the values after deploy.

What the connection reaches

One to eight values per connection, each a Secret
Headers, query parameters or a URL path segment
Responses that echo a value are refused

Status: Built into the pipeline SDK
Connection class: ApiKeyConnection
Credential: API key or token

Connect Any API with a key

Three steps, the same for every connection. The credential goes to the platform, never into the repository or pipeline code.

Declare it in connections/connections.py

connections/connections.py

from segmentstream.connections import ApiKeyConnection, Bearer, Secret connections = (    ApiKeyConnection(        key="billing",        name="Billing",        provider="billing",        headers={"Authorization": Bearer(Secret(label="API key"))},        apis={"v1": "https://api.billing.example.com/v1/"},    ),)

2
Deploy
```
$ segmentstream deploy
```
3
Connect
Paste the values (from the provider's settings) into the connection in the console, or configure it from the terminal with a hidden prompt. API-key connections need no authorisation step: once the value is set, the connection is connected.
```
$ segmentstream connection configure billing
```

Use it

Code asks for the connection by its key. The platform adds the credential on the way out.

pipeline/ingestion/…

import segmentstream as s with s.get_connection("billing").get_http_client() as client:    response = client.get("/invoices", params={"limit": 100})    response.raise_for_status()

Or ask your agent

“Add our billing provider's API with an API key and load invoices daily.”

Part of these solutions

Internal tools and dashboards

Pages and dashboards on your records and data

More in Any API

Any OAuth 2.0 APIBuilt inAny API with an OAuth 2.0 sign-in.Any API with client credentialsBuilt inServer-to-server APIs with a client ID and secret.

All integrations →

Enterprise pilot

Want Any API with a key set up for you?

Our forward-deployed engineers build one solution on your data, in your own workspace, as code you own. Tell us what you run today and what you want; your note goes straight to our founder.

One solution, on your data, in your own workspace
First version live in two weeks
Parity proven before anything is switched off
Fixed scope and price, credited to your contract if you continue

Not ready for a pilot? Send the form anyway with your question. An engineer will reply, not a sales rep.

How the pilot works

Connect what your company runs.

Start a pilot

Our engineers build the first version on your data in two weeks, at a fixed price.

Or join the waitlist for self-serve:

Self-serve opens to the waitlist first.