import { AxiosRequestConfig } from 'axios'; interface WorldApiConfig { baseURL: string; apiKey?: string; organizationId?: string; accessToken?: string; } declare const setWorldApiConfig: (newConfig: Partial) => void; declare const getWorldApiConfig: () => WorldApiConfig; declare const customInstance: (config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Tag { id: string; organization_id: string; /** @maxLength 50 */ name: string; /** @maxLength 50 */ slug: string; /** * @nullable * @pattern ^#[0-9A-Fa-f]{6}$ */ color?: string | null; /** @nullable */ description?: string | null; created_at: string; updated_at: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AddAgentTags200 = { tags?: Tag[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AddName201 = { message?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgeDistributionDistribution = (typeof AgeDistributionDistribution)[keyof typeof AgeDistributionDistribution]; declare const AgeDistributionDistribution: { readonly normal: "normal"; readonly uniform: "uniform"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgeDistribution { /** @minimum 0 */ min: number; /** @minimum 0 */ max: number; distribution: AgeDistributionDistribution; /** Required for normal distribution */ mean?: number; /** Required for normal distribution */ std_dev?: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface WorldConfig { /** Simulation start time */ startTime: string; /** * Time progression interval in minutes * @minimum 1 */ tickInterval: number; /** IANA timezone identifier */ timezone: string; /** * How many months ahead to plan * @minimum 1 */ planningHorizonMonths: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type LocationDistributionRegionsItem = { name: string; /** * @minimum 0 * @maximum 1 */ weight: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface LocationDistribution { regions?: LocationDistributionRegionsItem[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type NameDistributionGenderRatio = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type NameDistributionOriginWeights = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type NameDistributionEraWeights = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface NameDistribution { gender_ratio?: NameDistributionGenderRatio; origin_weights?: NameDistributionOriginWeights; era_weights?: NameDistributionEraWeights; required_tags?: string[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface DemographicRules { age_distribution?: AgeDistribution; location_distribution?: LocationDistribution; name_distribution?: NameDistribution; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface World { id: string; /** * @minLength 1 * @maxLength 255 */ name: string; config: WorldConfig; demographic_rules?: DemographicRules; created_at: string; updated_at: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type LocationType = (typeof LocationType)[keyof typeof LocationType]; declare const LocationType: { readonly residence: "residence"; readonly workplace: "workplace"; readonly retail: "retail"; readonly restaurant: "restaurant"; readonly cafe: "cafe"; readonly bar: "bar"; readonly park: "park"; readonly gym: "gym"; readonly school: "school"; readonly hospital: "hospital"; readonly entertainment: "entertainment"; readonly transport: "transport"; readonly community: "community"; readonly religious: "religious"; readonly office: "office"; readonly other: "other"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type LocationCapacity = { /** @minimum 1 */ max_occupancy: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Operating hours for a day. Use null for closed days. * @nullable */ type DayHours = { /** @pattern ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ */ open: string; /** @pattern ^([01]?[0-9]|2[0-3]):[0-5][0-9]$ */ close: string; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface OperatingHours { monday?: DayHours; tuesday?: DayHours; wednesday?: DayHours; thursday?: DayHours; friday?: DayHours; saturday?: DayHours; sunday?: DayHours; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Coordinates { /** * @minimum -90 * @maximum 90 */ latitude: number; /** * @minimum -180 * @maximum 180 */ longitude: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface LocationConnection { connected_location_id?: string; /** @minimum 0 */ distance_km?: number; /** @minimum 0 */ travel_time_minutes?: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Location { id: string; world_id: string; name: string; name_region_code: string; type: LocationType; timezone: string; capacity: LocationCapacity; operating_hours?: OperatingHours; coordinates: Coordinates; connections?: LocationConnection[]; created_at?: string; updated_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Agent's status */ type AgentStatusProperty = (typeof AgentStatusProperty)[keyof typeof AgentStatusProperty]; declare const AgentStatusProperty: { readonly active: "active"; readonly inactive: "inactive"; readonly archived: "archived"; readonly rejected: "rejected"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Agent's review status (only when include_review=true) */ type AgentReviewStatus = (typeof AgentReviewStatus)[keyof typeof AgentReviewStatus]; declare const AgentReviewStatus: { readonly pending: "pending"; readonly locked_for_review: "locked_for_review"; readonly approved: "approved"; readonly rejected: "rejected"; readonly needs_changes: "needs_changes"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface ReviewMetadata { /** * Who locked the agent for review * @nullable */ locked_by?: string | null; /** * When the agent was locked * @nullable */ locked_at?: string | null; /** * When the lock expires * @nullable */ expires_at?: string | null; /** * Who reviewed the agent * @nullable */ reviewed_by?: string | null; /** * When the agent was reviewed * @nullable */ reviewed_at?: string | null; /** * Review notes * @nullable */ review_notes?: string | null; /** Sites where agent is approved */ approved_sites?: string[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Full personality JSON from database */ type PersonalityRawData = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Personality { /** Personality description */ description: string; /** Personality traits */ traits: string[]; /** Personality background */ background: string; /** Ethnicity (optional) */ ethnicity?: string; /** Full personality JSON from database */ raw_data: PersonalityRawData; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedMediaObjectType = (typeof UnifiedMediaObjectType)[keyof typeof UnifiedMediaObjectType]; declare const UnifiedMediaObjectType: { readonly image: "image"; readonly video: "video"; readonly document: "document"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type UnifiedMediaObjectMetadata = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedMediaObjectUsage = (typeof UnifiedMediaObjectUsage)[keyof typeof UnifiedMediaObjectUsage]; declare const UnifiedMediaObjectUsage: { readonly avatar: "avatar"; readonly banner: "banner"; readonly headshot: "headshot"; readonly gallery: "gallery"; readonly cover: "cover"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type UnifiedMediaObjectCropData = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedMediaObjectCropHistoryItem = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type MediaOptionMetadata = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaOption { id?: string; media_id?: string; stage?: string; url?: string; storage_path?: string; /** @nullable */ metadata?: MediaOptionMetadata; created_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type MediaVariantMetadata = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaVariant { id?: string; media_id?: string; variant_type?: string; /** @nullable */ width?: number | null; /** @nullable */ height?: number | null; url?: string; storage_path?: string; size?: number; /** @nullable */ metadata?: MediaVariantMetadata; created_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type UnifiedMediaObjectMetadataExpanded = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaReview { id?: string; media_id?: string; reviewer_id?: string; action?: string; /** @nullable */ reason?: string | null; created_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface UnifiedMediaObject { id?: string; agent_id?: string; /** @nullable */ organization_id?: string | null; filename?: string; /** @nullable */ title?: string | null; type?: UnifiedMediaObjectType; /** @nullable */ subtype?: string | null; mime_type?: string; size?: number; url?: string; storage_path?: string; /** @nullable */ metadata?: UnifiedMediaObjectMetadata; status?: string; usage?: UnifiedMediaObjectUsage; /** @nullable */ original_url?: string | null; /** @nullable */ original_storage_path?: string | null; /** @nullable */ crop_data?: UnifiedMediaObjectCropData; is_cropped?: boolean; crop_history?: UnifiedMediaObjectCropHistoryItem[]; review_count?: number; /** @nullable */ review_state?: string | null; /** @nullable */ approved_at?: string | null; /** @nullable */ rejected_at?: string | null; created_at?: string; updated_at?: string; /** @nullable */ variants_updated_at?: string | null; /** @nullable */ crop_updated_at?: string | null; options?: MediaOption[]; variants?: MediaVariant[]; /** @nullable */ metadata_expanded?: UnifiedMediaObjectMetadataExpanded; review_history?: MediaReview[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaSelection { /** * ID of currently selected media * @nullable */ current_id?: string | null; current?: UnifiedMediaObject; /** All available media options */ options?: UnifiedMediaObject[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentMedia { avatar: MediaSelection; banner: MediaSelection; headshot: MediaSelection; full_body: MediaSelection; /** All media items for this agent */ all: UnifiedMediaObject[]; /** Total number of media items */ count: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface LocationReference { id?: string; name?: string; type?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type CalendarEntryActivityType = (typeof CalendarEntryActivityType)[keyof typeof CalendarEntryActivityType]; declare const CalendarEntryActivityType: { readonly work: "work"; readonly meal: "meal"; readonly social: "social"; readonly exercise: "exercise"; readonly shopping: "shopping"; readonly entertainment: "entertainment"; readonly personal: "personal"; readonly commute: "commute"; readonly sleep: "sleep"; readonly other: "other"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type CalendarEntryRecurrencePattern = (typeof CalendarEntryRecurrencePattern)[keyof typeof CalendarEntryRecurrencePattern]; declare const CalendarEntryRecurrencePattern: { readonly daily: "daily"; readonly weekdays: "weekdays"; readonly weekly: "weekly"; readonly monthly: "monthly"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type CalendarEntryParticipantsItem = { id?: string; name?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CalendarEntry { id?: string; agent_id?: string; title?: string; description?: string; start_time?: string; end_time?: string; location?: LocationReference; activity_type?: CalendarEntryActivityType; is_recurring?: boolean; recurrence_pattern?: CalendarEntryRecurrencePattern; participants?: CalendarEntryParticipantsItem[]; created_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Agent { /** Unique agent identifier */ id: string; /** Agent's first name */ first_name: string; /** Agent's last name */ last_name: string; /** Agent's full name (computed) */ full_name: string; /** Agent's birth date */ birth_date: string; /** Computed age based on birth date */ age: number; /** Agent's gender */ gender: string; /** World where the agent exists */ world_id: string; world?: World; /** Agent's current location */ location_id: string; location?: Location; /** Agent's status */ status: AgentStatusProperty; /** Agent's review status (only when include_review=true) */ review_status?: AgentReviewStatus; review_metadata?: ReviewMetadata; personality: Personality; /** Agent's biography (computed from personality) */ bio: string; /** Agent's occupation (computed from life motivations) */ occupation: string; media: AgentMedia; /** Agent's tags */ tags: Tag[]; /** Agent's calendar entries (only when include_calendar=true) */ calendar_entries?: CalendarEntry[]; /** Agent version number */ version: number; /** * Organization ID (if applicable) * @nullable */ organization_id: string | null; /** When the agent was created */ created_at: string; /** When the agent was last updated */ updated_at: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaAction200DataResultsSuccessfulItem = { review_id?: string; action?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaAction200DataResultsFailedItem = { review_id?: string; action?: string; error?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaAction200DataResults = { successful?: AgentBulkMediaAction200DataResultsSuccessfulItem[]; failed?: AgentBulkMediaAction200DataResultsFailedItem[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaAction200Data = { /** Total number of actions processed */ processed?: number; /** Number of successful actions */ successful?: number; /** Number of failed actions */ failed?: number; results?: AgentBulkMediaAction200DataResults; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaAction200 = { data?: AgentBulkMediaAction200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Action to perform */ type AgentBulkMediaActionBodyActionsItemAction = (typeof AgentBulkMediaActionBodyActionsItemAction)[keyof typeof AgentBulkMediaActionBodyActionsItemAction]; declare const AgentBulkMediaActionBodyActionsItemAction: { readonly approve: "approve"; readonly reject: "reject"; readonly skip: "skip"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaActionBodyActionsItem = { /** Review item ID */ review_id: string; /** Action to perform */ action: AgentBulkMediaActionBodyActionsItemAction; /** Optional notes (for approve action) */ notes?: string; /** Rejection reason (required for reject action) */ reason?: string; /** Whether to delete media when rejecting */ delete_media?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentBulkMediaActionBody = { /** * @minItems 1 * @maxItems 50 */ actions: AgentBulkMediaActionBodyActionsItem[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Type of media */ type AgentMediaItemType = (typeof AgentMediaItemType)[keyof typeof AgentMediaItemType]; declare const AgentMediaItemType: { readonly image: "image"; readonly video: "video"; readonly document: "document"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type MediaMetadataTechnicalInfo = { /** Image/video resolution */ resolution?: string; /** File format */ format?: string; /** Compression algorithm used */ compression?: string; /** Duration in seconds (for videos) */ duration?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type MediaMetadataGeneratedInfo = { /** Generation prompt if AI-generated */ prompt?: string; /** AI model used for generation */ model?: string; /** Generation timestamp */ created_at?: string; /** Model version */ version?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Flexible metadata object for media */ interface MediaMetadata { /** Alternative title */ title?: string; /** Detailed description */ description?: string; /** Array of tags for categorization */ tags?: string[]; /** Content categories */ categories?: string[]; technical_info?: MediaMetadataTechnicalInfo; generated_info?: MediaMetadataGeneratedInfo; [key: string]: unknown; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentMediaItem { /** Media unique identifier */ id: string; /** Agent unique identifier */ agentId: string; /** Media title or name */ title: string; /** Type of media */ type: AgentMediaItemType; /** URL to access the media */ url: string; /** URL to access a thumbnail version */ thumbnailUrl?: string; /** * File size in bytes * @minimum 0 */ size: number; /** When the media was uploaded */ uploadedAt: string; metadata?: MediaMetadata; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface PaginationInfo { /** * Current page number (1-based) * @minimum 1 */ page: number; /** * Number of items per page * @minimum 1 */ pageSize: number; /** * Total number of items * @minimum 0 */ total: number; /** * Total number of pages * @minimum 0 */ totalPages: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentMediaResponse { media: AgentMediaItem[]; pagination: PaginationInfo; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentResponse { data: Agent; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Current status of the agent */ type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus]; declare const AgentStatus: { readonly active: "active"; readonly inactive: "inactive"; readonly archived: "archived"; readonly pending: "pending"; readonly approved: "approved"; readonly rejected: "rejected"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentTag { id?: string; agent_id?: string; tag?: string; created_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentWithContextResponseDataContext = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type AgentWithContextResponseData = { agent?: Agent; context?: AgentWithContextResponseDataContext; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentWithContextResponse { data: AgentWithContextResponseData; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentWithPendingMedia { agent_id: string; agent_name: string; /** Number of pending media items */ pending_count: number; organization_id: string; organization_name: string; updated_at: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AgentsResponse { data: Agent[]; pagination: PaginationInfo; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ApproveAgent200Data = { agentId?: string; status?: string; approvedSites?: string[]; reviewedAt?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ApproveAgent200 = { success?: boolean; message?: string; data?: ApproveAgent200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Optional review metadata */ type ApproveAgentRequestMetadata = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface ApproveAgentRequest { /** List of sites where the agent is approved */ sites: string[]; /** * Optional review notes * @maxLength 5000 */ notes?: string; /** Optional review metadata */ metadata?: ApproveAgentRequestMetadata; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ApproveMedia200Data = { success?: boolean; message?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ApproveMedia200 = { data?: ApproveMedia200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ApproveMediaBody = { /** Optional approval notes */ notes?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface AssignTagsInput { tagIds: string[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Error { /** Error message */ error: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Bad request - invalid input */ type BadRequestResponse = Error; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface BatchNameResult { total?: number; successful?: number; failed?: number; duplicates?: number; duplicate_names?: string[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BatchAddNames201 = { results?: BatchNameResult; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Gender categories: - F: Female - M: Male - NB: Non-binary - U: Unspecified */ type Gender = (typeof Gender)[keyof typeof Gender]; declare const Gender: { readonly F: "F"; readonly M: "M"; readonly NB: "NB"; readonly U: "U"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type NameFrequency = (typeof NameFrequency)[keyof typeof NameFrequency]; declare const NameFrequency: { readonly common: "common"; readonly uncommon: "uncommon"; readonly rare: "rare"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type Era = (typeof Era)[keyof typeof Era]; declare const Era: { readonly modern: "modern"; readonly historical: "historical"; readonly contemporary: "contemporary"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface NameEntry { /** * @minLength 1 * @maxLength 100 */ name: string; gender: Gender; origin: string; frequency: NameFrequency; era: Era; tags?: string[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BatchAddNamesBody = { /** * @minItems 1 * @maxItems 10000 */ entries: NameEntry[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BatchCreateLocations201 = { locations?: Location[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BatchCreateLocationsRequestLocationsItemCapacity = { /** @minimum 1 */ max_occupancy: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BatchCreateLocationsRequestLocationsItem = { /** * @minLength 1 * @maxLength 255 */ name: string; name_region_code: string; type: LocationType; timezone: string; capacity: BatchCreateLocationsRequestLocationsItemCapacity; operating_hours?: OperatingHours; coordinates: Coordinates; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface BatchCreateLocationsRequest { /** * @minItems 1 * @maxItems 1000 */ locations: BatchCreateLocationsRequestLocationsItem[]; /** Auto-connect nearby locations */ connect_nearby?: boolean; /** * Max connections per location * @minimum 1 */ max_connections?: number; /** * Connection radius in kilometers * @minimum 0.1 */ connection_radius_km?: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BulkApproveMedia200Data = { success?: boolean; /** Number of items approved */ approved?: number; /** Error messages for failed items */ errors?: string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BulkApproveMedia200 = { data?: BulkApproveMedia200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BulkApproveMediaBody = { /** @minItems 1 */ review_ids: string[]; /** Optional approval notes for all items */ notes?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BulkRejectMedia200Data = { success?: boolean; /** Number of items rejected */ rejected?: number; /** Error messages for failed items */ errors?: string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BulkRejectMedia200 = { data?: BulkRejectMedia200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type BulkRejectMediaBody = { /** @minItems 1 */ review_ids: string[]; /** * Rejection reason for all items * @minLength 1 */ reason: string; /** Whether to delete the media (default false) */ delete_media?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Type of media */ type CreateAgentMediaRequestType = (typeof CreateAgentMediaRequestType)[keyof typeof CreateAgentMediaRequestType]; declare const CreateAgentMediaRequestType: { readonly image: "image"; readonly video: "video"; readonly document: "document"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Content rating for appropriate audience */ type CreateAgentMediaRequestAudienceRating = (typeof CreateAgentMediaRequestAudienceRating)[keyof typeof CreateAgentMediaRequestAudienceRating]; declare const CreateAgentMediaRequestAudienceRating: { readonly G: "G"; readonly PG: "PG"; readonly 'PG-13': "PG-13"; readonly R: "R"; readonly 'NC-17': "NC-17"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CreateAgentMediaRequest { /** * Media title or name * @minLength 1 * @maxLength 255 */ title: string; /** Type of media */ type: CreateAgentMediaRequestType; /** URL to the media file */ url: string; /** URL to a thumbnail version (optional) */ thumbnailUrl?: string; /** * File size in bytes (optional) * @minimum 0 */ size?: number; metadata?: MediaMetadata; /** * Context or description of when/why this media was created * @maxLength 255 */ context?: string; /** * User-visible caption for the media * @maxLength 1000 */ caption?: string; /** * Internal notes about the media (not shown to users) * @maxLength 2000 */ internalThoughts?: string; /** * Value rating from 1-5 * @minimum 1 * @maximum 5 */ valueScore?: number; /** * Trust/authenticity score from 1-5 * @minimum 1 * @maximum 5 */ trustScore?: number; /** Content rating for appropriate audience */ audienceRating?: CreateAgentMediaRequestAudienceRating; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type CreateTag201 = { tag?: Tag; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CreateTagInput { /** @maxLength 50 */ name: string; /** * @nullable * @pattern ^#[0-9A-Fa-f]{6}$ */ color?: string | null; /** @nullable */ description?: string | null; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Type of media being uploaded */ type CreateUploadUrlRequestMediaType = (typeof CreateUploadUrlRequestMediaType)[keyof typeof CreateUploadUrlRequestMediaType]; declare const CreateUploadUrlRequestMediaType: { readonly image: "image"; readonly video: "video"; readonly document: "document"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Content rating for appropriate audience */ type CreateUploadUrlRequestAudienceRating = (typeof CreateUploadUrlRequestAudienceRating)[keyof typeof CreateUploadUrlRequestAudienceRating]; declare const CreateUploadUrlRequestAudienceRating: { readonly G: "G"; readonly PG: "PG"; readonly 'PG-13': "PG-13"; readonly R: "R"; readonly 'NC-17': "NC-17"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CreateUploadUrlRequest { /** * Original filename with extension * @minLength 1 */ filename: string; /** MIME type of the file */ contentType: string; /** Type of media being uploaded */ mediaType: CreateUploadUrlRequestMediaType; /** Whether media should be publicly accessible */ isPublic?: boolean; /** Caption or description for the media */ caption?: string; /** Internal thoughts about the media (not shown to users) */ internalThoughts?: string; /** * Value score from 1-5 * @minimum 1 * @maximum 5 */ valueScore?: number; /** * Trust score from 1-5 * @minimum 1 * @maximum 5 */ trustScore?: number; /** Content rating for appropriate audience */ audienceRating?: CreateUploadUrlRequestAudienceRating; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CreateUploadUrlResponse { /** Pre-signed URL for direct upload */ uploadUrl: string; /** ID of the created media record */ mediaId: string; /** When the upload URL expires */ expiresAt: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CreateWorldRequest { /** * @minLength 1 * @maxLength 255 */ name: string; config: WorldConfig; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type CropMediaRequestDimensions = { /** * X coordinate of crop area * @minimum 0 */ x: number; /** * Y coordinate of crop area * @minimum 0 */ y: number; /** * Width of crop area * @minimum 1 */ width: number; /** * Height of crop area * @minimum 1 */ height: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CropMediaRequest { dimensions: CropMediaRequestDimensions; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * The crop dimensions applied */ type CropMediaResponseCropData = { /** X coordinate of crop area */ x: number; /** Y coordinate of crop area */ y: number; /** Width of crop area */ width: number; /** Height of crop area */ height: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface CropMediaResponse { /** Whether the operation was successful */ success: boolean; /** The media identifier */ mediaId: string; /** The crop dimensions applied */ cropData: CropMediaResponseCropData; /** URL of the cropped media */ url: string; /** Width of the cropped media */ width: number; /** Height of the cropped media */ height: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type DeleteNames200 = { /** Number of names deleted */ deletedCount?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type DeleteNamesParams = { /** * Comma-separated list of specific names */ names?: string; /** * Filter by gender */ gender?: Gender; /** * Filter by origin */ origin?: string; /** * Filter by era */ era?: Era; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type DeleteWorld200 = { message?: string; /** ID of the deleted world */ worldId?: string; /** Name of the deleted world */ worldName?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type DemographicsIncomeLevel = (typeof DemographicsIncomeLevel)[keyof typeof DemographicsIncomeLevel]; declare const DemographicsIncomeLevel: { readonly low: "low"; readonly middle: "middle"; readonly high: "high"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type DemographicsRelationshipStatus = (typeof DemographicsRelationshipStatus)[keyof typeof DemographicsRelationshipStatus]; declare const DemographicsRelationshipStatus: { readonly single: "single"; readonly married: "married"; readonly divorced: "divorced"; readonly widowed: "widowed"; readonly partnered: "partnered"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface Demographics { education?: string; income_level?: DemographicsIncomeLevel; relationship_status?: DemographicsRelationshipStatus; has_children?: boolean; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type DigitalPresenceSocialMediaActivity = (typeof DigitalPresenceSocialMediaActivity)[keyof typeof DigitalPresenceSocialMediaActivity]; declare const DigitalPresenceSocialMediaActivity: { readonly none: "none"; readonly low: "low"; readonly moderate: "moderate"; readonly high: "high"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface DigitalPresence { has_smartphone?: boolean; social_media_activity?: DigitalPresenceSocialMediaActivity; preferred_platforms?: string[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Insufficient permissions */ type ForbiddenResponse = Error; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationJobStatus = (typeof PopulationJobStatus)[keyof typeof PopulationJobStatus]; declare const PopulationJobStatus: { readonly pending: "pending"; readonly processing: "processing"; readonly completed: "completed"; readonly failed: "failed"; readonly cancelled: "cancelled"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationJobGenerationRules = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationJobResultSummaryGenderDistribution = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationJobResultSummary = { agents_created?: number; average_age?: number; gender_distribution?: PopulationJobResultSummaryGenderDistribution; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface PopulationJob { id: string; world_id: string; status: PopulationJobStatus; total_count: number; batch_size: number; completed_count: number; failed_count: number; /** * @minimum 0 * @maximum 100 */ progress_percentage?: number; current_batch?: number; total_batches?: number; generation_rules?: PopulationJobGenerationRules; /** Error message if job failed */ error?: string; result_summary?: PopulationJobResultSummary; created_at?: string; updated_at?: string; started_at?: string; completed_at?: string; failed_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GeneratePopulation202 = { job?: PopulationJob; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Override world demographic rules */ type GeneratePopulationRequestGenerationRulesDemographicOverrides = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Initial state configuration */ type GeneratePopulationRequestGenerationRulesInitialState = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GeneratePopulationRequestGenerationRules = { /** Override world demographic rules */ demographic_overrides?: GeneratePopulationRequestGenerationRulesDemographicOverrides; /** Initial state configuration */ initial_state?: GeneratePopulationRequestGenerationRulesInitialState; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface GeneratePopulationRequest { /** * Total number of agents to generate * @minimum 1 */ count: number; /** * Agents per batch * @minimum 1 * @maximum 100 */ batch_size?: number; generation_rules?: GeneratePopulationRequestGenerationRules; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentApprovedMedia200Data = { approved_media?: UnifiedMediaObject[]; pagination?: PaginationInfo; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentApprovedMedia200 = { data?: GetAgentApprovedMedia200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentApprovedMediaParams = { /** * Filter by media context (avatar, banner, lifestyle, etc.) */ context?: string; /** * Maximum number of results * @minimum 1 * @maximum 100 */ limit?: number; /** * Number of results to skip * @minimum 0 */ offset?: number; /** * Include media variants */ includeVariants?: boolean; /** * Include media metadata */ includeMetadata?: boolean; /** * Include review history */ includeReviewHistory?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentByIdParams = { /** * Include media objects for all media IDs */ includeMedia?: boolean; /** * Include location details */ includeLocation?: boolean; /** * Include agent tags */ includeTags?: boolean; /** * Include calendar entries */ includeCalendarEntries?: boolean; /** * Include structured avatars object with current and options */ includeAvatars?: boolean; /** * Include structured banners object with current and options */ includeBanners?: boolean; /** * (Legacy) Include avatar options array - use includeAvatars instead */ includeAvatarOptions?: boolean; /** * (Legacy) Include banner options array - use includeBanners instead */ includeBannerOptions?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentCalendar200 = { calendar_entries?: CalendarEntry[]; total?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentCalendarParams = { /** * Filter by year */ year?: number; /** * Filter by month (1-12) * @minimum 1 * @maximum 12 */ month?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentMediaParams = { /** * Page number (1-based) * @minimum 1 */ page?: number; /** * Number of results per page * @minimum 1 * @maximum 120 */ pageSize?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Additional metadata about the media */ type MediaReviewItemMetadata = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaReviewItem { /** Review item ID */ id: string; /** Media context (avatar, banner, gallery, etc.) */ context: string; /** Review priority (higher = more important) */ priority: number; /** Lock expiration time */ locked_until?: string; /** Additional metadata about the media */ metadata?: MediaReviewItemMetadata; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentPendingMedia200DataPendingMediaItem = { review?: MediaReviewItem; media?: UnifiedMediaObject; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentPendingMedia200Data = { pending_media?: GetAgentPendingMedia200DataPendingMediaItem[]; pagination?: PaginationInfo; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentPendingMedia200 = { data?: GetAgentPendingMedia200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentPendingMediaParams = { /** * Filter by media context (avatar, banner, lifestyle, etc.) */ context?: string; /** * Maximum number of results * @minimum 1 * @maximum 100 */ limit?: number; /** * Number of results to skip * @minimum 0 */ offset?: number; /** * Lock media items for bulk review (prevents other reviewers from accessing them) */ lockForReview?: boolean; /** * Include media variants */ includeVariants?: boolean; /** * Include media metadata */ includeMetadata?: boolean; /** * Include review history */ includeReviewHistory?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentTags200 = { tags?: Tag[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentsWithPendingMedia200 = { data?: AgentWithPendingMedia[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetAgentsWithPendingMediaParams = { /** * Filter by organization ID */ organization_id?: string; /** * Maximum number of results * @minimum 1 * @maximum 100 */ limit?: number; /** * Number of results to skip * @minimum 0 */ offset?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetConstants200ApprovalSitesItem = { /** Site identifier */ id: string; /** Site slug */ slug: string; /** Display name */ name: string; /** Webhook URL for agent sync */ webhookUrl: string; /** Associated domain names */ associatedDomains: string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Requirements for agent review */ type GetConstants200ReviewRequirements = { /** Minimum number of media items required */ minimumMediaCount: number; /** Required media types */ requiredMediaTypes: string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetConstants200 = { /** Available sites for agent approval */ approvalSites: GetConstants200ApprovalSitesItem[]; /** Requirements for agent review */ reviewRequirements: GetConstants200ReviewRequirements; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Count by media context */ type MediaReviewStatsByContext = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Count by organization */ type MediaReviewStatsByOrganization = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaReviewStats { /** Total items in review queue */ total: number; /** Items available for review */ pending: number; /** Items currently being reviewed */ locked: number; /** Count by media context */ by_context: MediaReviewStatsByContext; /** Count by organization */ by_organization: MediaReviewStatsByOrganization; /** Number of agents with pending media */ agents_with_pending: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetMediaReviewStats200 = { data?: MediaReviewStats; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetMediaReviewStatsParams = { /** * Filter by organization ID */ organization_id?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type GetNextAgentForMediaReview200DataPendingMediaItemReviewMetadata = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForMediaReview200DataPendingMediaItemReview = { id?: string; context?: string; priority?: number; /** @nullable */ locked_by?: string | null; /** @nullable */ locked_until?: string | null; /** @nullable */ metadata?: GetNextAgentForMediaReview200DataPendingMediaItemReviewMetadata; /** @nullable */ generation_job_id?: string | null; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForMediaReview200DataPendingMediaItem = { review?: GetNextAgentForMediaReview200DataPendingMediaItemReview; media?: UnifiedMediaObject; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForMediaReview200DataContext = { agent_id?: string; locked_until?: string; pending_count?: number; organization_id?: string; organization_name?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForMediaReview200Data = { agent?: Agent; pending_media?: GetNextAgentForMediaReview200DataPendingMediaItem[]; context?: GetNextAgentForMediaReview200DataContext; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForMediaReview200 = { data?: GetNextAgentForMediaReview200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForMediaReviewParams = { /** * Filter by organization ID */ organization_id?: string; /** * Include media variants */ includeVariants?: boolean; /** * Include expanded metadata */ includeMetadata?: boolean; /** * Include review history */ includeReviewHistory?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface ReviewLock { agentId?: string; lockedBy?: string; lockedAt?: string; expiresAt?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReview200Data = { agent?: Agent; lock?: ReviewLock; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReview200 = { success?: boolean; data?: GetNextAgentForReview200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReviewAvatar = (typeof GetNextAgentForReviewAvatar)[keyof typeof GetNextAgentForReviewAvatar]; declare const GetNextAgentForReviewAvatar: { readonly true: "true"; readonly false: "false"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReviewBanner = (typeof GetNextAgentForReviewBanner)[keyof typeof GetNextAgentForReviewBanner]; declare const GetNextAgentForReviewBanner: { readonly true: "true"; readonly false: "false"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReviewFullBody = (typeof GetNextAgentForReviewFullBody)[keyof typeof GetNextAgentForReviewFullBody]; declare const GetNextAgentForReviewFullBody: { readonly true: "true"; readonly false: "false"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReviewHeadshot = (typeof GetNextAgentForReviewHeadshot)[keyof typeof GetNextAgentForReviewHeadshot]; declare const GetNextAgentForReviewHeadshot: { readonly true: "true"; readonly false: "false"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextAgentForReviewParams = { /** * Filter agents that have avatar media */ avatar?: GetNextAgentForReviewAvatar; /** * Filter agents that have banner media */ banner?: GetNextAgentForReviewBanner; /** * Filter agents that have headshot media */ headshot?: GetNextAgentForReviewHeadshot; /** * Filter agents that have full body media */ full_body?: GetNextAgentForReviewFullBody; /** * Minimum number of media items required * @minimum 0 */ media_count?: number; /** * Agent ID(s) to exclude from selection */ exclude?: string | string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetNextMediaForReview200 = { data?: MediaReviewItem; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetPopulationJob200 = { job?: PopulationJob; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationStatsAgeDistribution = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationStatsGenderDistribution = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationStatsOccupationDistribution = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationStatsLocationDistribution = { [key: string]: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type PopulationStatsDigitalPresence = { smartphone_users?: number; social_media_active?: number; average_platforms_per_user?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface PopulationStats { total_agents?: number; age_distribution?: PopulationStatsAgeDistribution; gender_distribution?: PopulationStatsGenderDistribution; occupation_distribution?: PopulationStatsOccupationDistribution; location_distribution?: PopulationStatsLocationDistribution; digital_presence?: PopulationStatsDigitalPresence; last_updated?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetPopulationStats200 = { stats?: PopulationStats; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface HealthResponse { ok: boolean; service: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetStartup500AllOf = { /** List of pending migrations */ incomplete?: string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetStartup500 = HealthResponse & GetStartup500AllOf; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type GetTag200 = { tag?: Tag; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type InitializeWorld201 = { world?: World; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Internal server error */ type InternalServerErrorResponse = Error; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Maximum items to return */ type LimitParameter = number; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListAgents200 = { agents?: AgentWithContextResponse[]; /** Total number of agents */ total?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Number of items to skip */ type OffsetParameter = number; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListAgentsParams = { /** * Search agents by name */ search?: string; /** * Maximum items to return * @minimum 1 * @maximum 100 */ limit?: LimitParameter; /** * Number of items to skip * @minimum 0 */ offset?: OffsetParameter; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListAllAgentsGenderItem = (typeof ListAllAgentsGenderItem)[keyof typeof ListAllAgentsGenderItem]; declare const ListAllAgentsGenderItem: { readonly M: "M"; readonly F: "F"; readonly O: "O"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListAllAgentsStatusItem = (typeof ListAllAgentsStatusItem)[keyof typeof ListAllAgentsStatusItem]; declare const ListAllAgentsStatusItem: { readonly active: "active"; readonly inactive: "inactive"; readonly archived: "archived"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListAllAgentsParams = { /** * Page number (1-based) * @minimum 1 */ page?: number; /** * Number of results per page * @minimum 1 * @maximum 120 */ pageSize?: number; /** * Search agents by first name, last name, or full name * @maxLength 255 */ search?: string; /** * Filter by gender (can be repeated for multiple values) */ gender?: ListAllAgentsGenderItem[]; /** * Filter by agent status (can be repeated for multiple values) */ status?: ListAllAgentsStatusItem[]; /** * Filter by specific world IDs (can be repeated for multiple values) */ worlds?: string[]; /** * Minimum age filter * @minimum 0 * @maximum 150 */ ageMin?: number; /** * Maximum age filter * @minimum 0 * @maximum 150 */ ageMax?: number; /** * Filter by a single world ID (alternative to worlds parameter) */ worldId?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListTags200 = { tags?: Tag[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface WorldStats { agent_count?: number; location_count?: number; active_calendars?: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListWorlds200WorldsItemAllOf = { stats?: WorldStats; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListWorlds200WorldsItem = World & ListWorlds200WorldsItemAllOf; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ListWorlds200 = { worlds?: ListWorlds200WorldsItem[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface LocationData { id?: string; name?: string; location_type?: string; world_id?: string; /** @nullable */ parent_location_id?: string | null; created_at?: string; updated_at?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type MediaDetailsType = (typeof MediaDetailsType)[keyof typeof MediaDetailsType]; declare const MediaDetailsType: { readonly image: "image"; readonly video: "video"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type MediaDetailsReviewState = (typeof MediaDetailsReviewState)[keyof typeof MediaDetailsReviewState]; declare const MediaDetailsReviewState: { readonly unreviewed: "unreviewed"; readonly accepted: "accepted"; readonly rejected: "rejected"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * @nullable */ type MediaDetailsMetadata = { [key: string]: unknown; } | null; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaDetails { id: string; type: MediaDetailsType; mime_type: string; url: string; storage_path: string; /** @nullable */ webp_url?: string | null; /** @nullable */ webp_storage_path?: string | null; /** @nullable */ original_url?: string | null; /** @nullable */ original_storage_path?: string | null; /** @nullable */ original_width?: number | null; /** @nullable */ original_height?: number | null; is_cropped: boolean; /** @nullable */ usage?: string | null; /** @nullable */ audience_rating?: string | null; /** @nullable */ caption?: string | null; review_state: MediaDetailsReviewState; /** @nullable */ metadata?: MediaDetailsMetadata; /** @nullable */ width?: number | null; /** @nullable */ height?: number | null; /** @nullable */ size_bytes?: number | null; /** @nullable */ generation_job_id?: string | null; organization_id: string; variants_processed: boolean; /** @nullable */ active_option_id?: string | null; created_at: string; updated_at: string; options?: MediaOption[]; variants?: MediaVariant[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface MediaWithOptions { /** @nullable */ current?: UnifiedMediaObject; options?: UnifiedMediaObject[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Resource not found */ type NotFoundResponse = Error; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface ProcessVariantsRequest { /** Whether to regenerate existing variants */ regenerate?: boolean; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type RejectAgent200Data = { agentId?: string; status?: string; rejectionReason?: string; reviewedAt?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type RejectAgent200 = { success?: boolean; message?: string; data?: RejectAgent200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Optional review metadata */ type RejectAgentRequestMetadata = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface RejectAgentRequest { /** * Reason for rejection * @minLength 1 * @maxLength 1000 */ reason: string; /** * Optional additional notes * @maxLength 5000 */ notes?: string; /** Optional review metadata */ metadata?: RejectAgentRequestMetadata; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type RejectMedia200Data = { success?: boolean; message?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type RejectMedia200 = { data?: RejectMedia200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type RejectMediaBody = { /** * Rejection reason * @minLength 1 */ reason: string; /** Whether to delete the media (default false) */ delete_media?: boolean; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface ReviewStats { /** Number of agents pending review */ pending?: number; /** Number of agents currently locked for review */ locked?: number; /** Number of approved agents */ approved?: number; /** Number of rejected agents */ rejected?: number; /** Number of agents needing changes */ needsChanges?: number; /** Total number of agents */ total?: number; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SetAgentTags200 = { tags?: Tag[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SkipMediaReview200Data = { success?: boolean; message?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SkipMediaReview200 = { data?: SkipMediaReview200Data; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SwitchAgentPrimaryMedia200Type = (typeof SwitchAgentPrimaryMedia200Type)[keyof typeof SwitchAgentPrimaryMedia200Type]; declare const SwitchAgentPrimaryMedia200Type: { readonly avatar: "avatar"; readonly banner: "banner"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SwitchAgentPrimaryMedia200 = { success: boolean; agentId: string; mediaId: string; type: SwitchAgentPrimaryMedia200Type; /** @nullable */ previousMediaId?: string | null; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SwitchAgentPrimaryMediaType = (typeof SwitchAgentPrimaryMediaType)[keyof typeof SwitchAgentPrimaryMediaType]; declare const SwitchAgentPrimaryMediaType: { readonly avatar: "avatar"; readonly banner: "banner"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SwitchAgentPrimaryMediaParams = { /** * Type of media to switch (avatar or banner) */ type: SwitchAgentPrimaryMediaType; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Unauthorized - invalid or missing authentication */ type UnauthorizedResponse = Error; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedAgentObjectGender = (typeof UnifiedAgentObjectGender)[keyof typeof UnifiedAgentObjectGender]; declare const UnifiedAgentObjectGender: { readonly M: "M"; readonly F: "F"; readonly O: "O"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedAgentObjectStatus = (typeof UnifiedAgentObjectStatus)[keyof typeof UnifiedAgentObjectStatus]; declare const UnifiedAgentObjectStatus: { readonly pending: "pending"; readonly active: "active"; readonly retired: "retired"; readonly archived: "archived"; readonly rejected: "rejected"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedAgentObjectPersonality = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedAgentObjectLifeMotivations = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnifiedAgentObjectSelfPerception = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface UnifiedAgentObject { id: string; first_name: string; last_name: string; /** @nullable */ middle_name?: string | null; birth_date: string; gender: UnifiedAgentObjectGender; world_id: string; location_id: string; /** @nullable */ organization_id?: string | null; version: number; status: UnifiedAgentObjectStatus; /** @nullable */ review_state?: string | null; /** @nullable */ locked_by?: string | null; /** @nullable */ locked_at?: string | null; personality: UnifiedAgentObjectPersonality; life_motivations: UnifiedAgentObjectLifeMotivations; self_perception: UnifiedAgentObjectSelfPerception; /** @nullable */ avatar_media_id?: string | null; /** @nullable */ banner_media_id?: string | null; /** @nullable */ headshot_media_id?: string | null; /** @nullable */ full_body_media_id?: string | null; /** @nullable */ cover_media_id?: string | null; created_at: string; updated_at: string; location?: LocationData; tags?: AgentTag[]; calendar_entries?: CalendarEntry[]; avatar_media?: UnifiedMediaObject; banner_media?: UnifiedMediaObject; headshot_media?: UnifiedMediaObject; full_body_media?: UnifiedMediaObject; cover_media?: UnifiedMediaObject; avatars?: MediaWithOptions; banners?: MediaWithOptions; headshots?: MediaWithOptions; full_body?: MediaWithOptions; covers?: MediaWithOptions; avatar_options?: UnifiedMediaObject[]; banner_options?: UnifiedMediaObject[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UnlockAgent200 = { success?: boolean; message?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateAgent200 = { success?: boolean; agent?: Agent; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Type of media */ type UpdateAgentMediaRequestType = (typeof UpdateAgentMediaRequestType)[keyof typeof UpdateAgentMediaRequestType]; declare const UpdateAgentMediaRequestType: { readonly image: "image"; readonly video: "video"; readonly document: "document"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Content rating for appropriate audience */ type UpdateAgentMediaRequestAudienceRating = (typeof UpdateAgentMediaRequestAudienceRating)[keyof typeof UpdateAgentMediaRequestAudienceRating]; declare const UpdateAgentMediaRequestAudienceRating: { readonly G: "G"; readonly PG: "PG"; readonly 'PG-13': "PG-13"; readonly R: "R"; readonly 'NC-17': "NC-17"; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface UpdateAgentMediaRequest { /** * Media title or name * @minLength 1 * @maxLength 255 */ title?: string; /** Type of media */ type?: UpdateAgentMediaRequestType; /** URL to the media file */ url?: string; /** URL to a thumbnail version */ thumbnailUrl?: string; /** * File size in bytes * @minimum 0 */ size?: number; metadata?: MediaMetadata; /** * Context or description * @maxLength 255 */ context?: string; /** * User-visible caption for the media * @maxLength 1000 */ caption?: string; /** * Internal notes about the media (not shown to users) * @maxLength 2000 */ internalThoughts?: string; /** * Value rating from 1-5 * @minimum 1 * @maximum 5 */ valueScore?: number; /** * Trust/authenticity score from 1-5 * @minimum 1 * @maximum 5 */ trustScore?: number; /** Content rating for appropriate audience */ audienceRating?: UpdateAgentMediaRequestAudienceRating; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateAgentRequestMetadata = { [key: string]: unknown; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateAgentRequestPersonality = { description?: string; traits?: string[]; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface UpdateAgentRequest { /** * @minLength 1 * @maxLength 255 */ name?: string; status?: AgentStatus; tags?: string[]; /** * @minLength 1 * @maxLength 100 */ category?: string; metadata?: UpdateAgentRequestMetadata; personality?: UpdateAgentRequestPersonality; /** @maxLength 5000 */ bio?: string; location_id?: string; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateDemographics200 = { world?: World; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateDemographicsBody = { demographic_rules: DemographicRules; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateTag200 = { tag?: Tag; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface UpdateTagInput { /** @maxLength 50 */ name?: string; /** * @nullable * @pattern ^#[0-9A-Fa-f]{6}$ */ color?: string | null; /** @nullable */ description?: string | null; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateWorld200 = { message?: string; world?: World; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Updated configuration settings */ type UpdateWorldBodyConfig = { /** IANA timezone identifier */ timezone?: string; /** * Time interval between simulation ticks (in minutes) * @minimum 1 */ tickInterval?: number; /** * Planning horizon in months * @minimum 1 * @maximum 24 */ planningHorizonMonths?: number; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type UpdateWorldBody = { /** * New name for the world * @minLength 1 * @maxLength 255 */ name?: string; /** Updated configuration settings */ config?: UpdateWorldBodyConfig; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type ValidationErrorValidationErrorsItem = { field?: string; message?: string; }; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ interface ValidationError { error: string; validation_errors?: ValidationErrorValidationErrorsItem[]; } /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ /** * Validation failed */ type ValidationErrorResponse = ValidationError; /** * Generated by orval v7.10.0 🍺 * Do not edit manually. * Companion World API * API for managing virtual worlds populated with AI-driven agents. ## Overview The Companion World API provides endpoints for: - Creating and managing virtual worlds - Generating populations of AI agents - Managing agent activities and calendars - Configuring locations and demographics ## Authentication Currently, the API operates without authentication. This will be updated in future versions. ## Async Operations Long-running operations (like population generation) return job IDs for status polling. * OpenAPI spec version: 1.0.0 */ type SecondParameter unknown> = Parameters[1]; /** * Reports service readiness * @summary Basic health check */ declare const getHealth: (options?: SecondParameter) => Promise; /** * Kubernetes liveness probe endpoint * @summary Liveness probe */ declare const getLiveness: (options?: SecondParameter) => Promise; /** * Checks if database migrations are complete * @summary Startup probe */ declare const getStartup: (options?: SecondParameter) => Promise; /** * Returns system constants including available approval sites and review requirements. Requires authentication and beta approval. * @summary Get system constants */ declare const getConstants: (options?: SecondParameter) => Promise; /** * List agents across all worlds with advanced search and filtering capabilities. Supports pagination, search by name, and filtering by gender, age, status, and specific worlds. * @summary List all agents (global) */ declare const listAllAgents: (params?: ListAllAgentsParams, options?: SecondParameter) => Promise; /** * Retrieve detailed information about a specific agent by ID, regardless of world * @summary Get agent details (global) */ declare const getAgentById: (agentId: string, options?: SecondParameter) => Promise; /** * Update agent properties like name, status, tags, or metadata * @summary Update agent (global) */ declare const updateAgent: (agentId: string, updateAgentRequest: UpdateAgentRequest, options?: SecondParameter) => Promise; /** * Get paginated list of media associated with an agent * @summary List agent media */ declare const getAgentMedia: (agentId: string, params?: GetAgentMediaParams, options?: SecondParameter) => Promise; /** * Add new media to an agent * @summary Create agent media */ declare const createAgentMedia: (agentId: string, createAgentMediaRequest: CreateAgentMediaRequest, options?: SecondParameter) => Promise; /** * Update existing media associated with an agent * @summary Update agent media */ declare const updateAgentMedia: (agentId: string, mediaId: string, updateAgentMediaRequest: UpdateAgentMediaRequest, options?: SecondParameter) => Promise; /** * Remove media from an agent (orphaned media records are automatically cleaned up) * @summary Delete agent media */ declare const deleteAgentMedia: (agentId: string, mediaId: string, options?: SecondParameter) => Promise; /** * Switch an agent's primary avatar or banner to a different available media * @summary Set media as primary avatar or banner */ declare const switchAgentPrimaryMedia: (agentId: string, mediaId: string, params: SwitchAgentPrimaryMediaParams, options?: SecondParameter) => Promise; /** * Create a signed URL for direct media upload to storage * @summary Generate signed URL for media upload */ declare const createAgentMediaUploadUrl: (agentId: string, createUploadUrlRequest: CreateUploadUrlRequest, options?: SecondParameter) => Promise; /** * Update media with new crop dimensions. Preserves the original and regenerates variants from the crop. * @summary Crop existing media */ declare const cropAgentMedia: (agentId: string, mediaId: string, cropMediaRequest: CropMediaRequest, options?: SecondParameter) => Promise; /** * Remove crop from media and restore to original dimensions * @summary Reset media crop */ declare const resetAgentMediaCrop: (agentId: string, mediaId: string, options?: SecondParameter) => Promise; /** * Generate or regenerate media variants (blur, small, medium, large) * @summary Process media variants */ declare const processAgentMediaVariants: (agentId: string, mediaId: string, processVariantsRequest?: ProcessVariantsRequest, options?: SecondParameter) => Promise; /** * Lock and retrieve the next pending agent for review with optional media filtering * @summary Get next agent for review */ declare const getNextAgentForReview: (params?: GetNextAgentForReviewParams, options?: SecondParameter) => Promise; /** * Approve an agent for specified sites * @summary Approve agent */ declare const approveAgent: (agentId: string, approveAgentRequest: ApproveAgentRequest, options?: SecondParameter) => Promise; /** * Reject an agent with a reason * @summary Reject agent */ declare const rejectAgent: (agentId: string, rejectAgentRequest: RejectAgentRequest, options?: SecondParameter) => Promise; /** * Release lock on an agent without approving or rejecting * @summary Unlock agent */ declare const unlockAgent: (agentId: string, options?: SecondParameter) => Promise; /** * Get statistics about the review queue and processed agents * @summary Get review statistics */ declare const getReviewStats: (options?: SecondParameter) => Promise; /** * Retrieves all worlds with statistics * @summary List all worlds */ declare const listWorlds: (options?: SecondParameter) => Promise; /** * Creates and initializes a new virtual world * @summary Create a new world */ declare const initializeWorld: (createWorldRequest: CreateWorldRequest, options?: SecondParameter) => Promise; /** * Updates basic world properties like name and configuration * @summary Update world properties */ declare const updateWorld: (worldId: string, updateWorldBody: UpdateWorldBody, options?: SecondParameter) => Promise; /** * Permanently deletes a world and all associated data (agents, locations, events, etc.) * @summary Delete a world */ declare const deleteWorld: (worldId: string, options?: SecondParameter) => Promise; /** * Updates demographic generation rules for a world * @summary Update demographic rules */ declare const updateDemographics: (worldId: string, updateDemographicsBody: UpdateDemographicsBody, options?: SecondParameter) => Promise; /** * List agents in a world with optional search and pagination * @summary List agents */ declare const listAgents: (worldId: string, params?: ListAgentsParams, options?: SecondParameter) => Promise; /** * Retrieves detailed information about a specific agent * @summary Get agent details */ declare const getAgent: (worldId: string, agentId: string, options?: SecondParameter) => Promise; /** * Retrieves an agent's calendar entries * @summary Get agent calendar */ declare const getAgentCalendar: (worldId: string, agentId: string, params?: GetAgentCalendarParams, options?: SecondParameter) => Promise; /** * Initiates asynchronous batch generation of agents * @summary Generate population */ declare const generatePopulation: (worldId: string, generatePopulationRequest: GeneratePopulationRequest, options?: SecondParameter) => Promise; /** * Checks the status of a population generation job * @summary Get job status */ declare const getPopulationJob: (worldId: string, jobId: string, options?: SecondParameter) => Promise; /** * Retrieves population statistics for a world * @summary Get population statistics */ declare const getPopulationStats: (worldId: string, options?: SecondParameter) => Promise; /** * Creates multiple locations with optional proximity connections * @summary Batch create locations */ declare const batchCreateLocations: (worldId: string, batchCreateLocationsRequest: BatchCreateLocationsRequest, options?: SecondParameter) => Promise; /** * Adds a single name to the world's name pool * @summary Add single name */ declare const addName: (worldId: string, nameEntry: NameEntry, options?: SecondParameter) => Promise; /** * Deletes names from the world's name pool based on filters * @summary Delete names */ declare const deleteNames: (worldId: string, params?: DeleteNamesParams, options?: SecondParameter) => Promise; /** * Adds multiple names to the world's name pool * @summary Batch add names */ declare const batchAddNames: (worldId: string, batchAddNamesBody: BatchAddNamesBody, options?: SecondParameter) => Promise; /** * Retrieves all tags for the organization * @summary List all tags */ declare const listTags: (options?: SecondParameter) => Promise; /** * Creates a new tag for the organization * @summary Create a new tag */ declare const createTag: (createTagInput: CreateTagInput, options?: SecondParameter) => Promise; /** * Retrieves a specific tag by ID * @summary Get a specific tag */ declare const getTag: (tagId: string, options?: SecondParameter) => Promise; /** * Updates an existing tag * @summary Update a tag */ declare const updateTag: (tagId: string, updateTagInput: UpdateTagInput, options?: SecondParameter) => Promise; /** * Deletes a tag (requires admin role) * @summary Delete a tag */ declare const deleteTag: (tagId: string, options?: SecondParameter) => Promise; /** * Retrieves all tags assigned to an agent * @summary Get agent tags */ declare const getAgentTags: (agentId: string, options?: SecondParameter) => Promise; /** * Adds tags to an agent (keeps existing tags) * @summary Add tags to agent */ declare const addAgentTags: (agentId: string, assignTagsInput: AssignTagsInput, options?: SecondParameter) => Promise; /** * Sets the tags for an agent (replaces all existing tags) * @summary Set agent tags */ declare const setAgentTags: (agentId: string, assignTagsInput: AssignTagsInput, options?: SecondParameter) => Promise; /** * Removes specific tags from an agent * @summary Remove tags from agent */ declare const removeAgentTags: (agentId: string, assignTagsInput: AssignTagsInput, options?: SecondParameter) => Promise; /** * Gets the next media item from the review queue for the authenticated reviewer. If the reviewer already has a locked item, returns that item instead. Items are locked for 30 minutes. Excludes media from agents that are locked for review by other reviewers. * @summary Get next media for review */ declare const getNextMediaForReview: (options?: SecondParameter) => Promise; /** * Locks the next agent with pending media for review by the authenticated reviewer. If the reviewer already has an agent locked, returns that agent instead. Agents are locked for 5 minutes to allow bulk review of all their pending media. Returns the agent details along with all pending media items (including full media objects with variants). * @summary Get next agent for media review */ declare const getNextAgentForMediaReview: (params?: GetNextAgentForMediaReviewParams, options?: SecondParameter) => Promise; /** * Approves a media item and removes it from the review queue * @summary Approve media */ declare const approveMedia: (id: string, approveMediaBody: ApproveMediaBody, options?: SecondParameter) => Promise; /** * Rejects a media item and optionally deletes it * @summary Reject media */ declare const rejectMedia: (id: string, rejectMediaBody: RejectMediaBody, options?: SecondParameter) => Promise; /** * Unlocks the media item without taking action, allowing another reviewer to pick it up * @summary Skip media review */ declare const skipMediaReview: (id: string, options?: SecondParameter) => Promise; /** * Get statistics about the media review queue * @summary Get media review statistics */ declare const getMediaReviewStats: (params?: GetMediaReviewStatsParams, options?: SecondParameter) => Promise; /** * Get a list of agents that have media pending review * @summary Get agents with pending media */ declare const getAgentsWithPendingMedia: (params?: GetAgentsWithPendingMediaParams, options?: SecondParameter) => Promise; /** * Get all pending media items for a specific agent for bulk review. Optionally lock items for review to prevent concurrent access. * @summary Get pending media for agent */ declare const getAgentPendingMedia: (agentId: string, params?: GetAgentPendingMediaParams, options?: SecondParameter) => Promise; /** * Get approved media items for a specific agent to use as reference during bulk review of pending media. * @summary Get approved media for agent */ declare const getAgentApprovedMedia: (agentId: string, params?: GetAgentApprovedMediaParams, options?: SecondParameter) => Promise; /** * Perform bulk approve, reject, or skip actions on multiple media items for a specific agent in a single transaction. * @summary Bulk review actions for agent media */ declare const agentBulkMediaAction: (agentId: string, agentBulkMediaActionBody: AgentBulkMediaActionBody, options?: SecondParameter) => Promise; /** * Approve multiple media items at once * @summary Bulk approve media */ declare const bulkApproveMedia: (bulkApproveMediaBody: BulkApproveMediaBody, options?: SecondParameter) => Promise; /** * Reject multiple media items at once * @summary Bulk reject media */ declare const bulkRejectMedia: (bulkRejectMediaBody: BulkRejectMediaBody, options?: SecondParameter) => Promise; type GetHealthResult = NonNullable>>; type GetLivenessResult = NonNullable>>; type GetStartupResult = NonNullable>>; type GetConstantsResult = NonNullable>>; type ListAllAgentsResult = NonNullable>>; type GetAgentByIdResult = NonNullable>>; type UpdateAgentResult = NonNullable>>; type GetAgentMediaResult = NonNullable>>; type CreateAgentMediaResult = NonNullable>>; type UpdateAgentMediaResult = NonNullable>>; type DeleteAgentMediaResult = NonNullable>>; type SwitchAgentPrimaryMediaResult = NonNullable>>; type CreateAgentMediaUploadUrlResult = NonNullable>>; type CropAgentMediaResult = NonNullable>>; type ResetAgentMediaCropResult = NonNullable>>; type ProcessAgentMediaVariantsResult = NonNullable>>; type GetNextAgentForReviewResult = NonNullable>>; type ApproveAgentResult = NonNullable>>; type RejectAgentResult = NonNullable>>; type UnlockAgentResult = NonNullable>>; type GetReviewStatsResult = NonNullable>>; type ListWorldsResult = NonNullable>>; type InitializeWorldResult = NonNullable>>; type UpdateWorldResult = NonNullable>>; type DeleteWorldResult = NonNullable>>; type UpdateDemographicsResult = NonNullable>>; type ListAgentsResult = NonNullable>>; type GetAgentResult = NonNullable>>; type GetAgentCalendarResult = NonNullable>>; type GeneratePopulationResult = NonNullable>>; type GetPopulationJobResult = NonNullable>>; type GetPopulationStatsResult = NonNullable>>; type BatchCreateLocationsResult = NonNullable>>; type AddNameResult = NonNullable>>; type DeleteNamesResult = NonNullable>>; type BatchAddNamesResult = NonNullable>>; type ListTagsResult = NonNullable>>; type CreateTagResult = NonNullable>>; type GetTagResult = NonNullable>>; type UpdateTagResult = NonNullable>>; type DeleteTagResult = NonNullable>>; type GetAgentTagsResult = NonNullable>>; type AddAgentTagsResult = NonNullable>>; type SetAgentTagsResult = NonNullable>>; type RemoveAgentTagsResult = NonNullable>>; type GetNextMediaForReviewResult = NonNullable>>; type GetNextAgentForMediaReviewResult = NonNullable>>; type ApproveMediaResult = NonNullable>>; type RejectMediaResult = NonNullable>>; type SkipMediaReviewResult = NonNullable>>; type GetMediaReviewStatsResult = NonNullable>>; type GetAgentsWithPendingMediaResult = NonNullable>>; type GetAgentPendingMediaResult = NonNullable>>; type GetAgentApprovedMediaResult = NonNullable>>; type AgentBulkMediaActionResult = NonNullable>>; type BulkApproveMediaResult = NonNullable>>; type BulkRejectMediaResult = NonNullable>>; declare const SDK_VERSION = "0.1.0"; export { type AddAgentTags200, type AddAgentTagsResult, type AddName201, type AddNameResult, type AgeDistribution, AgeDistributionDistribution, type Agent, type AgentBulkMediaAction200, type AgentBulkMediaAction200Data, type AgentBulkMediaAction200DataResults, type AgentBulkMediaAction200DataResultsFailedItem, type AgentBulkMediaAction200DataResultsSuccessfulItem, type AgentBulkMediaActionBody, type AgentBulkMediaActionBodyActionsItem, AgentBulkMediaActionBodyActionsItemAction, type AgentBulkMediaActionResult, type AgentMedia, type AgentMediaItem, AgentMediaItemType, type AgentMediaResponse, type AgentResponse, AgentReviewStatus, AgentStatus, AgentStatusProperty, type AgentTag, type AgentWithContextResponse, type AgentWithContextResponseData, type AgentWithContextResponseDataContext, type AgentWithPendingMedia, type AgentsResponse, type ApproveAgent200, type ApproveAgent200Data, type ApproveAgentRequest, type ApproveAgentRequestMetadata, type ApproveAgentResult, type ApproveMedia200, type ApproveMedia200Data, type ApproveMediaBody, type ApproveMediaResult, type AssignTagsInput, type BadRequestResponse, type BatchAddNames201, type BatchAddNamesBody, type BatchAddNamesResult, type BatchCreateLocations201, type BatchCreateLocationsRequest, type BatchCreateLocationsRequestLocationsItem, type BatchCreateLocationsRequestLocationsItemCapacity, type BatchCreateLocationsResult, type BatchNameResult, type BulkApproveMedia200, type BulkApproveMedia200Data, type BulkApproveMediaBody, type BulkApproveMediaResult, type BulkRejectMedia200, type BulkRejectMedia200Data, type BulkRejectMediaBody, type BulkRejectMediaResult, type CalendarEntry, CalendarEntryActivityType, type CalendarEntryParticipantsItem, CalendarEntryRecurrencePattern, type Coordinates, type CreateAgentMediaRequest, CreateAgentMediaRequestAudienceRating, CreateAgentMediaRequestType, type CreateAgentMediaResult, type CreateAgentMediaUploadUrlResult, type CreateTag201, type CreateTagInput, type CreateTagResult, type CreateUploadUrlRequest, CreateUploadUrlRequestAudienceRating, CreateUploadUrlRequestMediaType, type CreateUploadUrlResponse, type CreateWorldRequest, type CropAgentMediaResult, type CropMediaRequest, type CropMediaRequestDimensions, type CropMediaResponse, type CropMediaResponseCropData, type DayHours, type DeleteAgentMediaResult, type DeleteNames200, type DeleteNamesParams, type DeleteNamesResult, type DeleteTagResult, type DeleteWorld200, type DeleteWorldResult, type DemographicRules, type Demographics, DemographicsIncomeLevel, DemographicsRelationshipStatus, type DigitalPresence, DigitalPresenceSocialMediaActivity, Era, type Error, type ForbiddenResponse, Gender, type GeneratePopulation202, type GeneratePopulationRequest, type GeneratePopulationRequestGenerationRules, type GeneratePopulationRequestGenerationRulesDemographicOverrides, type GeneratePopulationRequestGenerationRulesInitialState, type GeneratePopulationResult, type GetAgentApprovedMedia200, type GetAgentApprovedMedia200Data, type GetAgentApprovedMediaParams, type GetAgentApprovedMediaResult, type GetAgentByIdParams, type GetAgentByIdResult, type GetAgentCalendar200, type GetAgentCalendarParams, type GetAgentCalendarResult, type GetAgentMediaParams, type GetAgentMediaResult, type GetAgentPendingMedia200, type GetAgentPendingMedia200Data, type GetAgentPendingMedia200DataPendingMediaItem, type GetAgentPendingMediaParams, type GetAgentPendingMediaResult, type GetAgentResult, type GetAgentTags200, type GetAgentTagsResult, type GetAgentsWithPendingMedia200, type GetAgentsWithPendingMediaParams, type GetAgentsWithPendingMediaResult, type GetConstants200, type GetConstants200ApprovalSitesItem, type GetConstants200ReviewRequirements, type GetConstantsResult, type GetHealthResult, type GetLivenessResult, type GetMediaReviewStats200, type GetMediaReviewStatsParams, type GetMediaReviewStatsResult, type GetNextAgentForMediaReview200, type GetNextAgentForMediaReview200Data, type GetNextAgentForMediaReview200DataContext, type GetNextAgentForMediaReview200DataPendingMediaItem, type GetNextAgentForMediaReview200DataPendingMediaItemReview, type GetNextAgentForMediaReview200DataPendingMediaItemReviewMetadata, type GetNextAgentForMediaReviewParams, type GetNextAgentForMediaReviewResult, type GetNextAgentForReview200, type GetNextAgentForReview200Data, GetNextAgentForReviewAvatar, GetNextAgentForReviewBanner, GetNextAgentForReviewFullBody, GetNextAgentForReviewHeadshot, type GetNextAgentForReviewParams, type GetNextAgentForReviewResult, type GetNextMediaForReview200, type GetNextMediaForReviewResult, type GetPopulationJob200, type GetPopulationJobResult, type GetPopulationStats200, type GetPopulationStatsResult, type GetReviewStatsResult, type GetStartup500, type GetStartup500AllOf, type GetStartupResult, type GetTag200, type GetTagResult, type HealthResponse, type InitializeWorld201, type InitializeWorldResult, type InternalServerErrorResponse, type LimitParameter, type ListAgents200, type ListAgentsParams, type ListAgentsResult, ListAllAgentsGenderItem, type ListAllAgentsParams, type ListAllAgentsResult, ListAllAgentsStatusItem, type ListTags200, type ListTagsResult, type ListWorlds200, type ListWorlds200WorldsItem, type ListWorlds200WorldsItemAllOf, type ListWorldsResult, type Location, type LocationCapacity, type LocationConnection, type LocationData, type LocationDistribution, type LocationDistributionRegionsItem, type LocationReference, LocationType, type MediaDetails, type MediaDetailsMetadata, MediaDetailsReviewState, MediaDetailsType, type MediaMetadata, type MediaMetadataGeneratedInfo, type MediaMetadataTechnicalInfo, type MediaOption, type MediaOptionMetadata, type MediaReview, type MediaReviewItem, type MediaReviewItemMetadata, type MediaReviewStats, type MediaReviewStatsByContext, type MediaReviewStatsByOrganization, type MediaSelection, type MediaVariant, type MediaVariantMetadata, type MediaWithOptions, type NameDistribution, type NameDistributionEraWeights, type NameDistributionGenderRatio, type NameDistributionOriginWeights, type NameEntry, NameFrequency, type NotFoundResponse, type OffsetParameter, type OperatingHours, type PaginationInfo, type Personality, type PersonalityRawData, type PopulationJob, type PopulationJobGenerationRules, type PopulationJobResultSummary, type PopulationJobResultSummaryGenderDistribution, PopulationJobStatus, type PopulationStats, type PopulationStatsAgeDistribution, type PopulationStatsDigitalPresence, type PopulationStatsGenderDistribution, type PopulationStatsLocationDistribution, type PopulationStatsOccupationDistribution, type ProcessAgentMediaVariantsResult, type ProcessVariantsRequest, type RejectAgent200, type RejectAgent200Data, type RejectAgentRequest, type RejectAgentRequestMetadata, type RejectAgentResult, type RejectMedia200, type RejectMedia200Data, type RejectMediaBody, type RejectMediaResult, type RemoveAgentTagsResult, type ResetAgentMediaCropResult, type ReviewLock, type ReviewMetadata, type ReviewStats, SDK_VERSION, type SetAgentTags200, type SetAgentTagsResult, type SkipMediaReview200, type SkipMediaReview200Data, type SkipMediaReviewResult, type SwitchAgentPrimaryMedia200, SwitchAgentPrimaryMedia200Type, type SwitchAgentPrimaryMediaParams, type SwitchAgentPrimaryMediaResult, SwitchAgentPrimaryMediaType, type Tag, type UnauthorizedResponse, type UnifiedAgentObject, UnifiedAgentObjectGender, type UnifiedAgentObjectLifeMotivations, type UnifiedAgentObjectPersonality, type UnifiedAgentObjectSelfPerception, UnifiedAgentObjectStatus, type UnifiedMediaObject, type UnifiedMediaObjectCropData, type UnifiedMediaObjectCropHistoryItem, type UnifiedMediaObjectMetadata, type UnifiedMediaObjectMetadataExpanded, UnifiedMediaObjectType, UnifiedMediaObjectUsage, type UnlockAgent200, type UnlockAgentResult, type UpdateAgent200, type UpdateAgentMediaRequest, UpdateAgentMediaRequestAudienceRating, UpdateAgentMediaRequestType, type UpdateAgentMediaResult, type UpdateAgentRequest, type UpdateAgentRequestMetadata, type UpdateAgentRequestPersonality, type UpdateAgentResult, type UpdateDemographics200, type UpdateDemographicsBody, type UpdateDemographicsResult, type UpdateTag200, type UpdateTagInput, type UpdateTagResult, type UpdateWorld200, type UpdateWorldBody, type UpdateWorldBodyConfig, type UpdateWorldResult, type ValidationError, type ValidationErrorResponse, type ValidationErrorValidationErrorsItem, type World, type WorldApiConfig, type WorldConfig, type WorldStats, addAgentTags, addName, agentBulkMediaAction, approveAgent, approveMedia, batchAddNames, batchCreateLocations, bulkApproveMedia, bulkRejectMedia, createAgentMedia, createAgentMediaUploadUrl, createTag, cropAgentMedia, deleteAgentMedia, deleteNames, deleteTag, deleteWorld, generatePopulation, getAgent, getAgentApprovedMedia, getAgentById, getAgentCalendar, getAgentMedia, getAgentPendingMedia, getAgentTags, getAgentsWithPendingMedia, getConstants, getHealth, getLiveness, getMediaReviewStats, getNextAgentForMediaReview, getNextAgentForReview, getNextMediaForReview, getPopulationJob, getPopulationStats, getReviewStats, getStartup, getTag, getWorldApiConfig, initializeWorld, listAgents, listAllAgents, listTags, listWorlds, processAgentMediaVariants, rejectAgent, rejectMedia, removeAgentTags, resetAgentMediaCrop, setAgentTags, setWorldApiConfig, skipMediaReview, switchAgentPrimaryMedia, unlockAgent, updateAgent, updateAgentMedia, updateDemographics, updateTag, updateWorld };