ejento.ai API
Stable
  • Stable
  • V2
  • V2 Legacy
Stable
  • Stable
  • V2
  • V2 Legacy
ejento.ai
Stable
  • Stable
  • V2
  • V2 Legacy
  1. Guides
  • Overview
  • Changelog
  • Versioning
  • Quick-Start Template for Building an App
  • FAQs
  • Guides
    • How to generate API Key and Auth Token
    • Build an App with Ejento APIs
    • How to Import Ejento APIs into Postman
    • Response API Migration
    • Indexing API Migration
    • Voice Call API Integration Guide
    • Staging & Publishing for Agents API Guide
    • Authentication with Azure AD Token
    • Chat Thread Attachment Integration Guide
  • Authentication
    • Getting Started with Authentication
    • SSO
      • Initiate Google SSO Login
      • Initiate Microsoft SSO Login
      • Initiate LinkedIn SSO Login
      • Initiate Okta SSO Login
      • Exchange Azure AD Token for Ejento Tokens
    • Feature Flags
      • Get Login Feature Flags
    • Authenticate User
    • Request Passwordless Exchange Token
    • Exchange Passwordless Token for Access Tokens
    • Register User
    • Update Own Password
    • Refresh Access Token
    • Passwordless Authentication (Email Magic Link)
    • Validate Magic Link Token
    • Verify Email OTP
  • Agents
    • Agent Access
      • Get Agent Access
      • Update Agent Access
    • Agent Alias
      • Get Agent Alias
      • Create an Agent Alias
      • Update an Agent Alias
      • Delete an Agent Alias
      • Get all Agent Aliases
    • Agent Tags
      • Add or Remove Tags from an Agent
      • Get all Tags for a given Project or Organization
      • Get all Tags grouped by Agent for a given Project or Organization
    • Agent Chat Threads
      • Get Chat Threads of an Agent
      • Create Chat Thread for an Agent
    • Agent Comment
      • Get all Comments for an Agent
      • Create a Comment
      • Update a Comment
      • Delete a Comment
    • Agent Rating
      • Get Ratings of an Agent
      • Update Agent Rating
      • Get all Agent Ratings
    • Agent Review
      • Get all Reviews for specific Agent
      • Create a new Review
      • Get all Reviews of the Authenticated User
      • Update a Review
      • Delete a Review
    • Agent Tools
      • List all Tools with their enabled status for the given Agent
      • Unlink an Agent from a Tool
      • Link an Agent to a Tool
      • List all tools that are connected to the Agent
    • Agent Vote
      • Get Vote Information for an Agent
      • Vote on an Agent
    • Agent Type
      • Get all Agent Types
      • Get a specific Agent Type
      • Update a specific Agent Type
    • Evaluation Datasets
      • List Agent Evaluation Datasets
      • Create Agent Evaluation Dataset
      • Batch Delete Agent Evaluation Datasets
      • Get Agent Evaluation Dataset
      • Update Agent Evaluation Dataset
      • Delete Agent Evaluation Dataset
      • Upload Agent Evaluation Dataset (CSV/Excel)
    • Evaluation Runs
      • List Agent Evaluation Runs
      • Create Agent Evaluation Run
      • Batch Delete Agent Evaluation Runs
      • Get Agent Evaluation Run
      • Update Agent Evaluation Run
      • Delete Agent Evaluation Run
    • Agent Permissions
      • List all permissions on an agent
      • Grant permission on an agent
      • Update a permission on an agent
      • Revoke permission on an agent
      • Grant multiple permissions on an agent
      • Revoke multiple permissions on an agent
      • Get user permissions on a specific agent
      • Get user permissions on multiple agents
    • Get all Agents
    • Create a new Agent
    • Get an Agent
    • Update an Agent
    • Delete an Agent
    • Activate an Agent
    • Get Agent-Corpus Connections
    • Create Multiple Agent-Corpus Connections
    • Delete Agent-Corpus Connections
    • Get Agent-Corpus Connection Details
    • Create Agent-Corpus Connection
    • Update Agent-Corpus Connection
    • Delete Agent-Corpus Connection
    • Get agent history with pagination
    • Restore an agent to a previous checkpoint
    • Get a single agent history record by history ID
    • Create Custom Instructions for an Agent
    • Update Custom Instructions for an Agent
    • Delete a Custom Instruction for an Agent
    • Get Agent Prompt History
    • Create a Recent Agent
    • Delete a Recent Agent
    • Get Agent Details with Starred Status
    • Create Starred Agent
    • Delete Starred Agent
    • Get the Status of an Agent
    • Get all Character Voices
    • Get Agent Filter
    • Generate an image for an agent based on the provided description
    • Get all Agents by Project
    • Get list of Recent Agents
    • Get all workflows for an agent
    • Get all Starred Agents of the Authenticated User
    • Get Staging Diff
    • Get publish history for an agent
    • Get rollback diff preview for a publish record
    • Roll back staging agent to a previous publish
    • Publish staging agent to main
    • Clone an Agent
    • Get diff detail for a publish record
  • Agent Response
    • Stream Agent Response (SSE)
    • Generate Agent Response (Non-Streaming)
    • Generate Token for Voice Call
    • Get an Agent Response
    • Update an Agent Response
    • Delete an Agent Response
    • Get Comments for Agent Response
    • Create a Comment for Agent Response
    • Create a Feedback for an Agent Response
    • Pin an Agent Response
    • Unpin an Agent Response
    • Get Supporting Content of an Agent Response
    • Get Thoughts of an Agent Response
    • Get Agent Responses based on filters
    • Get Agent Responses of an Agent
    • Create Agent Response Log
    • Get Pinned Agent Responses
    • Create Bulk Agent Response Logs
    • Stop an in-flight streaming response
  • Chat Thread
    • Agent Response
      • Get Agent Responses for a Chat Thread
      • Delete Agent Responses for a Chat Thread
    • Chat Logs
      • Get Chat Logs for a Chat Thread
    • Corpus Connection
      • Get Corpus Connection by ChatThread ID
      • Delete Corpus Connection by ChatThread ID
      • Get a ChatThread-Corpus connection
      • Create a ChatThread-Corpus connection
      • Delete a ChatThread-Corpus connection
    • Documents
      • Get Documents in Chat Thread
    • Get Chat Thread
    • Update Chat Thread
    • Delete Chat Thread
    • Get Chat Threads based on various filters
    • Global Hybrid Search across Chat Threads and Chatlogs
    • Get Recent Chat Threads across all Agents
  • Chat Logs
    • Get Chat Log Details
    • Get Chat Log Search Results
  • Conversation Starters
    • Get Conversation Starters for an Agent
    • Create a new Conversation Starter.
  • Teams
    • Team Permissions
      • List all permissions on a team
      • Grant permission on a team
      • Update a permission on a team
      • Revoke permission on a team
      • Grant multiple permissions on a team
      • Revoke multiple permissions on a team
      • Get user permissions on a specific team
      • Get user permissions on multiple teams
    • Get all Teams
    • Create a Team
    • Get a Team
    • Update a Team
    • Delete a Team
    • Get all Projects of a Team
    • Create a Recent Team
    • Get all Users in a Team
    • Add Users to a Team
    • Remove User from Team
    • Get Recent Teams
    • Get all Teams of the Authenticated User
  • Projects
    • Project Permissions
      • List all permissions on a project
      • Grant permission on a project
      • Update a permission on a project
      • Revoke permission on a project
      • Grant multiple permissions on a project
      • Revoke multiple permissions on a project
      • Get user permissions on a specific project
      • Get user permissions on multiple projects
    • Retrieve all Projects
    • Create a Project
    • Get a Project
    • Update a Project
    • Delete a Project
    • Get Agent Responses using Project ID
    • Add a Recent Project for a User
    • Add Users to a Project
    • Remove a User from a Project
    • Get all Workflows for a Project
    • Get multiple Projects by their IDs
    • Get Projects based on filters
    • Get Recent Projects for a User
    • Get Projects with Team Details
  • Corpora
    • Corpus Permissions
      • Get all Permissions for a Corpus
      • Grant permission on a corpus
      • Update a permission on a corpus
      • Revoke permission on a corpus
      • Batch grant permissions on a corpus
      • Batch revoke permissions on a corpus
      • Get calling user's permissions on a corpus
      • Get a user's permissions on a corpus
      • Get a user's permissions across multiple corpora
    • Get all Corpus
    • Upload a Document to a Corpus
    • Create a Corpus
    • Get a Corpus
    • Update a Corpus
    • Delete a Corpus
    • Get Corpus Agent Connections
    • Get Default Corpus Agent Connection
    • Annotate/Tag a Corpus
    • Get Conversation Starters for a Corpus
    • Get all Documents for a Corpus
    • Delete Document(s) from a Corpus
    • Check Duplicate Documents in a Corpus
    • Trigger a Refresh (Reindex) of a Corpus
    • Get Sitemaps for a Corpus
    • Get Corpora with Refresh (Reindex) Enabled
  • Documents
    • Get a Document
    • Update a Document
    • Delete a Document
    • Annotate a Document
    • Get Conversation Starters for a Document
    • Trigger a Refresh (Reindex) of a Document
    • Retrieve multiple Documents by IDs
  • Organizations
    • Organization Permissions
      • List all permissions on an organization
      • Get user permissions on a specific organization
    • Get all Configurations
    • Get active configuration for an Organization
    • Get the Model Deployment for an Organization
    • Get all Tools in an Organization
    • Disable a Tool for all Agents in an Organization
    • Enable a Tool for all Agents in an Organization
    • Get all API Tool Templates
    • Create a new API Tool Template
    • Create a new API tool
    • Create an attachment tool
    • Create a new RAG tool in an Organization
    • Create a Web Search Tool in an Organization
    • Get all Users in an Organization
    • Create a User in an Organization
    • Get all Configurations of user's Organization
    • Register LLM Configuration
    • Update LLM Configuration
    • Toggle LLM Configuration Availability
    • Delete LLM Configuration
    • Get a specific LLM configuration by ID (admin only)
  • Users
    • Get a User
    • Update a User
    • Delete a User
    • Get Agent Responses of a User
    • Get all User Permissions
    • Get Projects of a User
    • Get all Workflow Tables for a User
    • Get all Workflows for a User
    • Delete multiple Users
    • Get a specific User by user_email
    • Get all Users
    • Get authenticated User
    • Get User Projects
  • Analytics
    • Get Agent Cost Data
    • Get Agent Document Count Data
    • Get Agent Indexing Mode Data
    • Get Agent Most Active Data
    • Get Agent Query Count Data
    • Get Recent Agent Data
    • Get Agent Summary Statistics
    • Get Agent Token Data
    • Get Agent Vote Data
    • Get Corpus Document Count Data
    • Get Corpus Indexing Mode Data
    • Get Cost Data
    • Get Document Count Data
    • Get Indexing Mode Data
    • Get Project Cost Data
    • Get Project Document Count Data
    • Get Project Indexing Mode Data
    • Get Project Most Active Data
    • Get Project Query Count Data
    • Get Recent Project Data
    • Get Project Summary Statistics
    • Get Project Token Data
    • Get Project Vote Data
    • Get Overall Summary Statistics
    • Get Team Cost Data
    • Get Team Document Count Data
    • Get Team Indexing Mode Data
    • Get Team Most Active Data
    • Get Team Query Count Data
    • Get Recent Team Data
    • Get Team Summary Statistics
    • Get Team Token Data
    • Get Team Vote Data
    • Get Total Entity Counts
    • Get User Cost Data
    • Get User Document Count Data
    • Get User Indexing Mode Data
    • Get User Most Active Data
    • Get User Query Count Data
    • Get Recent User Data
    • Get User Summary Statistics
    • Get User Token Data
    • Get User Vote Data
    • Get Vote Count Data
    • Get Workflow Summary Statistics
    • Get Query Count Data
    • Get Token Data
  • Configurations
    • Update the LLM configuration for an Agent
    • Get OAuth-related Feature Flags
  • Guardrails
    • Apply Guardrails on Input Text
    • Get available guardrail types for agent
    • Enable/disable a guardrail type for agent
    • Get Guardrails
    • Update Guardrails
    • Delete Guardrails
    • Get Guardrails in Organization
    • Create Guardrail in Organization
    • Enable or Disable Guardrail for Organization
  • Feature Flags
    • Get All Feature Flags
    • Get Agent Alias Feature Flag
    • Get Agent Evaluation Feature Flag
    • Get Api Tools Feature Flag
    • Get Caching Feature Flag
    • Get Call Feature Flag
    • Get Chat Agent Creation Feature Flag
    • Get Chat Widget Feature Flag
    • Get dall_e Image Generation Feature Flag
    • Get Developer Portal Feature Flag
    • Get Flush Cache Feature Flag
    • Get Google Drive Connector Feature Flag
    • Get Guardrail Feature Flag
    • Get PII Redaction Feature Flag
    • Get Share Agent Feature Flag
    • Get Sharepoint Legacy Feature Flag
    • Show Quota Limit Feature Flag
    • Get Staging Agent Feature Flag
    • Get Workflow Evaluation Feature Flag
    • Get Youtube Index Feature Flag
  • Notifications
    • Get all Notifications
    • Create a new Notification
    • Update Notifications by User ID
    • Get a Notification
    • Update a Notification
    • Delete a Notification
  • Tools
    • Get Tool by ID
    • Update Tool by ID
    • Delete Tool by ID
  • Workflows
    • Evaluation Datasets
      • List Workflow Evaluation Datasets
      • Create Workflow Evaluation Dataset
      • Batch Delete Workflow Evaluation Datasets
      • Get Workflow Evaluation Dataset
      • Update Workflow Evaluation Dataset
      • Delete Workflow Evaluation Dataset
      • Upload Workflow Evaluation Dataset (CSV/Excel)
    • Evaluation Runs
      • List Workflow Evaluation Runs
      • Create Workflow Evaluation Run
      • Batch Delete Workflow Evaluation Runs
      • Get Workflow Evaluation Run
      • Update Workflow Evaluation Run
      • Delete Workflow Evaluation Run
    • Workflow Permissions
      • Get all Permissions for a Workflow
      • Grant permission on a Workflow
      • Update a permission on a Workflow
      • Revoke permission on a Workflow
      • Batch grant permissions on a Workflow
      • Batch revoke permissions on a Workflow
      • Get a user's permissions on a workflow
      • Get a user's permissions across multiple workflows
    • Get all Workflows
    • Stream Workflow Response (SSE)
    • Create a Workflow
    • Get a Workflow
    • Update a Workflow
    • Delete a Workflow
    • Get all Workflow Chat Threads
    • Create a Workflow Chat Thread
    • Get all Workflow Responses
    • Create a Workflow Chat Response
    • Get a Workflow Chat Thread
    • Update a Workflow Chat Thread
    • Delete a Workflow Chat Thread
    • Get all Workflow Chat Responses
    • Delete a Workflow Response
    • Create a Workflow Feedback
    • Retrieve a list of reviews for a given workflow response
    • Create a Workflow Review
    • Get Workflow Responses based on filters
  • Citation
    • Get Citation File Content
  • Sitemaps
    • Get a Sitemap
    • Toggle Sitemap Syncing
    • Delete a Sitemap (cascade)
    • Get documents linked to a Sitemap
  • Google Drive
    • Folder Mappings
      • Get Google Drive Folder Mappings by Corpus ID
  1. Guides

Chat Thread Attachment Integration Guide

Overview#

This guide walks through how to upload documents into a specific chat thread and have your agent respond using those document as context. The uploaded files are stored in an attachment corpus that is connected to a single chat thread, so the agent's response draws on the documents you uploaded — and that context stays scoped to that one thread rather than being shared across the entire agent.
A common use case is uploading a sample document (for example, a template or reference file) and asking the agent queries related to those documents or to produce a new document (in case of DeepAgent) that follows the same format.
INFO
Two corpus types. Ejento supports two kinds of corpus: a document corpus and an attachment corpus. For the chat-thread use case described here, you must use an attachment corpus — this is what allows the corpus to be linked to a chat thread so anything uploaded into it becomes context for that thread only.

Prerequisites#

Before you start, make sure the following are in place:
An agent and its Agent ID. You'll reference the agent when creating the chat thread and when requesting a response.
The Attachment tool is enabled on the agent. The agent must have the Attachment tool linked/enabled for it to use uploaded attachments as context. You can enable it from the agent's tool settings in the Ejento platform.

Workflow at a glance#

#ActionEndpoint
1Create a chat threadCreate Chat Thread for an Agent
2Create an attachment corpusCreate a Corpus
3Connect the corpus to the chat threadCreate a ChatThread-Corpus connection
4Upload your document to the corpusUpload a Document to a Corpus
5Confirm indexing is completeGet a Document
6Request the agent responseStream Agent Response (SSE)

Step 1 — Create a chat thread#

Create a chat thread for your agent using Create Chat Thread for an Agent. The response returns a chat thread ID.
TIP
Keep the chat thread ID — you'll reuse it in Steps 3, 4, and 6, and again for any follow-up uploads in the same thread.

Step 2 — Create an attachment corpus#

Create a corpus using Create a Corpus, and set the corpus type to attachment. Choosing attachment is what makes the corpus connectable to a chat thread.
Keep the corpus ID from the response for the next step.

Step 3 — Connect the corpus to the chat thread#

Link the corpus to the thread with Create a ChatThread-Corpus connection, passing the chat thread ID (Step 1) and the corpus ID (Step 2).
This establishes the association between the specific chat thread and the specific corpus, which is what enables the agent to retrieve the uploaded documents later.

Step 4 — Upload your document to the corpus#

Upload your document using Upload a Document to a Corpus.
The response returns a document ID, which you'll use in the next step to confirm indexing has finished.

Step 5 — Confirm indexing is complete#

After uploading, the document is indexed asynchronously. Before requesting an agent response, verify that indexing has finished — otherwise the agent may respond before your document is available as context.
Call Get a Document with the document ID from Step 4 and confirm that step is completed
A step value of completed means indexing has finished and the document is ready to be used as context.
WARNING
Don't skip this check. If you call the response endpoint while indexing is still in progress, the agent won't have the document's content available yet and the response will not reflect the uploaded file. Poll Get a Document until step is completed before continuing.

Step 6 — Request the agent response#

Request the response using Stream Agent Response (SSE), and include the chat thread ID in the request body along with your query.
Because the corpus is connected to that chat thread and the document has finished indexing, the agent uses your uploaded document as context and responds accordingly.
INFO
The chat_thread_id in the request body is essential — it's how the agent knows which thread (and therefore which connected corpus and uploaded documents) to draw context from.

Reusing the same chat thread#

For follow-up queries in a thread you've already set up, you do not need to create another corpus or store the corpus ID yourself.
1.
Call Get Corpus Connection by ChatThread ID with your chat thread ID. The response tells you which corpus is connected to that thread — the one you created in Step 2.
2.
Upload the new document into that same corpus, exactly as in Step 4.
3.
Confirm indexing is complete (Step 5), then request the agent response (Step 6).
The context stays scoped to that specific chat thread, not the entire agent, so each thread keeps its own set of uploaded documents.

Need help?#

If you run into issues at any step, reach out to the Ejento Support Team.
Previous
Authentication with Azure AD Token
Next
Authentication
Built with