import { APIResource } from "../../core/resource.js"; import { APIPromise } from "../../core/api-promise.js"; import { RequestOptions } from "../../internal/request-options.js"; export declare class Readme extends APIResource { /** * Get the README content for a model. * * Example cURL request: * * ```console * curl -s \ * -H "Authorization: Bearer $REPLICATE_API_TOKEN" \ * https://api.replicate.com/v1/models/replicate/hello-world/readme * ``` * * The response will be the README content as plain text in Markdown format: * * ``` * # Hello World Model * * This is an example model that... * ``` * * @example * ```ts * const readme = await replicate.models.readme.get({ * model_owner: 'model_owner', * model_name: 'model_name', * }); * ``` */ get(params: ReadmeGetParams, options?: RequestOptions): APIPromise; } /** * The README content in Markdown format */ export type ReadmeGetResponse = string; export interface ReadmeGetParams { /** * The name of the user or organization that owns the model. */ model_owner: string; /** * The name of the model. */ model_name: string; } export declare namespace Readme { export { type ReadmeGetResponse as ReadmeGetResponse, type ReadmeGetParams as ReadmeGetParams }; } //# sourceMappingURL=readme.d.ts.map