​
Usage

import Itzam from "itzam";
import { z } from "zod";

const itzam = new Itzam("YOUR_API_KEY");

const schema = z.array(
  z.object({
    name: z.string(),
    description: z.string(),
  })
);

const response = await itzam.generateObject({
  input: "List the characters in Atlas Shrugged",
  workflowSlug: "atlas-shrugged",
  schema,
});

console.log(response.object); // The generated object
console.log(response.metadata); // Metadata about the run

​
Parameters

When using a JSON schema, you must add as const to the schema object for it to be properly typed. More info

ParameterTypeRequiredDescription
inputstringYesThe input text to generate a response for.
schemaobjectYesThe Zod v3, v4 or JSON schema that defines the structure of the expected response.
workflowSlugstringNoThe slug of the workflow to use for generation (not required if you’re using a threadId).
threadIdstringNoIdentifier for associating runs with a conversation thread.
attachmentsAttachment[]NoArray of attachments to include in the generation.
contextSlugsstring[]NoThe slugs of the contexts that the AI model can access.
typestringNoUsed to indicate the response type (only “event” is supported for now).
callbackCallbackNoThe callback object to receive the webhook.

​
Return Value

The generateObject method returns the following object:

type GenerateObjectResponse<T> = {
  object: T; // The generated object based on your schema
  metadata: {
    runId: string; // The ID of the run
    cost: string; // The cost of the run in USD
    model: {
      name: string; // The name of the model
      tag: string; // The tag of the model
    };
    durationInMs: number; // The duration of the run in milliseconds
    inputTokens: number; // The number of input tokens used for this generation
    outputTokens: number; // The number of output tokens used for this generation
  };
};

If you use the type and callback parameters, this will return the following object:

type WebhookResponse = {
  message: string; // A message to indicate that the webhook was queued
  runId: string; // The ID of the run
};