Conversations
The Directory API gives you access to Organizations, Accounts, Employees and Groups. Every Entity within the subsequent API calls must have an Organization attached and API calls must be made with a User specific JWT.
Success
Conversation unique identifier.
ID of the user who owns this conversation.
Tenant/workspace identifier to which this conversation belongs.
Timestamp when the conversation was created.
Friendly name of the conversation.
Bad request
Internal Server Error
GET /api/v1/agent/conversations HTTP/1.1
Host: api.peoplelogic.dev
Accept: */*
[
{
"id": "c123e4567-e89b-12d3-a456-426614174001",
"userId": "user123",
"tenant": "tenantXYZ",
"timestamp": "2025-07-13T15:00:00Z",
"name": "Project Kickoff Discussion"
}
]Success
Conversation unique identifier.
ID of the user who owns this conversation.
Tenant/workspace identifier to which this conversation belongs.
Timestamp when the conversation was created.
Friendly name of the conversation.
Bad request
Internal Server Error
POST /api/v1/agent/conversations/start HTTP/1.1
Host: api.peoplelogic.dev
Accept: */*
{
"id": "d123e4567-e89b-12d3-a456-426614174002",
"userId": "user123",
"tenant": "tenantXYZ",
"timestamp": "2025-07-13T15:05:00Z",
"name": ""
}Conversation ID
Conversation unique identifier.
ID of the user who owns this conversation.
Tenant/workspace identifier to which this conversation belongs.
Timestamp when the conversation was created.
Friendly name of the conversation.
Success
Conversation unique identifier.
ID of the user who owns this conversation.
Tenant/workspace identifier to which this conversation belongs.
Timestamp when the conversation was created.
Friendly name of the conversation.
Bad request
Not Found
Internal Server Error
PUT /api/v1/agent/conversations/{id} HTTP/1.1
Host: api.peoplelogic.dev
Content-Type: application/json
Accept: */*
Content-Length: 167
{
"id": "c123e4567-e89b-12d3-a456-426614174001",
"userId": "user123",
"tenant": "tenantXYZ",
"timestamp": "2025-07-13T15:00:00Z",
"name": "Project Kickoff Discussion (Updated)"
}{
"id": "c123e4567-e89b-12d3-a456-426614174001",
"userId": "user123",
"tenant": "tenantXYZ",
"timestamp": "2025-07-13T15:00:00Z",
"name": "Project Kickoff Discussion (Updated)"
}Conversation ID
Success (conversation deleted)
No content
Unauthorized
Not Found
Internal Server Error
DELETE /api/v1/agent/conversations/{id} HTTP/1.1
Host: api.peoplelogic.dev
Accept: */*
No content
Retrieve the list of tasks assigned by the agent for the user's last question. Requires an existing conversation (conversationId must be provided).
User's question or message.
Max number of results or steps (defaults to 5).
Additional instructions or context for the agent.
ID of an existing conversation (for follow-ups; omit for new questions).
If provided, get history messages since this timestamp (used in history request).
Success
Agent's response summary or prompt to the user (e.g., asking for confirmation).
True if the agent is awaiting user confirmation or input to proceed.
True if the agent is proposing a new scheduled workflow.
Frequency for scheduled workflow execution.
Hour of day (0-23) for scheduled workflow execution (if applicable).
Day of week or month for scheduled workflow (if applicable).
Minute of hour for scheduled workflow (if applicable).
Time zone identifier for the scheduled workflow (if applicable).
Indicates if the user's subscription is active (true) or if execution is limited due to subscription issues.
Channel for completion notification.
Target identifier for completion notification (e.g., email address or Slack channel, if provided).
Identifier of the user for whom the tasks are assigned.
Bad request
Internal Server Error
POST /api/v1/agent/assign HTTP/1.1
Host: api.peoplelogic.dev
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"question": "How can I improve team productivity?",
"conversationId": "conv123"
}{
"response": "I will compile the sales data and draft an email. Would you like me to proceed?",
"needsConfirmation": true,
"newWorkflow": false,
"agents": [
{
"agent": {
"name": "Peoplelogic Agent",
"persona": "A general purpose AI agent."
},
"specificTask": "Compile Q1 and Q2 sales data",
"step": 0,
"dependsOn": -1,
"workflowAssignment": false
},
{
"agent": {
"name": "Peoplelogic Agent",
"persona": "A general purpose AI agent."
},
"specificTask": "Draft an email summarizing the sales data",
"step": 1,
"dependsOn": 0,
"workflowAssignment": false
}
],
"subscriptionActive": true,
"userId": "tenantXYZ_user123"
}Submit a question to the Peoplelogic agent. Do not include a conversationId (a new conversation will be started).
User's question or message.
Max number of results or steps (defaults to 5).
Additional instructions or context for the agent.
ID of an existing conversation (for follow-ups; omit for new questions).
If provided, get history messages since this timestamp (used in history request).
Success
Whether the request succeeded.
The agent's response message.
True if the agent is asking for confirmation from the user.
Conversation ID this response is associated with (if any).
Bad request
Internal Server Error
POST /api/v1/agent/ask HTTP/1.1
Host: api.peoplelogic.dev
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"question": "How can I improve team productivity?"
}{
"success": true,
"agent": {
"name": "Peoplelogic Agent",
"persona": "A general purpose AI agent.",
"coordinator": true
},
"reply": "Encourage open communication and regular feedback...",
"sources": [
{
"name": "Employee Handbook",
"type": "document",
"url": "https://example.com/handbook.pdf"
}
],
"confirming": false
}Send a follow-up message or confirmation in an existing conversation. This is typically used to confirm task execution or ask a clarifying question, using the conversationId from a previous response.
User's question or message.
Max number of results or steps (defaults to 5).
Additional instructions or context for the agent.
ID of an existing conversation (for follow-ups; omit for new questions).
If provided, get history messages since this timestamp (used in history request).
Success
Whether the request succeeded.
The agent's response message.
True if the agent is asking for confirmation from the user.
Conversation ID this response is associated with (if any).
Bad request
Internal Server Error
POST /api/v1/agent/reply HTTP/1.1
Host: api.peoplelogic.dev
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"question": "Yes, please proceed.",
"conversationId": "conv123"
}{
"success": true,
"agent": {
"name": "Peoplelogic Agent",
"persona": "A general purpose AI agent.",
"coordinator": true
},
"reply": "Sure, I've sent the summary email to the team.",
"confirming": false
}Success
Whether the request succeeded.
The agent's response message.
True if the agent is asking for confirmation from the user.
Conversation ID this response is associated with (if any).
Not Found
Internal Server Error
POST /api/v1/agent/add-file-knowledge HTTP/1.1
Host: api.peoplelogic.dev
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"success": true,
"agent": {
"name": "Peoplelogic Agent",
"persona": "A general purpose AI agent.",
"coordinator": true
},
"reply": "Added handbook.pdf to the knowledge base for your organization!",
"confirming": false
}Success
Whether the request succeeded.
The agent's response message.
True if the agent is asking for confirmation from the user.
Conversation ID this response is associated with (if any).
Not Found
Internal Server Error
POST /api/v1/agent/add-url-knowledge HTTP/1.1
Host: api.peoplelogic.dev
Content-Type: text/plain
Accept: */*
Content-Length: 30
"https://docs.example.com/FAQ"{
"success": true,
"agent": {
"name": "Peoplelogic Agent",
"persona": "A general purpose AI agent.",
"coordinator": true
},
"reply": "Added https://docs.example.com/FAQ to the knowledge base for your organization!",
"confirming": false
}Last updated
Was this helpful?