> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get file metadata and content links

> Inspect a persistent file without downloading content. The UUID in an existing /artifacts/{id} viewer URL is its fileId. Links are same-origin paths requiring the same Bearer authentication; follow text to read extracted text or download for the original. Metadata describes the current file. Metadata does not guarantee export permission or storage availability; content endpoints recheck access. This read does not extract text or acquire files.



## OpenAPI

````yaml /openapi.json get /files/{fileId}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /files/{fileId}:
    get:
      tags:
        - Files
      summary: Get file metadata and content links
      description: >-
        Inspect a persistent file without downloading content. The UUID in an
        existing /artifacts/{id} viewer URL is its fileId. Links are same-origin
        paths requiring the same Bearer authentication; follow text to read
        extracted text or download for the original. Metadata describes the
        current file. Metadata does not guarantee export permission or storage
        availability; content endpoints recheck access. This read does not
        extract text or acquire files.
      operationId: getFile
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: fileId
          in: path
      responses:
        '200':
          description: Current file metadata and authenticated content links.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2File'
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Operation not permitted by credential scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: File is missing, inaccessible, or not a persistent file.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Temporarily unavailable. Retry-After is in seconds.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2File:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Persistent file ID; the UUID in an /artifacts/{id} viewer URL.
        name:
          type: string
        mimeType:
          type: string
          nullable: true
          description: Recorded MIME type, or null when unknown.
        sizeBytes:
          type: integer
          nullable: true
          minimum: 0
          description: Recorded original file size in bytes, or null when unknown.
        versionId:
          type: string
          nullable: true
          description: Recorded current file version, or null for a legacy file.
        links:
          type: object
          properties:
            self:
              type: string
              description: Same-origin path. API links require Bearer authentication.
            viewer:
              type: string
              description: Same-origin path. API links require Bearer authentication.
            text:
              type: string
              description: >-
                Read up to 65536 UTF-8 bytes of existing text; follow nextCursor
                with the same maxBytes until null. Text is not pinned to the
                original file version.
            download:
              type: string
              description: >-
                Download the recorded current version when known, otherwise
                resolve the current version at download time. For a historical
                viewer URL, pass its versionId instead.
          required:
            - self
            - viewer
            - text
            - download
      required:
        - id
        - name
        - mimeType
        - sizeBytes
        - versionId
        - links
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
              description: Dataset needed for dataset_not_enabled.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.