Raia AI

App · 25 actions

Create Raia users and conversations, send messages and prompts, and read agent knowledge and usage.

Actions

ActionWhat it does
Create a conversation userCreate a conversation user with an email address or a phone number.
Create a new conversationCreate a conversation.
Create a prompt requestSubmit a prompt and get back an ID for fetching the response later.
Create or update conversation message feedbackAdd or update feedback on a message in a conversation.
Delete conversation user by IDDelete a conversation user by ID.
Find user by contact informationFind a user by email address, phone number or your own reference ID, with their conversation IDs for the current agent.
Get a response on prompt requestGet the response to a prompt by its ID.
Get agent by API keyGet the details of the agent your API key belongs to.
Get agent file by IDGet one of the agent's files by ID.
Get agent limits by Agent API keyGet the limits of the agent your API key belongs to.
Get agent usage by Agent API keyGet the usage of the agent your API key belongs to.
Get agent users by Agent API keyList the agent's users, with their details.
Get conversation by IDGet a conversation and its details by ID.
Get conversation messagesGet all the messages in a conversation.
Get conversation statesList the conversation states available to the agent.
Get conversation user by IDGet a conversation user by ID.
Get conversation user limits by IDGet a conversation user's limits by their ID.
Get conversationsList the agent's conversations, with their details.
Get paginated agent files by API keyList the agent's files, sorted.
Get response onGet the agent's response to a message in a conversation.
Process a prompt requestSend a prompt and wait for the agent's AI-generated response.
Send a message to an agentSend a message to the agent in a conversation.
Send a message to an agent (async)Send a message to the agent in a conversation.
Update conversationUpdate a conversation by ID.
Update conversation modeChange a conversation's mode.

Create a conversation user

Create a conversation user with an email address or a phone number.

Inputs

First namefirst_nametextRequired
User first name
Last namelast_nametextRequired
User last name
Contextcontexttext
User context
Sourcesourcetext
User source
Fk user IDfk_user_idtext
User fkUserId
Custom datacustom_dataobject
Conversation user custom data
Skip phone number validationskip_phone_number_validationtrue/false
Skip phone number validation
Skip email validationskip_email_validationtrue/false
Skip email validation
Phone numberphone_numbertext
User phone number
Emailemailtext
User email
Fk IDfk_idtext
User fkId

Outputs

responseobject
Response.
Example output
{
  "response": {
    "context": "example",
    "email": "example",
    "firstName": "example",
    "fkId": "example",
    "fkUserId": "example",
    "id": "example",
    "isAnonymized": false,
    "lastName": "example",
    "metadata": {},
    "phoneNumber": "example",
    "source": "example"
  }
}

Create a new conversation

Create a conversation. Returns its ID.

Inputs

Conversation user IDconversation_user_idtextRequired
Conversation user ID
Titletitletext
Conversation title
Contextcontexttext
Conversation context
Custom datacustom_dataobject
Conversation custom data
Conversation state IDconversation_state_idtext
Conversation state ID

Outputs

responseobject
Response.
Example output
{
  "response": {
    "aiCallId": "example",
    "analysisStatus": "not_started",
    "analyzedAt": "2026-10-24T12:00:00Z",
    "assignedUser": {
      "avatarUrl": "example",
      "email": "example",
      "firstName": "example",
      "id": "example",
      "lastName": "example",
      "phoneNumber": "example"
    },
    "conversationStateId": "example",
    "conversationUserId": "example",
    "createdAt": "2026-10-24T12:00:00Z",
    "id": "example",
    "isAnonymized": false,
    "metadata": {},
    "mode": "manual",
    "score": 1,
    "summary": "example",
    "title": "example",
    "updatedAt": "2026-10-24T12:00:00Z",
    "user": {
      "context": "example",
      "email": "example",
      "firstName": "example",
      "fkId": "example",
      "fkUserId": "example",
      "id": "example",
      "isAnonymized": false,
      "lastName": "example",
      "metadata": {},
      "phoneNumber": "example",
      "source": "example"
    }
  }
}

Create a prompt request

Submit a prompt and get back an ID for fetching the response later.

Inputs

PromptprompttextRequired
The question that the user sends to the AI agent
Token tracking IDtoken_tracking_idtext
The ID of the token tracking
Filesfileslist
Files attached to the message

Outputs

responseobject
Response.
Example output
{
  "response": {
    "promptId": "example"
  }
}

Create or update conversation message feedback

Add or update feedback on a message in a conversation. Returns the saved feedback.

Inputs

Conversation message IDconversation_message_idtextRequired
Unique identifier for the conversation message.
API user IDapi_user_idtextRequired
Unique identifier for the user.
Vote typevote_typetextRequired
Feedback vote type. Up if feedback is positiveOne of: up, down.
QuestionquestiontextRequired
Your question.
Answeranswertext
Agent answer.
Commentcommenttext
Comment for your feedback.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "answer": "example",
    "comment": "example",
    "conversationMessageId": "123e4567-e89b-42d3-a456-426614174000",
    "createdAt": "example",
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "question": "example",
    "updatedAt": "example",
    "voteType": "up"
  }
}

Delete conversation user by ID

Delete a conversation user by ID.

Inputs

IDidtextRequired
Unique identifier of the conversation user.

Outputs

responseobject
Response.
Example output
{
  "response": {}
}

Find user by contact information

Find a user by email address, phone number or your own reference ID, with their conversation IDs for the current agent.

Inputs

Emailemailtext
User email
Phone numberphone_numbertext
User phone number
Fk IDfk_idtext
User fkId

Outputs

responseobject
Response.
Example output
{
  "response": {
    "conversationIds": [],
    "user": {
      "context": "example",
      "email": "example",
      "firstName": "example",
      "fkId": "example",
      "fkUserId": "example",
      "id": "example",
      "isAnonymized": false,
      "lastName": "example",
      "metadata": {},
      "phoneNumber": "example",
      "source": "example"
    }
  }
}

Get a response on prompt request

Get the response to a prompt by its ID.

Inputs

IDidtextRequired
Provide the prompt ID to process.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "artifacts": [],
    "error": "example",
    "response": "example",
    "status": "pending",
    "totalTokens": 1,
    "usage": {
      "inputTokens": 1,
      "model": "example",
      "modelProvider": "example",
      "outputTokens": 1,
      "reasoningEffort": "example",
      "reasoningMode": "example",
      "reasoningTokens": 1,
      "totalTokens": 1
    }
  }
}

Get agent by API key

Get the details of the agent your API key belongs to.

Inputs

None.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "aiConfig": {
      "fileSearchMaxNumResults": 1,
      "id": "example",
      "instructions": "example",
      "isCodeInterpreterEnabled": false,
      "isFileSearchEnabled": false,
      "isOutputJsonSchemaEnabled": false,
      "model": "example",
      "outputJsonSchema": "example",
      "reasoningEffort": "none",
      "reasoningMode": "standard",
      "temperature": 1,
      "topP": 1
    },
    "avatarUrl": "example",
    "description": "example",
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "name": "example",
    "organizationId": "123e4567-e89b-42d3-a456-426614174000",
    "organizationName": "example",
    "publicName": "example",
    "restrictDocumentsToOwnerOnly": false,
    "role": "example",
    "skills": [],
    "status": "active",
    "tags": [],
    "vectorStoreId": "example"
  }
}

Get agent file by ID

Get one of the agent's files by ID.

Inputs

IDidtextRequired
Unique identifier of the agent file.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "createdAt": "2026-10-24T12:00:00Z",
    "fileName": "example",
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "isUploadedToVectorStore": false,
    "uploadedToVectorStoreAt": "2026-10-24T12:00:00Z",
    "url": "example",
    "vectorStoreFileId": "example",
    "vectorStoreUploadStatus": "processing"
  }
}

Get agent limits by Agent API key

Get the limits of the agent your API key belongs to.

Inputs

None.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "agentId": "123e4567-e89b-42d3-a456-426614174000",
    "emailsAmountPerMonth": 1,
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "isOrganizationDefault": false,
    "secondsAmountPerMonth": 1,
    "smsAmountPerMonth": 1,
    "tokensAmountPerMonth": 1
  }
}

Get agent usage by Agent API key

Get the usage of the agent your API key belongs to.

Inputs

None.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "emailsAmount": 1,
    "secondsAmount": 1,
    "smsAmount": 1,
    "tokensAmount": 1
  }
}

Get agent users by Agent API key

List the agent's users, with their details. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page number
Page sizepage_sizenumber
Page size
Order byorder_bytext
Order byOne of: createdAt.
Order directionorder_directiontext
Order directionOne of: ASC, DESC.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "currentPage": 1,
    "data": [],
    "hasNextPage": false,
    "hasPreviousPage": false,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Get conversation by ID

Get a conversation and its details by ID.

Inputs

IDidtextRequired
The ID of the conversation to retrieve.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "aiCallId": "example",
    "analysisStatus": "not_started",
    "analyzedAt": "2026-10-24T12:00:00Z",
    "assignedUser": {
      "avatarUrl": "example",
      "email": "example",
      "firstName": "example",
      "id": "example",
      "lastName": "example",
      "phoneNumber": "example"
    },
    "conversationStateId": "example",
    "conversationUserId": "example",
    "createdAt": "2026-10-24T12:00:00Z",
    "feedbacks": [],
    "id": "example",
    "isAnonymized": false,
    "metadata": {},
    "mode": "manual",
    "score": 1,
    "summary": "example",
    "title": "example",
    "updatedAt": "2026-10-24T12:00:00Z",
    "user": {
      "context": "example",
      "email": "example",
      "firstName": "example",
      "fkId": "example",
      "fkUserId": "example",
      "id": "example",
      "isAnonymized": false,
      "lastName": "example",
      "metadata": {},
      "phoneNumber": "example",
      "source": "example"
    }
  }
}

Get conversation messages

Get all the messages in a conversation.

Inputs

Should include feedbacksshould_include_feedbackstrue/false
If true, returns conversation messages with feedbacks
Order directionorder_directiontext
Message created at order direction. Default: ASCOne of: ASC, DESC.
IDidtextRequired
The ID of the conversation to retrieve messages for.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "messages": []
  }
}

Get conversation states

List the conversation states available to the agent.

Inputs

None.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "color": "example",
    "createdAt": "example",
    "description": "example",
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "isPersistent": false,
    "name": "example",
    "updatedAt": "example"
  }
}

Get conversation user by ID

Get a conversation user by ID.

Inputs

IDidtextRequired
Unique identifier of the conversation user.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "context": "example",
    "email": "example",
    "firstName": "example",
    "fkId": "example",
    "fkUserId": "example",
    "id": "example",
    "isAnonymized": false,
    "lastName": "example",
    "metadata": {},
    "phoneNumber": "example",
    "source": "example"
  }
}

Get conversation user limits by ID

Get a conversation user's limits by their ID.

Inputs

IDidtextRequired
Unique identifier of the conversation user.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "conversationUserId": "example",
    "emailsAmountPerMonth": 1,
    "id": "example",
    "isOrganizationDefault": false,
    "secondsAmountPerMonth": 1,
    "smsAmountPerMonth": 1,
    "tokensAmountPerMonth": 1
  }
}

Get conversations

List the agent's conversations, with their details. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page number
Page sizepage_sizenumber
Page size
Order byorder_bytext
Order byOne of: createdAt, updatedAt.
Order directionorder_directiontext
Order directionOne of: ASC, DESC.
Search keywordsearch_keywordtext
Search keyword in conversation title, summary, agent name, user first and last name, email and phone number
API user IDapi_user_idtext
Conversation user ID
Start datestart_datedate and time
Start date of conversation updatedAt.
End dateend_datedate and time
End date of conversation updatedAt.
With feedbacks onlywith_feedbacks_onlytrue/false
If true, returns conversations with at least one feedback

Outputs

responseobject
Response.
Example output
{
  "response": {
    "currentPage": 1,
    "data": [],
    "hasNextPage": false,
    "hasPreviousPage": false,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Get paginated agent files by API key

List the agent's files, sorted. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Zero-based page number.At least 0.0.
Page sizepage_sizenumber
Number of files per page.From 1.0 to 100.0.
Order byorder_bytext
File field used for sorting.One of: createdAt, fileName.
Order directionorder_directiontext
Sort direction.One of: ASC, DESC.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "currentPage": 1,
    "data": [],
    "hasNextPage": false,
    "hasPreviousPage": false,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Get response on

Get the agent's response to a message in a conversation.

Inputs

IDidtextRequired
The ID of the conversation to retrieve message for.
Question message IDquestion_message_idtextRequired
The ID of the question message to retrieve response for. (The message that the user sent to the AI agent)

Outputs

responseobject
Response.
Example output
{
  "response": {
    "error": "example",
    "message": {
      "conversationId": "example",
      "conversationMessageFeedbacks": [],
      "conversationMessageId": "example",
      "createdAt": "2026-10-24T12:00:00Z",
      "expandedMessage": "example",
      "files": [],
      "fullAIResponse": {
        "fileCitations": [],
        "outputText": "example",
        "reasoning": [],
        "urlCitations": []
      },
      "id": "example",
      "isAnonymized": false,
      "message": "example",
      "modelUsage": {
        "inputTokens": 1,
        "model": "example",
        "modelProvider": "example",
        "outputTokens": 1,
        "reasoningEffort": "example",
        "reasoningMode": "example",
        "reasoningTokens": 1,
        "totalTokens": 1
      },
      "rawMessage": "example",
      "senderRole": "conversation_user",
      "source": "email",
      "subagentId": "example",
      "usedFunctions": []
    },
    "status": "pending"
  }
}

Process a prompt request

Send a prompt and wait for the agent's AI-generated response.

Inputs

PromptprompttextRequired
The question that the user sends to the AI agent
Token tracking IDtoken_tracking_idtext
The ID of the token tracking
Filesfileslist
Files attached to the message

Outputs

responseobject
Response.
Example output
{
  "response": {
    "artifacts": [],
    "error": "example",
    "response": "example",
    "status": "pending",
    "totalTokens": 1,
    "usage": {
      "inputTokens": 1,
      "model": "example",
      "modelProvider": "example",
      "outputTokens": 1,
      "reasoningEffort": "example",
      "reasoningMode": "example",
      "reasoningTokens": 1,
      "totalTokens": 1
    }
  }
}

Send a message to an agent

Send a message to the agent in a conversation.

Inputs

IDidtextRequired
The ID of the conversation to send a message to.
MessagemessagetextRequired
The message that the user sends to the AI agent
Contextcontexttext
Context of the message
Filesfileslist
Files attached to the message

Outputs

responseobject
Response.
Example output
{
  "response": {
    "conversationId": "example",
    "conversationMessageFeedbacks": [],
    "conversationMessageId": "example",
    "createdAt": "2026-10-24T12:00:00Z",
    "expandedMessage": "example",
    "files": [],
    "fullAIResponse": {
      "fileCitations": [],
      "outputText": "example",
      "reasoning": [],
      "urlCitations": []
    },
    "id": "example",
    "isAnonymized": false,
    "message": "example",
    "modelUsage": {
      "inputTokens": 1,
      "model": "example",
      "modelProvider": "example",
      "outputTokens": 1,
      "reasoningEffort": "example",
      "reasoningMode": "example",
      "reasoningTokens": 1,
      "totalTokens": 1
    },
    "rawMessage": "example",
    "senderRole": "conversation_user",
    "source": "email",
    "subagentId": "example",
    "usedFunctions": []
  }
}

Send a message to an agent (async)

Send a message to the agent in a conversation.

Inputs

IDidtextRequired
The ID of the conversation to send a message to.
MessagemessagetextRequired
The message that the user sends to the AI agent
Contextcontexttext
Context of the message
Filesfileslist
Files attached to the message

Outputs

responseobject
Response.
Example output
{
  "response": {
    "conversationId": "example",
    "conversationMessageFeedbacks": [],
    "conversationMessageId": "example",
    "createdAt": "2026-10-24T12:00:00Z",
    "expandedMessage": "example",
    "files": [],
    "fullAIResponse": {
      "fileCitations": [],
      "outputText": "example",
      "reasoning": [],
      "urlCitations": []
    },
    "id": "example",
    "isAnonymized": false,
    "message": "example",
    "modelUsage": {
      "inputTokens": 1,
      "model": "example",
      "modelProvider": "example",
      "outputTokens": 1,
      "reasoningEffort": "example",
      "reasoningMode": "example",
      "reasoningTokens": 1,
      "totalTokens": 1
    },
    "rawMessage": "example",
    "senderRole": "conversation_user",
    "source": "email",
    "subagentId": "example",
    "usedFunctions": []
  }
}

Update conversation

Update a conversation by ID. Returns the updated conversation.

Inputs

IDidtextRequired
The ID of the conversation to update.
Titletitletext
Conversation title
Contextcontexttext
Conversation context
Statusstatustext
Conversation statusOne of: active, inactive, archived.
Conversation state IDconversation_state_idtext
Conversation state ID

Outputs

responseobject
Response.
Example output
{
  "response": {
    "aiCallId": "example",
    "analysisStatus": "not_started",
    "analyzedAt": "2026-10-24T12:00:00Z",
    "assignedUser": {
      "avatarUrl": "example",
      "email": "example",
      "firstName": "example",
      "id": "example",
      "lastName": "example",
      "phoneNumber": "example"
    },
    "conversationStateId": "example",
    "conversationUserId": "example",
    "createdAt": "2026-10-24T12:00:00Z",
    "id": "example",
    "isAnonymized": false,
    "metadata": {},
    "mode": "manual",
    "score": 1,
    "summary": "example",
    "title": "example",
    "updatedAt": "2026-10-24T12:00:00Z",
    "user": {
      "context": "example",
      "email": "example",
      "firstName": "example",
      "fkId": "example",
      "fkUserId": "example",
      "id": "example",
      "isAnonymized": false,
      "lastName": "example",
      "metadata": {},
      "phoneNumber": "example",
      "source": "example"
    }
  }
}

Update conversation mode

Change a conversation's mode. Returns the updated conversation.

Inputs

IDidtextRequired
The ID of the conversation to update.
Modemodetext
Conversation modeOne of: manual, ai.

Outputs

responseobject
Response.
Example output
{
  "response": {
    "aiCallId": "example",
    "analysisStatus": "not_started",
    "analyzedAt": "2026-10-24T12:00:00Z",
    "assignedUser": {
      "avatarUrl": "example",
      "email": "example",
      "firstName": "example",
      "id": "example",
      "lastName": "example",
      "phoneNumber": "example"
    },
    "conversationStateId": "example",
    "conversationUserId": "example",
    "createdAt": "2026-10-24T12:00:00Z",
    "id": "example",
    "isAnonymized": false,
    "metadata": {},
    "mode": "manual",
    "score": 1,
    "summary": "example",
    "title": "example",
    "updatedAt": "2026-10-24T12:00:00Z",
    "user": {
      "context": "example",
      "email": "example",
      "firstName": "example",
      "fkId": "example",
      "fkUserId": "example",
      "id": "example",
      "isAnonymized": false,
      "lastName": "example",
      "metadata": {},
      "phoneNumber": "example",
      "source": "example"
    }
  }
}

On this page