Llm.Images
Overview
Available Operations
- create - Generate images from text descriptions
create
Creates AI-generated images from text descriptions.
Example Usage
typescript
import { SDK } from "@meetkai/mka1";
const sdk = new SDK({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await sdk.llm.images.create({
prompt: "A serene mountain landscape at sunset with a lake reflection",
quality: "hd",
});
console.log(result);
}
run();Standalone function
The standalone function version of this method:
typescript
import { SDKCore } from "@meetkai/mka1/core.js";
import { llmImagesCreate } from "@meetkai/mka1/funcs/llmImagesCreate.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 llmImagesCreate(sdk, {
prompt: "A serene mountain landscape at sunset with a lake reflection",
quality: "hd",
});
if (res.ok) {
const { value: result } = res;
console.log(result);
} else {
console.log("llmImagesCreate 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.
tsx
import {
// Mutation hook for triggering the API call.
useLlmImagesCreateMutation
} from "@meetkai/mka1/react-query/llmImagesCreate.js";Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
request | components.ImageGenerationRequest | ✔️ | 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.ImageGenerationResponse>
Errors
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.APIError | 4XX, 5XX | */* |