@abliteration/sdk 0.1.0 → 0.1.2

package/docs/AuthorDetail.md

@@ -0,0 +1,46 @@
+
+# AuthorDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`total_models` | number
+`total_downloads` | number
+`total_likes` | number
+`first_seen_at` | string
+`models` | [Array<ModelSummary>](ModelSummary.md)
+
+## Example
+
+```typescript
+import type { AuthorDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "total_models": null,
+  "total_downloads": null,
+  "total_likes": null,
+  "first_seen_at": null,
+  "models": null,
+} satisfies AuthorDetail
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as AuthorDetail
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/AuthorsApi.md

@@ -0,0 +1,167 @@
+# AuthorsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAuthor**](AuthorsApi.md#getauthor) | **GET** /api/v1/authors/{id} | Get one author |
+| [**listAuthors**](AuthorsApi.md#listauthors) | **GET** /api/v1/authors | List authors |
+
+
+
+## getAuthor
+
+> GetAuthor200Response getAuthor(id)
+
+Get one author
+
+Cost: 1 credit.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthorsApi,
+} from '@abliteration/sdk';
+import type { GetAuthorRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuthorsApi(config);
+
+  const body = {
+    // string
+    id: mlabonne,
+  } satisfies GetAuthorRequest;
+
+  try {
+    const data = await api.getAuthor(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetAuthor200Response**](GetAuthor200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Author totals plus their top models. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **404** | No such entity. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listAuthors
+
+> ListAuthors200Response listAuthors(sort, limit, offset)
+
+List authors
+
+Cost: 5-15 credits, by rows returned.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthorsApi,
+} from '@abliteration/sdk';
+import type { ListAuthorsRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new AuthorsApi(config);
+
+  const body = {
+    // 'total_downloads' | '-total_downloads' | 'downloads' | '-downloads' | 'total_models' | '-total_models' | 'models' | '-models' | 'total_likes' | '-total_likes' | 'likes' | '-likes' | Bare key is DESC (largest first); a leading `-` flips to ASC. Aliases: `downloads` == `total_downloads`, `models` == `total_models`, `likes` == `total_likes`. (optional)
+    sort: sort_example,
+    // number | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. (optional)
+    limit: 56,
+    // number | Rows to skip. Negative and non-numeric values are treated as 0. (optional)
+    offset: 56,
+  } satisfies ListAuthorsRequest;
+
+  try {
+    const data = await api.listAuthors(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **sort** | `total_downloads`, `-total_downloads`, `downloads`, `-downloads`, `total_models`, `-total_models`, `models`, `-models`, `total_likes`, `-total_likes`, `likes`, `-likes` | Bare key is DESC (largest first); a leading `-` flips to ASC. Aliases: `downloads` == `total_downloads`, `models` == `total_models`, `likes` == `total_likes`. | [Optional] [Defaults to `'total_downloads'`] [Enum: total_downloads, -total_downloads, downloads, -downloads, total_models, -total_models, models, -models, total_likes, -total_likes, likes, -likes] |
+| **limit** | `number` | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | Rows to skip. Negative and non-numeric values are treated as 0. | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**ListAuthors200Response**](ListAuthors200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Authors with aggregate totals. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/DaiPoint.md

@@ -0,0 +1,38 @@
+
+# DaiPoint
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`month` | string
+`weighted_dai_pct` | number
+`bases_included` | number
+
+## Example
+
+```typescript
+import type { DaiPoint } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "month": 2026-09,
+  "weighted_dai_pct": null,
+  "bases_included": null,
+} satisfies DaiPoint
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DaiPoint
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Dataset.md

@@ -0,0 +1,76 @@
+
+# Dataset
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`slug` | string
+`category` | string
+`license` | string
+`language` | string
+`downloads` | number
+`downloads_all` | number
+`likes` | number
+`trending_score` | number
+`gated` | number
+`main_size_bytes` | number
+`size_display` | string
+`age_days` | number
+`is_trending` | number
+`just_added` | number
+`description` | string
+`tags` | Array<string>
+`hf_url` | string
+`created_at` | string
+`last_modified_at` | string
+`first_seen_at` | string
+
+## Example
+
+```typescript
+import type { Dataset } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "slug": null,
+  "category": null,
+  "license": null,
+  "language": null,
+  "downloads": null,
+  "downloads_all": null,
+  "likes": null,
+  "trending_score": null,
+  "gated": null,
+  "main_size_bytes": null,
+  "size_display": null,
+  "age_days": null,
+  "is_trending": null,
+  "just_added": null,
+  "description": null,
+  "tags": null,
+  "hf_url": null,
+  "created_at": null,
+  "last_modified_at": null,
+  "first_seen_at": null,
+} satisfies Dataset
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Dataset
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DatasetDetail.md

@@ -0,0 +1,80 @@
+
+# DatasetDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`slug` | string
+`category` | string
+`license` | string
+`language` | string
+`downloads` | number
+`downloads_all` | number
+`likes` | number
+`trending_score` | number
+`gated` | number
+`main_size_bytes` | number
+`size_display` | string
+`age_days` | number
+`is_trending` | number
+`just_added` | number
+`description` | string
+`tags` | Array<string>
+`hf_url` | string
+`created_at` | string
+`last_modified_at` | string
+`first_seen_at` | string
+`files` | Array<object>
+`passport` | [Passport](Passport.md)
+
+## Example
+
+```typescript
+import type { DatasetDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "slug": null,
+  "category": null,
+  "license": null,
+  "language": null,
+  "downloads": null,
+  "downloads_all": null,
+  "likes": null,
+  "trending_score": null,
+  "gated": null,
+  "main_size_bytes": null,
+  "size_display": null,
+  "age_days": null,
+  "is_trending": null,
+  "just_added": null,
+  "description": null,
+  "tags": null,
+  "hf_url": null,
+  "created_at": null,
+  "last_modified_at": null,
+  "first_seen_at": null,
+  "files": null,
+  "passport": null,
+} satisfies DatasetDetail
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DatasetDetail
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DatasetsApi.md

@@ -0,0 +1,176 @@
+# DatasetsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getDataset**](DatasetsApi.md#getdataset) | **GET** /api/v1/datasets/{id} | Get one dataset |
+| [**listDatasets**](DatasetsApi.md#listdatasets) | **GET** /api/v1/datasets | List datasets |
+
+
+
+## getDataset
+
+> GetDataset200Response getDataset(id)
+
+Get one dataset
+
+Cost: 1 credit. The passport is null for datasets that do not have one yet.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatasetsApi,
+} from '@abliteration/sdk';
+import type { GetDatasetRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DatasetsApi(config);
+
+  const body = {
+    // string
+    id: mlabonne/orpo-dpo-mix-40k,
+  } satisfies GetDatasetRequest;
+
+  try {
+    const data = await api.getDataset(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetDataset200Response**](GetDataset200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Dataset with files and passport. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **404** | No such entity. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDatasets
+
+> ListDatasets200Response listDatasets(category, author, license, sort, limit, offset)
+
+List datasets
+
+Cost: 5-15 credits, by rows returned.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatasetsApi,
+} from '@abliteration/sdk';
+import type { ListDatasetsRequest } from '@abliteration/sdk';
+
+async function example() {
+  console.log("🚀 Testing @abliteration/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DatasetsApi(config);
+
+  const body = {
+    // string | Workflow stage, for example heal or extract. (optional)
+    category: category_example,
+    // string | Publisher handle, case-insensitive. (optional)
+    author: author_example,
+    // string | License string as published. (optional)
+    license: license_example,
+    // 'downloads' | '-downloads' | 'likes' | '-likes' | 'created' | '-created' | 'created_at' | '-created_at' | 'first_seen' | '-first_seen' | 'first_seen_at' | '-first_seen_at' | Bare key is the natural direction (downloads/likes = most first, dates = newest first). A leading `-` flips it. `created` and `first_seen` are aliases for the full column names. (optional)
+    sort: sort_example,
+    // number | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. (optional)
+    limit: 56,
+    // number | Rows to skip. Negative and non-numeric values are treated as 0. (optional)
+    offset: 56,
+  } satisfies ListDatasetsRequest;
+
+  try {
+    const data = await api.listDatasets(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **category** | `string` | Workflow stage, for example heal or extract. | [Optional] [Defaults to `undefined`] |
+| **author** | `string` | Publisher handle, case-insensitive. | [Optional] [Defaults to `undefined`] |
+| **license** | `string` | License string as published. | [Optional] [Defaults to `undefined`] |
+| **sort** | `downloads`, `-downloads`, `likes`, `-likes`, `created`, `-created`, `created_at`, `-created_at`, `first_seen`, `-first_seen`, `first_seen_at`, `-first_seen_at` | Bare key is the natural direction (downloads/likes = most first, dates = newest first). A leading `-` flips it. `created` and `first_seen` are aliases for the full column names. | [Optional] [Defaults to `'downloads'`] [Enum: downloads, -downloads, likes, -likes, created, -created, created_at, -created_at, first_seen, -first_seen, first_seen_at, -first_seen_at] |
+| **limit** | `number` | Rows to return, 1 to 1000. Values outside the range are clamped, not rejected. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | Rows to skip. Negative and non-numeric values are treated as 0. | [Optional] [Defaults to `0`] |
+
+### Return type
+
+[**ListDatasets200Response**](ListDatasets200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Matching datasets. |  -  |
+| **401** | Missing, unknown or revoked key. |  -  |
+| **402** | Not enough credits. Only possible while metering is enabled. |  -  |
+| **429** | Per-key rate limit exceeded. Retry-After header is set. |  -  |
+| **503** | Catalog temporarily unreadable. Nothing was charged. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/Envelope.md

@@ -0,0 +1,48 @@
+
+# Envelope
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | any
+`cost` | number
+`credits_remaining` | number
+`rate_limit_limit` | number
+`rate_limit_remaining` | number
+`rate_limit_reset` | number
+`metering` | string
+`request_id` | string
+
+## Example
+
+```typescript
+import type { Envelope } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "cost": null,
+  "credits_remaining": null,
+  "rate_limit_limit": null,
+  "rate_limit_remaining": null,
+  "rate_limit_reset": null,
+  "metering": null,
+  "request_id": null,
+} satisfies Envelope
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Envelope
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Event.md

@@ -0,0 +1,46 @@
+
+# Event
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`date` | string
+`date_precision` | string
+`type` | string
+`title` | string
+`description` | string
+`primary_source_url` | string
+
+## Example
+
+```typescript
+import type { Event } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "date": null,
+  "date_precision": null,
+  "type": null,
+  "title": null,
+  "description": null,
+  "primary_source_url": null,
+} satisfies Event
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Event
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+