import { ProficientClient } from "@proficient/client";
const proficient = new ProficientClient({
apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
userExternalId: "...", // The user's unique ID in your system
});
const interactionId = "int_53mfKtX0Da6zaJCp5bNnzxDaEg1xptWvQDr2";
const interaction = await proficient.interactions.update(interactionId, {
// ... fields to update
});
{
"id": "<string>",
"object": "interaction",
"agent_id": "<string>",
"archived": true,
"created_at": 123,
"initial_turn": "user",
"name": "<string>",
"total_message_count": 123,
"updated_at": 123,
"user_id": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Interactions
Update an interaction
Updates the properties of the specified interaction. Only the provided properties will be updated. Any properties not provided will be left unchanged.
POST
/
interactions
/
{interaction_id}
import { ProficientClient } from "@proficient/client";
const proficient = new ProficientClient({
apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
userExternalId: "...", // The user's unique ID in your system
});
const interactionId = "int_53mfKtX0Da6zaJCp5bNnzxDaEg1xptWvQDr2";
const interaction = await proficient.interactions.update(interactionId, {
// ... fields to update
});
{
"id": "<string>",
"object": "interaction",
"agent_id": "<string>",
"archived": true,
"created_at": 123,
"initial_turn": "user",
"name": "<string>",
"total_message_count": 123,
"updated_at": 123,
"user_id": "<string>"
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}import { ProficientClient } from "@proficient/client";
const proficient = new ProficientClient({
apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
userExternalId: "...", // The user's unique ID in your system
});
const interactionId = "int_53mfKtX0Da6zaJCp5bNnzxDaEg1xptWvQDr2";
const interaction = await proficient.interactions.update(interactionId, {
// ... fields to update
});
Body
application/json
Response
Users communicate with agents via interactions. You can think of each interaction as a conversation between an agent and user.