Skip to main content
POST
/
interactions
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 agentId = "ag_Lad8YCGGiDLiqIZPWRXmc2ix";

const { interaction } = await proficient.interactions.create({ agentId });

{
  "interaction": {
    "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>"
  },
  "messages": [
    {
      "id": "<string>",
      "object": "message",
      "content": "<string>",
      "created_at": 123,
      "depth": 123,
      "interaction_id": "<string>",
      "sent_by": "user",
      "parent_id": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.proficientai.com/llms.txt

Use this file to discover all available pages before exploring further.

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 agentId = "ag_Lad8YCGGiDLiqIZPWRXmc2ix";

const { interaction } = await proficient.interactions.create({ agentId });

Authorizations

​
Key
string
header
required

Body

application/json

The data with which an interaction is created.

​
agent_id
string
required

The unique identifier of the agent

Response

An object that contains the initial interaction data including the Interaction object itself and the initial messages associated with it.

​
interaction
Interaction · object
required

Users communicate with agents via interactions. You can think of each interaction as a conversation between an agent and user.

​
messages
Message · object[]
required