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

# Export an object to a file

> Exports an object in one of the formats the editor's Export menu offers for
it, and saves the file to the project as a reference: a document as `pdf`
or `docx`, slides as `pptx` or `pdf`, a table as `xlsx`, a figure as `png`
or `svg`. The file is the one the Export menu produces, with the same
styles, page size, and headers and footers.

Download the bytes from `file.contentUrl`. PDF exports report `pageCount`,
so a caller can check that a document fits.

The export runs on the server, in the same exporters the editor uses,
whether or not anyone has the project open. The saved file is
uncommitted until the branch is committed.




## OpenAPI

````yaml /openapi/davinci-public.v2.yaml post /api/v2/projects/{projectId}/objects/{objectId}/exports
openapi: 3.1.0
info:
  title: Davinci Public API
  version: 2.0.0
  description: >
    Public Routing Server API contract for Davinci integrations and official
    SDKs.


    Most operations live on the canonical `/api/v2/projects` mount and accept a

    personal access token (`dav_ak_live_…` / `dav_ak_test_…`) or browser access

    token. Evaluation-run creation is the deliberate exception: it accepts only
    a

    `purpose=automation` grant issued to a running Code execution.

    Project membership and role are checked on every user call, and an API key
    is

    additionally bounded by the permission ceiling derived from its scopes — a
    key

    can never exceed what its owner can do, and usually does less.


    Collaboration operations (invitations, membership changes, ownership
    transfer)

    are deliberately absent: they require a browser session and are not part of
    the

    programmatic surface.


    ## Two planes


    Most operations are **control plane**: they run on the Routing Server, take

    small requests, and answer quickly. A few are **data plane**, marked

    `x-plane: data`, and go straight to the machine holding your project — the
    only

    practical way to move multi-gigabyte files or hold a connection open for
    half

    an hour.


    Data-plane operations use a different host and a different credential.
    Create a

    session on a project and it returns both: a `dataPlane.url` to send to and a

    short-lived `dataPlane.token` (`dav_gr_…`, a *grant*) to send with. A grant

    reaches exactly one project, carries no more permission than the key that

    minted it, expires in minutes, and dies when its session closes. It is not

    interchangeable with an API key in either direction.


    The data-plane host never names a specific machine, so a project that moves

    between machines mid-session stays reachable at the same URL.
servers:
  - url: https://davinci-app.com
    description: Production (control plane)
  - url: https://davinci-app.com/data
    description: >-
      Production (data plane). Serves the operations marked `x-plane: data`,
      using a session's grant rather than an API key.
security:
  - ApiKeyBearer: []
tags:
  - name: Projects
    description: >-
      Create, inspect, open, close, and delete projects, and manage their
      attached files.
  - name: Content
    description: >
      Read and write the objects a project is made of. These reach the running

      project rather than storage, so they see uncommitted work — and so they
      open

      the project if it is not already open.
  - name: Branches
    description: >
      Branches, commits, and the history of a single object. A commit captures
      the

      running project's state, so these operations need the branch loaded, which
      they

      arrange for the caller.
  - name: Sessions
    description: >
      A session opens a project, holds it open, and issues the grant that
      reaches the

      data plane. It is the programmatic equivalent of having a project open in
      a

      browser tab: while it lives, the project stays loaded.


      It is also where the agent lives. Send it a prompt, read its status from
      the

      session, read the transcript back, and stop a run that is going the wrong
      way.
  - name: AgentModels
    description: >
      Chat models available to your account. The returned keys are the values
      accepted

      by the session message API; availability follows your subscription,
      tenant, and

      any profile assigned to your account.
  - name: Tools
    description: >
      Invoke one of the agent's tools yourself, without the agent. Useful when
      you

      already know the operation you want and do not need a model to choose it —
      and

      when you want a deterministic result rather than an interpreted one.


      A tool is still held to the permissions of the credential invoking it, so
      a

      key cannot reach through a tool to something its scopes exclude.
  - name: Files
    description: >
      Data-plane file transfer. These reach your project's machine directly
      using a

      session's grant, which is what allows request bodies far larger than the

      control plane accepts.
  - name: Usage
    description: >
      What your models cost, broken down by model, project, session, or day.
      These

      read the usage ledger, which records one event per completed provider call
      —

      not your balances and limits, which are `/api/v2/users/me/accounting`.


      Usage is reported on an interval rather than per call, so a run that is
      still

      going may not be fully counted yet. Every response carries `asOf`, the
      moment

      the newest counted event was recorded, so you can see how current a total
      is

      instead of guessing.


      This is separate from `projects:read` on purpose: a key that reads your

      project data is not thereby allowed to see what you spend.
  - name: Evaluations
    description: |
      Lifecycle for the ephemeral target sandbox an evaluation runs against.
      Creation is available only to a `purpose=automation` grant issued to a
      running Code execution, so a sandbox always belongs to code rather than to
      a person's key. It returns a second, `purpose=evaluation` grant bound to
      the new sandbox; it never upgrades or replaces the source credential.
  - name: Tests
    description: >
      Asynchronously run an authored Test. The Test executes its linked Code

      object and applies its native evaluation criteria to derive the verdict.

      This is one way to start Code, not a prerequisite for anything the Code
      can

      do: the same function called directly holds the same authority.
  - name: Organizations
    description: Discover organizations available as containers for team planning.
  - name: Cards
    description: >
      Project-scoped agile cards, their index hierarchy, comments, tags,
      assignees,

      card dependencies, and design-object references. Project access is checked

      on every call; an inaccessible project is reported as not found.
  - name: Teams
    description: >
      Organization-scoped team boards, linked projects, workflow columns,
      sprints,

      analytics, and card placements. Team visibility is privacy preserving:

      inaccessible organizations, private teams, and cross-organization ids are

      reported as not found rather than revealing that they exist.
paths:
  /api/v2/projects/{projectId}/objects/{objectId}/exports:
    parameters:
      - $ref: '#/components/parameters/ProjectId'
      - $ref: '#/components/parameters/ObjectId'
    post:
      tags:
        - Content
      summary: Export an object to a file
      description: >
        Exports an object in one of the formats the editor's Export menu offers
        for

        it, and saves the file to the project as a reference: a document as
        `pdf`

        or `docx`, slides as `pptx` or `pdf`, a table as `xlsx`, a figure as
        `png`

        or `svg`. The file is the one the Export menu produces, with the same

        styles, page size, and headers and footers.


        Download the bytes from `file.contentUrl`. PDF exports report
        `pageCount`,

        so a caller can check that a document fits.


        The export runs on the server, in the same exporters the editor uses,

        whether or not anyone has the project open. The saved file is

        uncommitted until the branch is committed.
      operationId: exportProjectObject
      parameters:
        - $ref: '#/components/parameters/Branch'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExportObjectRequest'
      responses:
        '201':
          description: The object was exported and the file saved to the project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportObjectResponse'
        '400':
          description: The request body is malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >
            Project or object not found. Error code is `OBJECT_NOT_FOUND` when
            the

            project was readable but the object was not in it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          $ref: '#/components/responses/ProjectNotRunning'
        '422':
          description: >
            The export failed (`EXPORT_FAILED`), most often because the object

            does not offer the requested format; the message lists the formats
            it

            does offer.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          description: >
            The export could not run right now: the export service is
            unavailable

            (`EXPORT_UNAVAILABLE`), or the project could not save the file

            (`PROJECT_NOT_READY`). Retry after a moment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '504':
          description: The browser did not finish the export in time (`EXPORT_TIMED_OUT`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - ApiKeyBearer: []
      x-codeSamples:
        - lang: typescript
          label: TypeScript SDK
          source: >
            import { DavinciClient } from '@celedon/davinci-sdk';


            const client = new DavinciClient({
              apiKey: process.env.DAVINCI_API_KEY!,
            });


            const exported = await client.content.exportObject(projectId,
            documentId, { format: 'pdf' });

            console.log(exported.file.id, exported.pageCount);

            const pdf = await client.projects.downloadFile(projectId,
            exported.file.id);
        - lang: python
          label: Python SDK
          source: |
            import os
            from davinci_sdk import DavinciClient

            with DavinciClient(api_key=os.environ["DAVINCI_API_KEY"]) as client:
                exported = client.content.export_object(project_id, document_id, format="pdf")
                print(exported.file.id, exported.page_count)
                pdf = client.projects.download_file(project_id, exported.file.id)
components:
  parameters:
    ProjectId:
      name: projectId
      in: path
      required: true
      schema:
        type: string
        minLength: 1
      description: Project id. May be compound in the form `{projectId}--{branchName}`.
    ObjectId:
      name: objectId
      in: path
      required: true
      schema:
        type: string
        minLength: 1
      description: Id of an object in the project.
    Branch:
      name: branch
      in: query
      required: false
      schema:
        type: string
        default: main
  schemas:
    ExportObjectRequest:
      type: object
      required:
        - format
      properties:
        format:
          type: string
          minLength: 1
          description: >
            A format the Export menu offers for the object, such as `pdf`,
            `docx`,

            `pptx`, `xlsx`, `png`, `svg`, or `html`. Case-insensitive. Print
            PDF,

            which ends in the browser's print dialog, is not offered.
        displayType:
          type: string
          description: >
            View to export, for objects with more than one (for example `table`
            or

            `tree`). Defaults to the view the object opens in.
        dpi:
          type: integer
          minimum: 72
          maximum: 600
          description: Resolution for raster content in PDF exports. Defaults to 300.
        parentId:
          type: string
          description: |
            Package to save the file in, such as the Library,
            `00000000-0000-0000-0000-00000library`. Defaults to the exported
            object's parent.
      additionalProperties: false
    ExportObjectResponse:
      type: object
      required:
        - objectId
        - format
        - file
        - pageCount
      properties:
        objectId:
          type: string
        format:
          type: string
          description: The format exported, lower-case.
        file:
          type: object
          description: The reference the export was saved as.
          required:
            - id
            - name
            - mimeType
            - size
            - contentUrl
          properties:
            id:
              type: string
              description: Id of the new reference object.
            name:
              type: string
            mimeType:
              type: string
            size:
              type: integer
              minimum: 0
              description: Size in bytes.
            contentUrl:
              type: string
              description: API path that downloads the file's bytes.
          additionalProperties: true
        pageCount:
          type:
            - integer
            - 'null'
          minimum: 1
          description: Number of pages, for PDF exports; null for other formats.
      additionalProperties: true
    ErrorEnvelope:
      description: >
        The error shape for every failure on this API, whether it was refused by
        the

        credential layer before reaching a domain or by the domain itself.


        Branch on `code`, which is stable. `message` is for a person reading a
        log or

        a dialog and may be reworded. `details` carries fields specific to one

        failure — a project-limit refusal reports its numbers there — and is
        absent

        when there are none.
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          additionalProperties: true
      additionalProperties: true
  responses:
    Unauthorized:
      description: >
        No credential was supplied, or the supplied credential is malformed,
        expired,

        or revoked. A credential that is present but unusable is never
        downgraded to

        an anonymous request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        Authenticated but not authorized. Either the acting user lacks the
        required

        resource permission, the key's scope ceiling excludes it, or the
        endpoint

        rejects this credential type (`CREDENTIAL_NOT_PERMITTED`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    ProjectNotRunning:
      description: >
        The project stopped running between being opened for this request and
        the

        request reaching it. Error code is `PROJECT_NOT_RUNNING`. Retry: the
        next call

        opens it again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Request rate exceeded, either globally or for this key.
      headers:
        Retry-After:
          schema:
            type: integer
            minimum: 1
          description: Seconds to wait before retrying.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: dav_ak_live_... or dav_ak_test_...
      x-default: dav_ak_live_your_token
      description: >
        Personal access token. The scopes granted at issuance determine both
        which

        operations the key may call and the ceiling on the resource permissions
        it

        can exercise. Each scope family is a ladder: `projects:manage` implies

        `projects:write` and `projects:read`; `cards:manage` implies
        `cards:write`

        and `cards:read`; and `teams:manage` implies `teams:write` and
        `teams:read`.

        These are named API capability bundles, not blanket domain roles:

        `manage` exposes only the permissions enumerated for that scope and
        never

        bypasses the acting user's current role-based access.

````

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