@abliteration/sdk 0.1.0 → 0.1.1

package/docs/MethodsApi.md

@@ -0,0 +1,153 @@
+# MethodsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getMethod**](MethodsApi.md#getmethod) | **GET** /api/v1/methods/{id} | Get one method |
+| [**listMethods**](MethodsApi.md#listmethods) | **GET** /api/v1/methods | List the method taxonomy |
+
+
+
+## getMethod
+
+> GetMethod200Response getMethod(id)
+
+Get one method
+
+Cost: 1 credit.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MethodsApi,
+} from '@abliteration/sdk';
+import type { GetMethodRequest } 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 MethodsApi(config);
+
+  const body = {
+    // 'M1' | 'M2' | 'M3' | 'M4' | 'M5' | 'M5-frankenstein' | 'M6' | 'M7' | 'M8' | 'M-uncensored' | 'unknown'
+    id: id_example,
+  } satisfies GetMethodRequest;
+
+  try {
+    const data = await api.getMethod(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `M1`, `M2`, `M3`, `M4`, `M5`, `M5-frankenstein`, `M6`, `M7`, `M8`, `M-uncensored`, `unknown` |  | [Defaults to `undefined`] [Enum: M1, M2, M3, M4, M5, M5-frankenstein, M6, M7, M8, M-uncensored, unknown] |
+
+### Return type
+
+[**GetMethod200Response**](GetMethod200Response.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** | Method with counts, top authors and sample 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)
+
+
+## listMethods
+
+> ListMethods200Response listMethods()
+
+List the method taxonomy
+
+Cost: 5-15 credits. Every code is returned, including ones with no models.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MethodsApi,
+} from '@abliteration/sdk';
+import type { ListMethodsRequest } 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 MethodsApi(config);
+
+  try {
+    const data = await api.listMethods();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListMethods200Response**](ListMethods200Response.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** | The taxonomy with counts. |  -  |
+| **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/ModelDetail.md

@@ -0,0 +1,45 @@
+
+# ModelDetail
+
+The full catalog record, plus files, benchmarks and an author summary.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`name` | string
+`files` | Array<object>
+`benchmarks` | object
+`author_summary` | [Author](Author.md)
+
+## Example
+
+```typescript
+import type { ModelDetail } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "name": null,
+  "files": null,
+  "benchmarks": null,
+  "author_summary": null,
+} satisfies ModelDetail
+
+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 ModelDetail
+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/ModelError.md

@@ -0,0 +1,42 @@
+
+# ModelError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`message` | string
+`retry_after` | number
+`credits_remaining` | number
+`request_id` | string
+
+## Example
+
+```typescript
+import type { ModelError } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "message": null,
+  "retry_after": null,
+  "credits_remaining": null,
+  "request_id": null,
+} satisfies ModelError
+
+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 ModelError
+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/ModelIndex.md

@@ -0,0 +1,52 @@
+
+# ModelIndex
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`value` | number
+`unit` | string
+`measured` | boolean
+`source` | string
+`history_available` | boolean
+`as_of` | string
+`note` | string
+`recent_history` | [Array<DaiPoint>](DaiPoint.md)
+
+## Example
+
+```typescript
+import type { ModelIndex } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "value": null,
+  "unit": null,
+  "measured": null,
+  "source": null,
+  "history_available": null,
+  "as_of": null,
+  "note": null,
+  "recent_history": null,
+} satisfies ModelIndex
+
+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 ModelIndex
+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/ModelSummary.md

@@ -0,0 +1,58 @@
+
+# ModelSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`author` | string
+`name` | string
+`method` | string
+`confidence` | string
+`family` | string
+`params_b` | number
+`license` | string
+`downloads` | number
+`likes` | number
+`is_gguf` | number
+`created_at` | string
+`first_seen_at` | string
+
+## Example
+
+```typescript
+import type { ModelSummary } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "author": null,
+  "name": null,
+  "method": null,
+  "confidence": null,
+  "family": null,
+  "params_b": null,
+  "license": null,
+  "downloads": null,
+  "likes": null,
+  "is_gguf": null,
+  "created_at": null,
+  "first_seen_at": null,
+} satisfies ModelSummary
+
+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 ModelSummary
+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/ModelsApi.md

@@ -0,0 +1,191 @@
+# ModelsApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getModel**](ModelsApi.md#getmodel) | **GET** /api/v1/models/{id} | Get one model |
+| [**listModels**](ModelsApi.md#listmodels) | **GET** /api/v1/models | List models |
+
+
+
+## getModel
+
+> GetModel200Response getModel(id)
+
+Get one model
+
+Cost: 10 credits. Priced above /authors/[id], /methods/[id] and /datasets/[id] because iterating over model ids is functionally a slow dump. The id is author/name and must be percent-encoded.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModelsApi,
+} from '@abliteration/sdk';
+import type { GetModelRequest } 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 ModelsApi(config);
+
+  const body = {
+    // string
+    id: mlabonne/Qwen3-30B-A3B-abliterated,
+  } satisfies GetModelRequest;
+
+  try {
+    const data = await api.getModel(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
+
+[**GetModel200Response**](GetModel200Response.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** | Full model record. |  -  |
+| **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)
+
+
+## listModels
+
+> ListModels200Response listModels(method, family, author, license, downloadsGte, downloadsLte, createdAfter, createdBefore, sort, limit, offset)
+
+List models
+
+Cost: 5-300+ credits, stepped by returned rows and multiplied by `1 + (offset/2500)²`. A filtered lookup up to 200 rows costs 5; a 1000-row page on the first page costs 300; on offset=10000, 5100. Filter cheap, dump expensive. See /api#pricing. Delisted models are excluded here but remain reachable by id.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModelsApi,
+} from '@abliteration/sdk';
+import type { ListModelsRequest } 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 ModelsApi(config);
+
+  const body = {
+    // string | M-code, case-insensitive. See GET /api/v1/methods. (optional)
+    method: method_example,
+    // string | Base family, for example qwen or llama. (optional)
+    family: family_example,
+    // string | Publisher handle, case-insensitive. (optional)
+    author: author_example,
+    // string | SPDX-ish license string as published. (optional)
+    license: license_example,
+    // number (optional)
+    downloadsGte: 56,
+    // number (optional)
+    downloadsLte: 56,
+    // string | ISO-8601 date or timestamp, inclusive. (optional)
+    createdAfter: createdAfter_example,
+    // string | ISO-8601 date or timestamp, inclusive. (optional)
+    createdBefore: createdBefore_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 ListModelsRequest;
+
+  try {
+    const data = await api.listModels(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **method** | `string` | M-code, case-insensitive. See GET /api/v1/methods. | [Optional] [Defaults to `undefined`] |
+| **family** | `string` | Base family, for example qwen or llama. | [Optional] [Defaults to `undefined`] |
+| **author** | `string` | Publisher handle, case-insensitive. | [Optional] [Defaults to `undefined`] |
+| **license** | `string` | SPDX-ish license string as published. | [Optional] [Defaults to `undefined`] |
+| **downloadsGte** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **downloadsLte** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **createdAfter** | `string` | ISO-8601 date or timestamp, inclusive. | [Optional] [Defaults to `undefined`] |
+| **createdBefore** | `string` | ISO-8601 date or timestamp, inclusive. | [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
+
+[**ListModels200Response**](ListModels200Response.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 models. |  -  |
+| **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/Passport.md

@@ -0,0 +1,38 @@
+
+# Passport
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`one_liner` | string
+`practitioner` | string
+`research` | string
+
+## Example
+
+```typescript
+import type { Passport } from '@abliteration/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "one_liner": null,
+  "practitioner": null,
+  "research": null,
+} satisfies Passport
+
+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 Passport
+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/TimelineApi.md

@@ -0,0 +1,93 @@
+# TimelineApi
+
+All URIs are relative to *https://abliteration.org*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listTimeline**](TimelineApi.md#listtimeline) | **GET** /api/v1/timeline | Curated field events |
+
+
+
+## listTimeline
+
+> ListTimeline200Response listTimeline(from, to, eventType, limit)
+
+Curated field events
+
+Cost: 50 credits, flat.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TimelineApi,
+} from '@abliteration/sdk';
+import type { ListTimelineRequest } 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 TimelineApi(config);
+
+  const body = {
+    // string | Inclusive lower bound on the event date, ISO-8601. (optional)
+    from: from_example,
+    // string | Inclusive upper bound on the event date, ISO-8601. (optional)
+    to: to_example,
+    // string | Event type, case-insensitive. (optional)
+    eventType: eventType_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListTimelineRequest;
+
+  try {
+    const data = await api.listTimeline(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **from** | `string` | Inclusive lower bound on the event date, ISO-8601. | [Optional] [Defaults to `undefined`] |
+| **to** | `string` | Inclusive upper bound on the event date, ISO-8601. | [Optional] [Defaults to `undefined`] |
+| **eventType** | `string` | Event type, case-insensitive. | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `100`] |
+
+### Return type
+
+[**ListTimeline200Response**](ListTimeline200Response.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** | Events, newest first. |  -  |
+| **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/openapi-generator-config.json

@@ -0,0 +1,10 @@
+{
+  "npmName": "@abliteration/sdk",
+  "npmVersion": "0.1.0",
+  "npmRepository": "https://abliteration.org/api",
+  "supportsES6": true,
+  "typescriptThreePlus": true,
+  "modelPropertyNaming": "original",
+  "withInterfaces": true,
+  "useSingleRequestParameter": true
+}