Skip to main content
GET
/
agent-documents
List agent documents
curl --request GET \
  --url https://app.phonely.ai/api/agent-documents \
  --header 'X-Authorization: <api-key>'
{
  "documents": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "name": "<string>",
      "active": true,
      "fileUrl": "<string>",
      "lastUpdatedBy": "<string>",
      "lastUpdatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

​
Agent Documents

Manages documents in an agent’s knowledge base. This endpoint supports GET, POST, and DELETE operations.

​
List Documents

Method: GET
Endpoint: /api/agent-documents
Headers:
  • X-Authorization: Your API key (required)
Query Parameters:
  • uid (string, required): Your user ID
  • agentId (string, required): The ID of the agent
Response: 
{
  "documents": [
    {
      "id": "string",
      "name": "string",
      "active": boolean,
      "fileUrl": "string",
      "lastUpdatedBy": "string",
      "lastUpdatedAt": "string"
    }
  ]
}

​
Add Documents

Method: POST
Endpoint: /api/agent-documents
Headers:
  • X-Authorization: Your API key (required)
  • Content-Type: multipart/form-data
Form Data:
  • uid (string, required): Your user ID
  • agentId (string, required): The ID of the agent
  • files (File[], required): Array of files to upload (max 10 files, 10MB each)
Supported File Types:
  • PDF (.pdf)
  • Word documents (.docx)
  • Text files (.txt)
Response: 
{
  "documentIds": ["string"],
  "message": "Files uploaded successfully"
}

​
Delete Document

Method: DELETE
Endpoint: /api/agent-documents
Headers:
  • X-Authorization: Your API key (required)
Query Parameters:
  • uid (string, required): Your user ID
  • agentId (string, required): The ID of the agent
  • documentId (string, required): The ID of the document to delete
Response: 
{
  "message": "Document deleted successfully"
}

​
Error Responses

  • 400 Bad Request: Invalid request parameters, too many files, file too large, or unsupported file type
  • 401 Unauthorized: Invalid or missing API key, or insufficient permissions
  • 404 Not Found: Document not found (for DELETE operations)
  • 500 Internal Server Error: Server error

​
Examples

List documents: 
curl -X GET "https://app.phonely.ai/api/agent-documents?uid=user123&agentId=agent456" \
  -H "X-Authorization: your-api-key"
Upload documents: 
curl -X POST https://app.phonely.ai/api/agent-documents \
  -H "X-Authorization: your-api-key" \
  -F "uid=user123" \
  -F "agentId=agent456" \
  -F "[email protected]" \
  -F "[email protected]"
Delete document: 
curl -X DELETE "https://app.phonely.ai/api/agent-documents?uid=user123&agentId=agent456&documentId=doc789" \
  -H "X-Authorization: your-api-key"

Authorizations

​
X-Authorization
string
header
required

Query Parameters

​
uid
string
required

User ID

​
agentId
string
required

Agent ID

Response

List of documents

​
documents
object[]