> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a file > Returns one file's details: name, content type, size, kind and the resources it is attached to. To download the file itself, use **Get a file download link**. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_files_get`](https://docs.heliyos.ai/mcp/tools/knowledge-base-and-files#heliyos-files-get). ## OpenAPI ````yaml /api-reference/openapi.json get /v1/platform/attachments/{id} openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/platform/attachments/{id}: get: tags: - Files summary: Get a file description: >- Returns one file's details: name, content type, size, kind and the resources it is attached to. To download the file itself, use **Get a file download link**. operationId: getAttachment parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: The file's id. example: 6729c0d4e5f6a7b8c9d0e1f2 responses: '200': description: The file. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. data: $ref: '#/components/schemas/File' example: meta: message: Attachment fetched successfully. data: _id: 6729c0d4e5f6a7b8c9d0e1f2 organizationId: 66a0f1e2d3c4b5a697887766 fileName: sales-playbook.pdf fileSize: 1048576 mimeType: application/pdf url: >- https://example-bucket.s3.amazonaws.com/66a0f1e2d3c4b5a697887766/1762248700000-sales-playbook.pdf storageProvider: S3 storageKey: 66a0f1e2d3c4b5a697887766/1762248700000-sales-playbook.pdf description: How we qualify and price enterprise deals. isKbFile: true relationships: - objectId: 66a0f1e2d3c4b5a697887766 objectType: organization metadata: created: at: '2026-11-04T09:35:00.000Z' by: 66a0f1e2d3c4b5a697881111 updated: at: '2026-11-04T09:35:00.000Z' by: 66a0f1e2d3c4b5a697881111 '400': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: 'NOT_FOUND: no file with this id in the workspace.' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: File: type: object properties: _id: $ref: '#/components/schemas/ObjectId' id: allOf: - $ref: '#/components/schemas/ObjectId' description: The same value as `_id`. Present in list results only. organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace the file belongs to. fileName: type: string description: The file's display name, as sent when the file was created. fileSize: type: integer description: Size in bytes, as sent when the file was created. mimeType: type: string description: The content type, for example `application/pdf`. url: type: string description: >- Where the file is stored. To download the file, use Get a file download link. storageProvider: type: string description: The storage provider recorded when the file was created. storageKey: type: string description: The file's storage key, inside your workspace's folder. description: type: string description: An optional description. Absent when none was sent. isKbFile: type: boolean description: >- `true` for a knowledge base file (workers read it), `false` for a file attached to a resource. relationships: type: array description: The resources the file is attached to. Not hydrated. items: $ref: '#/components/schemas/FileLink' metadata: $ref: '#/components/schemas/AuditMetadata' ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 FileLink: type: object description: A resource the file is attached to. properties: objectId: allOf: - $ref: '#/components/schemas/ObjectId' description: >- Id of the linked record, task, interaction, or of the workspace itself for a knowledge base file. schemaId: allOf: - $ref: '#/components/schemas/ObjectId' description: >- The linked record's object (base schema). Absent for links that are not records. objectType: type: string description: >- What the link points at: `company`, `people`, `deal` or a custom object's type for a record, `task`, `note`, `comment`, `interaction`, or `organization` for a knowledge base file. example: company AuditMetadata: type: object description: Who created and last changed the resource, and when. properties: created: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: allOf: - $ref: '#/components/schemas/ObjectId' description: Id of the user (or the API key's owner) who created it. updated: type: object properties: at: $ref: '#/components/schemas/Timestamp' by: allOf: - $ref: '#/components/schemas/ObjectId' description: Id of the user who last changed it. Timestamp: type: string format: date-time description: An ISO 8601 date-time in UTC. example: '2026-11-04T09:30:00.000Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.