Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/jasper-ts
A typescript SDK for accessing the jasper-ts API.
https://github.com/speakeasy-sdks/jasper-ts
ai api jasper sdk typescript
Last synced: 1 day ago
JSON representation
A typescript SDK for accessing the jasper-ts API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/jasper-ts
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-04-12T10:05:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:20:01.000Z (7 months ago)
- Last Synced: 2024-09-06T11:59:11.201Z (2 months ago)
- Topics: ai, api, jasper, sdk, typescript
- Language: TypeScript
- Homepage: https://developers.jasper.ai/docs/getting-started-1
- Size: 46.9 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Jasper Typescript SDK
AI content generator for teams
## SDK Installation
### NPM
```bash
npm add @speakeasy-sdks/jasper-ai
```
### Yarn
```bash
yarn add @speakeasy-sdks/jasper-ai
```
## Authentication
In order to use Jasper's API, you will need to authenticate every request. We rely on API tokens to authenticate API requests.
Tokens are scoped to an admin's permission set and workspace.
Admins can generate API tokens in their workspace via [Settings/API tokens](https://beta.jasper.ai/settings/tokens)
Once your API token is generated, you will need to pass it in an 'x-api-key' Authorization header.
```bash
curl
--location --request GET 'https://api.jasper.ai/v1/$endpoint' \
--header 'x-api-key: $YOUR_API_KEY' \
```
## SDK Example Usage
```typescript
import { Jasper } from "@speakeasy-sdks/jasper-ai";
import { RunCommandResponse } from "@speakeasy-sdks/jasper-ai/dist/sdk/models/operations";
const sdk = new Jasper({
security: {
apiKeyAuth: "YOUR_API_KEY_HERE",
},
});
sdk.commands.run({
inputs: {
command: "Write a haiku about rabbits",
context: "All rabbits eat kale",
},
options: {
inputLanguage: "corrupti",
languageFormality: "provident",
outputCount: 715190,
outputLanguage: "quibusdam",
},
}).then((res: RunCommandResponse) => {
if (res.statusCode == 200) {
// handle response
}
});
```
## Available Resources and Operations
### [commands](docs/commands/README.md)
* [run](docs/commands/README.md#run) - Run a command to generate an AI Output
### [templates](docs/templates/README.md)
* [get](docs/templates/README.md#get) - Retrieve an individual default or custom template available in your workspace by ID
* [list](docs/templates/README.md#list) - Get a list of available templates
* [run](docs/templates/README.md#run) - Run a default template or custom template by ID to generate an AI output. See our guide on Using Templates for tips on getting started.
### Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
### Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)