> ## 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.

# Retrieve a temporary browser download

> Retrieve the original bytes of a completed download created by the session browser adapter. This does not trigger another website request. Download and file identifiers must come from that adapter; arbitrary browser filesystem paths are not accepted.

Requires edit access to the session and control of its active browser. Access is checked again during transfer. A 404 may mean the browser has ended or the download is not yet ready; repeating GET is safe. Files are temporary and disappear when removed or when the browser ends.



## OpenAPI

````yaml /openapi.json get /sessions/{sessionId}/browsers/{browserId}/downloads/{downloadId}/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:
  /sessions/{sessionId}/browsers/{browserId}/downloads/{downloadId}/files/{fileId}:
    get:
      tags:
        - Sessions
      summary: Retrieve a temporary browser download
      description: >-
        Retrieve the original bytes of a completed download created by the
        session browser adapter. This does not trigger another website request.
        Download and file identifiers must come from that adapter; arbitrary
        browser filesystem paths are not accepted.


        Requires edit access to the session and control of its active browser.
        Access is checked again during transfer. A 404 may mean the browser has
        ended or the download is not yet ready; repeating GET is safe. Files are
        temporary and disappear when removed or when the browser ends.
      operationId: getSessionBrowserDownload
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: sessionId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: browserId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: downloadId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: fileId
          in: path
      responses:
        '200':
          description: >-
            Original file bytes. A failed or interrupted stream must be
            discarded.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: 'invalid_request: invalid download identifier.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: 'unauthenticated: valid credentials are required.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            forbidden: session edit access and control of the browser are
            required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: 'not_found: the active browser or temporary download is unavailable.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '423':
          description: >-
            browser_locked: the browser is signed in with another person’s own
            login.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: 'temporarily_unavailable: retry the transfer later.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    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
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: Not currently returned.
          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.