📜 Assistant Documents
Use these endpoints to upload and manage raw documents associated with a specific assistant. These documents can enhance the assistant’s responses by feeding it context-relevant information.
🔽 POST /api/public/documents/assistant/raw – Upload a Raw Document to an Assistant
POST /api/public/documents/assistant/raw – Upload a Raw Document to an AssistantUploads a raw document (text-based) to a given assistant.
Click to expand full details
🔹 URL
POST /api/public/documents/assistant/raw
🔹 Body Parameters
| Name | Type | Required | Description |
|---|---|---|---|
content | string | ✅ | The content of the document (plain text) |
fileName | string | ✅ | Display name for the file |
externalId | string | ✅ | Unique external identifier for the document |
assistantId | string | ✅ | The assistant this document is linked to |
🔹 Headers
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key | string | ✅ | Your API key for authorization |
🔹 Example Request
curl --request POST \
'https://iris-backend-production.up.railway.app/api/public/documents/assistant/raw' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data-raw '{
"content": "Returns are accepted within 30 days.",
"fileName": "return_policy.txt",
"externalId": "return-policy-2024",
"assistantId": "123456"
}'
🔽 DELETE /api/public/documents/assistant/{externalId} – Delete a Document from an Assistant
DELETE /api/public/documents/assistant/{externalId} – Delete a Document from an AssistantDeletes a previously uploaded document using its externalId.
Click to expand full details
🔹 URL
DELETE /api/public/documents/assistant/{externalId}
🔹 Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
externalId | string | ✅ | The unique identifier of the document to delete |
🔹 Headers
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key | string | ✅ | Your API key for authorization |
🔹 Example Request
curl --request DELETE \
'https://iris-backend-production.up.railway.app/api/public/documents/assistant/return-policy-2024' \
--header 'x-api-key: YOUR_API_KEY'
Updated 16 days ago