TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.4. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Variable createMapAgentConst

    createMapAgent: <CS extends ToolState = ToolState>(
        map: TomTomMap,
        options: MapAgentOptions<CS>,
    ) => MapAgentInstance<CS>

    Creates a conversational agent toolkit that gives an LLM control over a TomTom map.

    It returns a ToolLoopAgent instance (compatible with DirectChatTransport) with state and destroy attached. Classification runs transparently inside prepareStep, so you need no wrapper type.

    Type Declaration

    Public Preview until the plugin's 1.0.0 release.

    import { createMapAgent } from '@tomtom-org/maps-sdk-plugin-agent-toolkit';
    import { openai } from '@ai-sdk/openai';
    import { useChat } from '@ai-sdk/react';
    import { DirectChatTransport } from 'ai';

    const agent = createMapAgent(map, { model: openai('gpt-4o') });

    // Works directly with DirectChatTransport — no .agent property needed
    const { messages, sendMessage } = useChat({
      transport: new DirectChatTransport({ agent }),
    });

    const agent = createMapAgent(map, {
      model: openai('gpt-4o'),
      tools: {
        getCustomLocation: myLocationTool,  // add custom
        setLanguage: false,                 // remove default
      },
    });

    Settings
    Member Visibility