Moveo

App · 15 actions

Work with your Moveo.AI conversational AI: chat with and classify text through your AI agents, manage contacts, search knowledge bases, and read campaigns and conversations.

Actions

ActionWhat it does
Classify textFind the intents and entities an AI agent recognises in messages, one message per line.
Create contactAdd a contact.
Delete contactDelete a contact.
Get AI agentGet one AI agent: its language, description and status.
Get campaignGet one campaign: its type, status and dates.
Get contactGet one contact with their details and custom fields.
List AI agentsList your AI agents with their language and status.
List campaignsList campaigns, filtered by type, status or name.
List contactsList contacts, or search them by name, email or phone.
List conversationsList the conversations in an environment, filtered by status or AI agent.
List environmentsList the environments (workspaces) where conversations are stored.
List knowledge basesList the knowledge bases your AI agents answer from.
Search knowledge baseSearch a knowledge base and get the best matching documents, ranked.
Send message to AI agentSend a message to an AI agent and get its reply.
Update contactChange fields on a contact.

Classify text

Find the intents and entities an AI agent recognises in messages, one message per line. The agent must be trained.

Inputs

AI agentbrain_idtextRequired
The AI agent. Pick one, or give its id from an earlier step.
MessagestextstextRequired
The messages to classify, one per line (up to 1000).

Outputs

countnumber
How many messages
resultslist
One result per message: processed_text, intents, entities and entropies
Example output
{
  "count": 1,
  "results": [
    {
      "entities": [],
      "entropies": [
        0.1
      ],
      "intents": [
        {
          "confidence": 0.95,
          "intent": "order_status"
        }
      ],
      "processed_text": "where is my order"
    }
  ]
}

Create contact

Add a contact. Give a name and at least an email or a phone number. A later message from that email or number reaches this contact instead of making a duplicate.

Inputs

NamenametextRequired
The contact's name.
Emailemailtext
The contact's email address. Stored in lowercase.
Phonephonetext
The contact's phone number with its country code, like +15555555555. Moveo stores it in that format.
Time zonetime_zonetext
The contact's time zone, such as America/New_York.
Languagelanguagetext
The contact's language code, such as en.
Roleroletext
The contact's role or job title.
External IDexternal_idtext
An id for this contact from your own system.
Custom fieldscustom_fieldsobject
Extra details as names and values (text, numbers or true/false). Each name must already be defined as a custom field in Moveo.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "contact_id": "c0ffee00-1234-4abc-8def-0123456789ab",
    "created": "2026-10-01T09:00:00Z",
    "custom_fields": {
      "plan": "pro"
    },
    "deceased": false,
    "email": "ada@example.com",
    "external_id": "crm-1001",
    "language": "en",
    "last_contacted": "2026-10-19T09:00:00Z",
    "last_replied": "2026-10-20T09:05:00Z",
    "last_seen": "2026-10-20T09:00:00Z",
    "name": "Ada Lovelace",
    "phone": "+15555550100",
    "role": "Engineer",
    "source": "manual",
    "time_zone": "Europe/London",
    "updated": "2026-10-01T09:00:00Z"
  }
}

Delete contact

Delete a contact. This cannot be undone.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or 'Create contact'.

Outputs

contact_idtext
The contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "contact_id": "c0ffee00-1234-4abc-8def-0123456789ab",
  "deleted": true
}

Get AI agent

Get one AI agent: its language, description and status.

Inputs

AI agentbrain_idtextRequired
The AI agent. Pick one, or give its id from an earlier step.

Outputs

brainobject
The AI agent
Example output
{
  "brain": {
    "brain_id": "b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "confidence_threshold": 0.7,
    "created": "2026-09-01T09:00:00Z",
    "description": "Answers customer questions",
    "inactivity_timeout": 900,
    "language": "en",
    "name": "Support agent",
    "status": "ready",
    "updated": "2026-10-01T09:00:00Z"
  }
}

Get campaign

Get one campaign: its type, status and dates.

Inputs

Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "campaign_id": "ca11ba11-0000-4000-8000-00000000c0de",
    "created": "2026-10-01T09:00:00Z",
    "name": "Renewal reminder",
    "started": "2026-10-10T09:00:00Z",
    "status": "sent",
    "type": "utility",
    "updated": "2026-10-10T09:00:00Z"
  }
}

Get contact

Get one contact with their details and custom fields.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or 'Create contact'.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "contact_id": "c0ffee00-1234-4abc-8def-0123456789ab",
    "created": "2026-10-01T09:00:00Z",
    "custom_fields": {
      "plan": "pro"
    },
    "deceased": false,
    "email": "ada@example.com",
    "external_id": "crm-1001",
    "language": "en",
    "last_contacted": "2026-10-19T09:00:00Z",
    "last_replied": "2026-10-20T09:05:00Z",
    "last_seen": "2026-10-20T09:00:00Z",
    "name": "Ada Lovelace",
    "phone": "+15555550100",
    "role": "Engineer",
    "source": "manual",
    "time_zone": "Europe/London",
    "updated": "2026-10-01T09:00:00Z"
  }
}

List AI agents

List your AI agents with their language and status. Gets one page; to see more, run it again with the next page it gives.

Inputs

Name containsnametext
Only those whose name matches this text.
Page sizelimitnumber
How many to return, 1 to 100. Moveo's default is 50.From 1 to 100.
Next page cursornext_cursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

brainslist
The AI agents
countnumber
How many on this page
has_moretrue/false
True when there is another page
next_cursortext
Pass as 'next_cursor' for the next page; empty on the last one
Example output
{
  "brains": [
    {
      "brain_id": "b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "confidence_threshold": 0.7,
      "created": "2026-09-01T09:00:00Z",
      "description": "Answers customer questions",
      "inactivity_timeout": 900,
      "language": "en",
      "name": "Support agent",
      "status": "ready",
      "updated": "2026-10-01T09:00:00Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List campaigns

List campaigns, filtered by type, status or name. Gets one page; to see more, run it again with the next page it gives.

Inputs

Typecampaign_typetext
Only campaigns of this type.One of: marketing, sales, utility, payment_recovery (Payment recovery).
Statusstatustext
Only campaigns in this state.One of: draft, ready, in_progress (In progress), sent, canceled, failed.
Name containsnametext
Only those whose name matches this text.
Page sizelimitnumber
How many to return, 1 to 100. Moveo's default is 50.From 1 to 100.
Next page cursornext_cursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

campaignslist
The campaigns
countnumber
How many on this page
has_moretrue/false
True when there is another page
next_cursortext
Pass as 'next_cursor' for the next page; empty on the last one
Example output
{
  "campaigns": [
    {
      "campaign_id": "ca11ba11-0000-4000-8000-00000000c0de",
      "created": "2026-10-01T09:00:00Z",
      "name": "Renewal reminder",
      "started": "2026-10-10T09:00:00Z",
      "status": "sent",
      "type": "utility",
      "updated": "2026-10-10T09:00:00Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List contacts

List contacts, or search them by name, email or phone. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchqtext
Find contacts by name, email or phone. At least three letters or digits.
How the contact was addedsourcetext
Only contacts added this way.One of: inbound (Inbound (started a conversation)), outbound (Outbound (was messaged)), manual (Manual (added by hand or API)).
Page sizelimitnumber
How many to return, 1 to 100. Moveo's default is 50.From 1 to 100.
Next page cursornext_cursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

contactslist
The contacts
countnumber
How many on this page
has_moretrue/false
True when there is another page
next_cursortext
Pass as 'next_cursor' for the next page; empty on the last one
Example output
{
  "contacts": [
    {
      "contact_id": "c0ffee00-1234-4abc-8def-0123456789ab",
      "created": "2026-10-01T09:00:00Z",
      "custom_fields": {
        "plan": "pro"
      },
      "deceased": false,
      "email": "ada@example.com",
      "external_id": "crm-1001",
      "language": "en",
      "last_contacted": "2026-10-19T09:00:00Z",
      "last_replied": "2026-10-20T09:05:00Z",
      "last_seen": "2026-10-20T09:00:00Z",
      "name": "Ada Lovelace",
      "phone": "+15555550100",
      "role": "Engineer",
      "source": "manual",
      "time_zone": "Europe/London",
      "updated": "2026-10-01T09:00:00Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List conversations

List the conversations in an environment, filtered by status or AI agent. Gets one page; to see more, run it again with the next page it gives.

Inputs

Environmentdesk_idtextRequired
The environment the conversations are stored in. Pick one, or give its id.
Statusstatustext
Only conversations in this state.One of: open, closed, trash, spam.
AI agentbrain_idtext
Only conversations handled by this AI agent.
Page sizelimitnumber
How many to return, 1 to 100. Moveo's default is 50.From 1 to 100.
Next page cursornext_cursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

conversationslist
The conversations
countnumber
How many on this page
has_moretrue/false
True when there is another page
next_cursortext
Pass as 'next_cursor' for the next page; empty on the last one
Example output
{
  "conversations": [
    {
      "created": "2026-10-20T09:00:00Z",
      "message_count": 4,
      "session_id": "5e55a0a0-1111-4222-8333-444455556666",
      "status": "open",
      "updated": "2026-10-20T09:05:00Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

List environments

List the environments (workspaces) where conversations are stored. Gets one page; to see more, run it again with the next page it gives.

Inputs

Name containsnametext
Only those whose name matches this text.
Page sizelimitnumber
How many to return, 1 to 100. Moveo's default is 50.From 1 to 100.
Next page cursornext_cursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
deskslist
The environments
has_moretrue/false
True when there is another page
next_cursortext
Pass as 'next_cursor' for the next page; empty on the last one
Example output
{
  "count": 1,
  "desks": [
    {
      "account_id": "7e6d5c4b-3a29-4f18-a0b1-c2d3e4f5a6b7",
      "created": "2026-09-01T09:00:00Z",
      "desk_id": "0a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
      "name": "Production",
      "updated": "2026-10-01T09:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List knowledge bases

List the knowledge bases your AI agents answer from. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. Moveo's default is 50.From 1 to 100.
Next page cursornext_cursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

collectionslist
The knowledge bases
countnumber
How many on this page
has_moretrue/false
True when there is another page
next_cursortext
Pass as 'next_cursor' for the next page; empty on the last one
Example output
{
  "collections": [
    {
      "collection_id": "d4c3b2a1-f0e9-4d8c-b7a6-5f4e3d2c1b0a",
      "created": "2026-09-01T09:00:00Z",
      "fragment_count": 42,
      "language": "en",
      "name": "Help centre",
      "updated": "2026-10-01T09:00:00Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": ""
}

Search knowledge base

Search a knowledge base and get the best matching documents, ranked. Searches by meaning unless you choose exact words.

Inputs

Knowledge basecollection_idtextRequired
The knowledge base. Pick one, or give its id from an earlier step.
Search forquerytextRequired
What to look for, in plain words.
Search bymodetext
Meaning finds related text; exact words need a match.One of: semantic (By meaning (default)), keyword (By exact words).
Most documentslimitnumber
How many documents to return, 1 to 20. Moveo's default is 5.From 1 to 20.

Outputs

countnumber
How many matched
documentslist
The matching documents, best first
Example output
{
  "count": 1,
  "documents": [
    {
      "content": "...",
      "score": 0.82,
      "title": "Refund policy"
    }
  ]
}

Send message to AI agent

Send a message to an AI agent and get its reply. Starts a new test conversation unless you give a Conversation ID from an earlier message. Moveo bills each message.

Inputs

AI agentbrain_idtextRequired
The AI agent. Pick one, or give its id from an earlier step.
MessagetexttextRequired
What to say to the AI agent.
Conversation IDsession_idtext
To carry on a conversation, the 'session_id' an earlier message returned. Leave empty to start a new one.
Your nameuser_nametext
The name the AI agent sees. Defaults to Lodol.

Outputs

entitieslist
The entities Moveo found in the message
intentslist
The intents Moveo found in the message
replieslist
Each piece of text the AI agent said
replytext
Everything the AI agent said, one line each
responseslist
Moveo's full reply actions (buttons, cards and so on)
session_idtext
The conversation's id; pass it to the next message
Example output
{
  "entities": [],
  "intents": [
    {
      "confidence": 0.98,
      "intent": "greeting"
    }
  ],
  "replies": [
    "Hello! How can I help?"
  ],
  "reply": "Hello! How can I help?",
  "responses": [
    {
      "text": "Hello! How can I help?",
      "type": "text"
    }
  ],
  "session_id": "5e55a0a0-1111-4222-8333-444455556666"
}

Update contact

Change fields on a contact. Only the fields you fill in change; empty ones are left as they are.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or 'Create contact'.
Namenametext
A new name for the contact.
Emailemailtext
The contact's email address. Stored in lowercase.
Phonephonetext
The contact's phone number with its country code, like +15555555555. Moveo stores it in that format.
Time zonetime_zonetext
The contact's time zone, such as America/New_York.
Languagelanguagetext
The contact's language code, such as en.
Roleroletext
The contact's role or job title.
External IDexternal_idtext
An id for this contact from your own system.
Custom fieldscustom_fieldsobject
Extra details as names and values (text, numbers or true/false). Each name must already be defined as a custom field in Moveo.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "contact_id": "c0ffee00-1234-4abc-8def-0123456789ab",
    "created": "2026-10-01T09:00:00Z",
    "custom_fields": {
      "plan": "pro"
    },
    "deceased": false,
    "email": "ada@example.com",
    "external_id": "crm-1001",
    "language": "en",
    "last_contacted": "2026-10-19T09:00:00Z",
    "last_replied": "2026-10-20T09:05:00Z",
    "last_seen": "2026-10-20T09:00:00Z",
    "name": "Ada Lovelace",
    "phone": "+15555550100",
    "role": "Engineer",
    "source": "manual",
    "time_zone": "Europe/London",
    "updated": "2026-10-01T09:00:00Z"
  }
}

On this page