Datasets
Overview
Available Operations
- listGenerators - List Generators
- getGenerator - Get Generator
- quoteGenerator - Quote Generator
- listGenerations - List Generations
- createGeneration - Create Generation
- getGeneration - Get Generation
- getGenerationLogs - Get Logs
- getGenerationEvents - Get Events
- cancelGeneration - Cancel Generation
- listFormats - List Formats
- getFormat - Get Format
listGenerators
List Generators
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.listGenerators({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsListGenerators } from "@meetkai/mka1/funcs/datasetsListGenerators.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsListGenerators(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsListGenerators failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsListGenerators,
useDatasetsListGeneratorsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsListGenerators,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsListGenerators,
invalidateAllDatasetsListGenerators,
} from "@meetkai/mka1/react-query/datasetsListGenerators.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListGeneratorsApiV1DatasetsGeneratorsGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.GeneratorList>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
getGenerator
Get Generator
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.getGenerator({
generatorId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsGetGenerator } from "@meetkai/mka1/funcs/datasetsGetGenerator.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsGetGenerator(sdk, {
generatorId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsGetGenerator failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsGetGenerator,
useDatasetsGetGeneratorSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsGetGenerator,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsGetGenerator,
invalidateAllDatasetsGetGenerator,
} from "@meetkai/mka1/react-query/datasetsGetGenerator.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetGeneratorApiV1DatasetsGeneratorsGeneratorIdGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.GeneratorDetail>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
quoteGenerator
Quote Generator
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.quoteGenerator({
generatorId: "<id>",
quoteRequest: {
params: {
"key": "<value>",
"key1": "<value>",
},
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsQuoteGenerator } from "@meetkai/mka1/funcs/datasetsQuoteGenerator.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsQuoteGenerator(sdk, {
generatorId: "<id>",
quoteRequest: {
params: {
"key": "<value>",
"key1": "<value>",
},
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsQuoteGenerator failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useDatasetsQuoteGeneratorMutation
} from "@meetkai/mka1/react-query/datasetsQuoteGenerator.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.QuoteGeneratorApiV1DatasetsGeneratorsGeneratorIdQuotePostRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.QuoteResponse>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
listGenerations
List Generations
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.listGenerations({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsListGenerations } from "@meetkai/mka1/funcs/datasetsListGenerations.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsListGenerations(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsListGenerations failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsListGenerations,
useDatasetsListGenerationsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsListGenerations,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsListGenerations,
invalidateAllDatasetsListGenerations,
} from "@meetkai/mka1/react-query/datasetsListGenerations.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListGenerationsApiV1DatasetsGenerationsGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.PageGeneration>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
createGeneration
The components.md §6 D.1 sequence, in its order: nothing is written before the digest is pinned, and the workflow starts only after the row is committed.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.createGeneration({
idempotencyKey: "<value>",
createGeneration: {
generatorId: "<id>",
params: {
"key": "<value>",
"key1": "<value>",
},
output: {
repo: "<value>",
},
},
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsCreateGeneration } from "@meetkai/mka1/funcs/datasetsCreateGeneration.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsCreateGeneration(sdk, {
idempotencyKey: "<value>",
createGeneration: {
generatorId: "<id>",
params: {
"key": "<value>",
"key1": "<value>",
},
output: {
repo: "<value>",
},
},
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsCreateGeneration failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useDatasetsCreateGenerationMutation
} from "@meetkai/mka1/react-query/datasetsCreateGeneration.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.CreateGenerationApiV1DatasetsGenerationsPostRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.GenerationCreated>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
getGeneration
Get Generation
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.getGeneration({
generationId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsGetGeneration } from "@meetkai/mka1/funcs/datasetsGetGeneration.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsGetGeneration(sdk, {
generationId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsGetGeneration failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsGetGeneration,
useDatasetsGetGenerationSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsGetGeneration,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsGetGeneration,
invalidateAllDatasetsGetGeneration,
} from "@meetkai/mka1/react-query/datasetsGetGeneration.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetGenerationApiV1DatasetsGenerationsGenerationIdGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.Generation>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
getGenerationLogs
Get Logs
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.getGenerationLogs({
generationId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsGetGenerationLogs } from "@meetkai/mka1/funcs/datasetsGetGenerationLogs.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsGetGenerationLogs(sdk, {
generationId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsGetGenerationLogs failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsGetGenerationLogs,
useDatasetsGetGenerationLogsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsGetGenerationLogs,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsGetGenerationLogs,
invalidateAllDatasetsGetGenerationLogs,
} from "@meetkai/mka1/react-query/datasetsGetGenerationLogs.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetLogsApiV1DatasetsGenerationsGenerationIdLogsGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.PageLogLine>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
getGenerationEvents
Get Events
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.getGenerationEvents({
generationId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsGetGenerationEvents } from "@meetkai/mka1/funcs/datasetsGetGenerationEvents.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsGetGenerationEvents(sdk, {
generationId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsGetGenerationEvents failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsGetGenerationEvents,
useDatasetsGetGenerationEventsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsGetGenerationEvents,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsGetGenerationEvents,
invalidateAllDatasetsGetGenerationEvents,
} from "@meetkai/mka1/react-query/datasetsGetGenerationEvents.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetEventsApiV1DatasetsGenerationsGenerationIdEventsGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.EventList>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
cancelGeneration
api.md §3: cancelling is written here, then the signal; a cancelling row whose signal was lost (the retry case) is signalled again.
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.cancelGeneration({
generationId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsCancelGeneration } from "@meetkai/mka1/funcs/datasetsCancelGeneration.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsCancelGeneration(sdk, {
generationId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsCancelGeneration failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Mutation hook for triggering the API call.
useDatasetsCancelGenerationMutation
} from "@meetkai/mka1/react-query/datasetsCancelGeneration.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.CancelGenerationApiV1DatasetsGenerationsGenerationIdCancelPostRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.Generation>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |
listFormats
List Formats
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.listFormats({});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsListFormats } from "@meetkai/mka1/funcs/datasetsListFormats.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsListFormats(sdk, {});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsListFormats failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsListFormats,
useDatasetsListFormatsSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsListFormats,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsListFormats,
invalidateAllDatasetsListFormats,
} from "@meetkai/mka1/react-query/datasetsListFormats.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.ListFormatsApiV1DatasetsFormatsGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.FormatList>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |
getFormat
Get Format
Example Usage
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.datasets.getFormat({
formatId: "<id>",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
import { SDKCore } from "@meetkai/mka1/core.js";
import { datasetsGetFormat } from "@meetkai/mka1/funcs/datasetsGetFormat.js";
// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const res = await datasetsGetFormat(sdk, {
formatId: "<id>",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("datasetsGetFormat failed:", res.error);
}
}
run();React hooks and utilities
This method can be used in React components through the following hooks and associated utilities.
Check out this guide for information about each of the utilities below and how to get started using React hooks.
import {
// Query hooks for fetching data.
useDatasetsGetFormat,
useDatasetsGetFormatSuspense,
// Utility for prefetching data during server-side rendering and in React
// Server Components that will be immediately available to client components
// using the hooks.
prefetchDatasetsGetFormat,
// Utilities to invalidate the query cache for this query in response to
// mutations and other user actions.
invalidateDatasetsGetFormat,
invalidateAllDatasetsGetFormat,
} from "@meetkai/mka1/react-query/datasetsGetFormat.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | operations.GetFormatApiV1DatasetsFormatsFormatIdGetRequest | ✔️ | The request object to use for the request. |
options | RequestOptions | ➖ | Used to set various options for making HTTP requests. |
options.fetchOptions | RequestInit | ➖ | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed. |
options.retries | RetryConfig | ➖ | Enables retrying HTTP requests under certain failure conditions. |
Response
Promise<components.FormatDetail>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.HTTPValidationError | 422 | application/json |
| errors.APIError | 4XX, 5XX | */* |