Skip to main content

​
Overview

The Resources API allows you to manage and access various resources like documents, data sources, and other materials that can be used with AI models.

​
List Resources

Get a list of all available resources for a user. 
GET /users/:userId/resources

​
Response

{
  "success": true,
  "data": {
    "resources": {
      "filesystem": [
        {
          "uri": "file://documents/report.pdf",
          "name": "Q4 Report",
          "description": "Quarterly financial report",
          "mimeType": "application/pdf",
          "metadata": {
            "size": 1024000,
            "created": "2024-02-21T10:00:00Z"
          }
        }
      ],
      "database": [
        {
          "uri": "db://sales/2024",
          "name": "Sales Data 2024",
          "type": "dataset",
          "description": "Annual sales records",
          "metadata": {
            "rows": 5000,
            "updated": "2024-02-21T09:00:00Z"
          }
        }
      ]
    }
  }
}

​
Get Resource

Get details about a specific resource. 
GET /users/:userId/resources/:resourceId

​
Response

{
  "success": true,
  "data": {
    "resource": {
      "uri": "file://documents/report.pdf",
      "name": "Q4 Report",
      "description": "Quarterly financial report",
      "mimeType": "application/pdf",
      "content": null,
      "metadata": {
        "size": 1024000,
        "created": "2024-02-21T10:00:00Z"
      }
    }
  }
}

​
Get Resource Content

Get the content of a specific resource. 
GET /users/:userId/resources/:resourceId/content

​
Response

{
  "success": true,
  "data": {
    "content": "Resource content here...",
    "mimeType": "text/plain"
  }
}

​
Update Resource Metadata

Update metadata for a specific resource. 
PATCH /users/:userId/resources/:resourceId

​
Request Body

{
  "name": "Updated Name",
  "description": "Updated description",
  "metadata": {
    "category": "finance",
    "tags": ["report", "quarterly"]
  }
}

​
Response

{
  "success": true,
  "data": {
    "resource": {
      "uri": "file://documents/report.pdf",
      "name": "Updated Name",
      "description": "Updated description",
      "metadata": {
        "category": "finance",
        "tags": ["report", "quarterly"],
        "size": 1024000,
        "created": "2024-02-21T10:00:00Z"
      }
    }
  }
}