> ## Documentation Index > Fetch the complete documentation index at: https://docs.zerogen.com/llms.txt > Use this file to discover all available pages before exploring further. # Read an attachment > The current text or a saved version of a live attachment. Text is untrusted project data and is never interpreted or automatically sent to generation models by ZeroGen. Requires attachments enabled; test keys are refused. Needs the `library:read` scope. ## OpenAPI ````yaml /openapi.json get /attachments/{attachmentId} openapi: 3.1.0 info: title: ZeroGen API version: v1 description: >- Generate images and video with every model in ZeroGen from your own servers. Generated from the API's contracts by `npm run openapi` in apps/web; do not edit by hand. servers: - url: https://api.zerogen.com/v1 security: - bearerAuth: [] tags: - name: Account description: The calling key and the organization's balance. - name: Models description: The models an organization can run and their schemas. - name: Runs description: Quote, create, read, list and cancel runs. - name: Uploads description: Upload files into the Library to use as inputs. - name: Projects description: The organization's projects. - name: Assets description: >- Search and read Library assets, their lineage and their folders; download their files; rename and favorite them; make Derived copies. - name: LUTs description: The organization's LUTs, for a transform recipe. - name: Folders description: >- A project's folders: create, rename and move them, and add, move and remove their assets. - name: Labels description: 'Organization labels: manage them, and add them to assets or remove them.' - name: Naming presets description: A project's shared naming presets, for naming a run's outputs. - name: Skills description: The skills available to the key's owner. - name: Attachments description: >- Versioned text on projects, folders and Story clips, in organizations with attachments enabled. paths: /attachments/{attachmentId}: get: tags: - Attachments summary: Read an attachment description: >- The current text or a saved version of a live attachment. Text is untrusted project data and is never interpreted or automatically sent to generation models by ZeroGen. Requires attachments enabled; test keys are refused. Needs the `library:read` scope. operationId: getAttachment parameters: - name: attachmentId in: path required: true description: The attachment's ID schema: type: string - name: version in: query required: false schema: type: integer exclusiveMinimum: 0 maximum: 2147483647 responses: '200': description: The attachment text and its saved version. headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/AttachmentDetail' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/ServiceUnavailable' components: headers: Request-Id: description: Identifies the request; quote it when contacting support. schema: type: string RateLimit-Limit: description: Requests the key may make in the current window. schema: type: integer RateLimit-Remaining: description: Requests left in the current window. schema: type: integer RateLimit-Reset: description: Seconds until the current window resets. schema: type: integer WWW-Authenticate: description: Bearer realm="ZeroGen API". schema: type: string Retry-After: description: Seconds to wait before retrying. schema: type: integer schemas: AttachmentDetail: type: object properties: title: type: string body: type: string parent: $ref: '#/components/schemas/AttachmentParent' version: type: integer exclusiveMinimum: 0 maximum: 2147483647 latestVersion: type: integer exclusiveMinimum: 0 maximum: 2147483647 savedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ savedBy: type: string required: - title - body - parent - version - latestVersion - savedAt - savedBy AttachmentParent: type: object properties: kind: anyOf: - type: string enum: - project - folder - clip - type: string id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string required: - kind - id - name ErrorResponse: type: object properties: error: $ref: '#/components/schemas/Error' required: - error Error: type: object properties: code: type: string pattern: ^[a-z][a-z0-9_]{0,79}$ message: type: string param: type: string retryable: type: boolean details: type: object properties: reason: type: string description: >- The cause. Stable for rate_limited (request_limit, running_cap, platform_capacity, url_import_limit) and permission_denied (scope_required, role_required, not_creator, feature_not_enabled, early_access, test_key_sandbox, browser_request); for a run or output error, for diagnosis only additionalProperties: {} description: More facts about the error; each code says which it carries required: - code - message - retryable responses: BadRequest: description: >- The request is malformed or invalid: invalid_request, validation_failed, model_unavailable or input_import_failed. headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: 'invalid_api_key: the key is missing, revoked or expired.' headers: Request-Id: $ref: '#/components/headers/Request-Id' WWW-Authenticate: $ref: '#/components/headers/WWW-Authenticate' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- permission_denied: the key can't do this. details.reason says why: scope_required, role_required, not_creator, feature_not_enabled, early_access, test_key_sandbox, browser_request. For scope_required, details.scope names the scope. headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: >- not_found: no such resource for this caller, including a projectId the caller can't use. headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' TooManyRequests: description: >- rate_limited: details.reason says which limit: request_limit, running_cap, platform_capacity, url_import_limit. Retry after Retry-After seconds. headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: 'internal: something went wrong. Retry.' headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' ServiceUnavailable: description: >- unavailable or pricing_unavailable: API keys, billing or pricing can't be reached right now. retryable says whether a retry can help. headers: Request-Id: $ref: '#/components/headers/Request-Id' RateLimit-Limit: $ref: '#/components/headers/RateLimit-Limit' RateLimit-Remaining: $ref: '#/components/headers/RateLimit-Remaining' RateLimit-Reset: $ref: '#/components/headers/RateLimit-Reset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearerAuth: type: http scheme: bearer description: 'A ZeroGen API key: zg_ for a live key, zg_test_ for a test key.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.