Skip to main content

Moveo Authoring API Overview

The Moveo Authoring API provides a comprehensive set of REST endpoints for building, managing, and interacting with AI agents and their components. This API allows you to create sophisticated conversational AI solutions programmatically.

Authentication​

All API requests must be authenticated using an API key. API keys can be created in the Moveo platform under Deploy → Developer Tools → API Keys. There are two types of API keys available:

  • Use: Grants access to core functionality like sending messages and classifying intents
  • Manage: Provides full access to create, modify, and delete resources

For more information about API keys, see API Keys documentation.

Core Components​

The Moveo Authoring API is organized around several key components:

AI Agents (Formerly called brains)​

  • Create and manage AI agents - AI Agents documentation
  • Configure agent behavior and responses
  • Send messages to agents
  • Test and validate agent responses

Intents and Entities​

  • Define conversation intents - Entities documentation
  • Create and manage entities
  • Configure intent recognition
  • Generate intents automatically

Dialogs​

  • Create and manage conversation flows - Create your first AI Agent
  • Configure dialog branches
  • Generate dialogs automatically
  • Update dialog collections

Language Models​

Collections and Datasources​

  • Manage document collections - Collections documentation
  • Configure data sources
  • Sync and update data
  • Handle document processing

Key Features​

  1. AI Agent Management

    • Create and configure AI agents
    • Send messages and receive responses
    • Test and validate agent behavior
    • Manage agent versions

  2. Natural Language Processing

    • Intent classification
    • Entity recognition
    • Language model configuration
    • Automatic intent and dialog generation

  3. Conversation Management

    • Dialog flow configuration
    • Response handling
    • Context management
    • Webhook integration - Webhooks documentation

  4. Data Management

    • Document processing
    • Data source integration
    • Collection management
    • Version control

Getting Started​

To start using the Moveo Authoring API:

  1. Create an API key in the Moveo platform
  2. Review the API documentation for specific endpoints
  3. Use the API key to authenticate your requests
  4. Start building your AI solution

Rate Limits​

The API has rate limits to ensure fair usage and system stability. Specific rate limits are documented with each endpoint.

Error Handling​

The API uses standard HTTP status codes to indicate success or failure of requests. Detailed error messages are provided in the response body when errors occur.

Best Practices​

  1. Always store API keys securely
  2. Implement proper error handling
  3. Use appropriate rate limiting in your application
  4. Test thoroughly in a development environment before production use

Support​

For additional support or questions about the Moveo Authoring API, please contact the Moveo support team or refer to the detailed API documentation for specific endpoints.

Last updated on