@orchard9ai/world-api-sdk

import { AxiosRequestConfig } from 'axios'; interface WorldApiConfig { baseURL: string; apiKey?: string; organizationId?: string; accessToken?: string; } declare const setWorldApiConfig: (newConfig: Partial<WorldApiConfig>) => void; declare const getWorldApiConfig: () => WorldApiConfig; declare const customInstance: <T>(config: AxiosRequestConfig, options?: AxiosRequestConfig) => Promise<T>; /** * 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 oper