Agent data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
descriptionstringNo
instructionsstringNoThe system prompt or stored procedure that the agent follows.
model_idstringNoThe model that the agent runs on.
is_activebooleanNo

TypeScript

TypeScript
export type GenaiAgent = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	description?: string;
	instructions?: string; // The system prompt or stored procedure that the agent follows.
	model_id?: string; // The model that the agent runs on.
	is_active?: boolean;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodGenaiAgent = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	description: z.string().optional(),
	instructions: z.string().optional().describe("The system prompt or stored procedure that the agent follows."),
	model_id: z.string().optional().describe("The model that the agent runs on."),
	is_active: z.boolean().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class GenaiAgent:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	description: Optional[str]
	"""The system prompt or stored procedure that the agent follows."""
	instructions: Optional[str]
	"""The model that the agent runs on."""
	model_id: Optional[str]
	is_active: Optional[bool]
Are we missing anything? Let us know
Was this page helpful?