Register an uploaded file

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

Close
POST /extraction/file/register

Creates a file record for a file already uploaded to S3, by its key, so it can then be imported (for example an AI chat export). If a record for that key already exists, it is returned instead. Returns 404 if the key is not in S3. Only keys under ai-chat/, linkedin-imports/ or case-files// can be registered (403 otherwise).

application/json

Body Required

  • fileKey string Required

    S3 file key (path in bucket)

  • type string | null

    Override content type. If not provided, uses S3 metadata.

Responses

  • 201 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • name string Required
      • providerId string Required
      • convertedName string | null Required
      • convertedProviderId string Required
      • provider string Required
      • size number Required

        Size in bytes

      • transferState number | null Required
    • statusCode number Required
    • timestamp string(date-time) Required
POST /extraction/file/register
curl \
 --request POST 'http://api.example.com/extraction/file/register' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{
  "fileKey": "string",
  "type": "string"
}'
Request examples
{
  "fileKey": "string",
  "type": "string"
}
Response examples (201)
{
  "data": {
    "createdAt": "2026-01-15T14:30:00.000Z",
    "updatedAt": "2026-01-15T14:30:00.000Z",
    "id": "507f1f77bcf86cd799439011",
    "name": "photo.heic",
    "providerId": "uploads/507f1f77bcf86cd799439011/photo.heic",
    "convertedName": "photo.jpg",
    "convertedProviderId": "uploads/507f1f77bcf86cd799439011/photo.jpg",
    "provider": "s3",
    "size": 204800,
    "transferState": 42.0
  },
  "statusCode": 201,
  "timestamp": "2026-01-15T10:15:00.000Z"
}