How to get complete TypeScript client for Airbyte Cloud API?

Slack Knowledge Base Q&A API, Terraform and Other Topics
, , , ,
1

Summary

The user is trying to get a TypeScript client that works with the Cloud API. They have used fragments of the API but are unsure how to get the complete API with servers that include the hosted Cloud service or how to control the servers. They are also asking if they should generate multiple clients using different API references.


Question

:wave: community, I ask this question https://airbytehq.slack.com/archives/C01AHCD885S/p1715186106745739 and the AI doesn’t know.

I’m trying to get a TypeScript client that works with the Cloud API. I’ve used npx api install "@airbyte-api/v1#3985sslrl7f7la", but those seem to be fragments of the API. How can I get the complete API with a servers that includes the hosted Cloud service, or how can I control the servers?

OR, should I be generating multiple clients, one using the npx api install ??? of each page in the API reference documentation? For example, run npx api install "@airbyte-api/v1#3985sslrl7f7la" and call that one @api/airbyte-api-workspaces; run npx api install "@airbyte-api/v1#ggq35loywl8vx" and call that one @api/airbyte-api-connections, etc.?


This topic has been created from a Slack thread to give it more visibility.
It will be on Read-Only mode here. Click here if you want to access the original thread.

Join the conversation on Slack

["typescript-client", "cloud-api", "npx-api-install", "complete-api", "servers", "api-reference-documentation"]
2

I’ve taken this approach for now:

npx api install -i 'airbyte-sources' "@airbyte-api/v1#1phak1ulrl7djj4"```
However, I don't think it's satisfactory because I'd like to have a single client library and change the server so I can run against a local deployment as well as the Cloud service.
3

I’m thinking I need to download and store this and change the servers entry. Is that the intent?

<https://raw.githubusercontent.com/airbytehq/airbyte-platform/main/airbyte-api/src/main/openapi/api.yaml>
There are multiple files in https://github.com/airbytehq/airbyte-platform/tree/main/airbyte-api/src/main/openapi, they have different servers entries, and they aren’t the ones that come in these "@airbyte-api/v1#3985sslrl7f7la" values.