---
title: "Run Agreement Download URL Generation"
method: POST
path: "/tenants/{tenant_id}/agreements/{id}/download_url/run"
tags: ["Agreements"]
---

# Run Agreement Download URL Generation

`POST /tenants/{tenant_id}/agreements/{id}/download_url/run`

## Request

- Base URL: `https://api-sandbox.aurorasolar.com`
- URL: `https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/agreements/{id}/download_url/run`
- Auth: HTTP bearer

Initiates async generation of a download URL for a Docusign agreement. Only applicable to agreements with `signing_provider: "docusign"`. The agreement must have a status of `signed`.

Note that this is an asynchronous endpoint. See the [Asynchronous Endpoints](ref:asynchronous-endpoints) appendix for more info.

## Path parameters

- `tenant_id` string, uuid, required
- `id` string, uuid, required

## Response `202`

Download URL generation job accepted.

- object
  - `agreement_download_url_job` object
    - `job_id` string, uuid: The unique ID of this async job.
    - `requested_at` string: The timestamp when the job was created, formatted as "YYYY-MM-DD HH:MM:SS UTC"
    - `completed_at` string, nullable: The timestamp when the job completed, formatted as "YYYY-MM-DD HH:MM:SS UTC". Null while in progress.
    - `status` 'in-progress' | 'succeeded' | 'failed': The current status of the download URL generation job.
    - `file_url` string, nullable: The short-lived URL to download the agreement PDF. Only present when status is "succeeded".
    - `filename` string, nullable: The sanitized filename for the agreement PDF. Only present when status is "succeeded".
    - `project_id` string, uuid: The ID of the project that the agreement belongs to.
    - `design_id` string, uuid: The ID of the design that the agreement belongs to.
    - `error` object, nullable: Error details if the job failed.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity

## Changes

- **2026-11-03** `97a7ad8a993a`: 1 info
  - added the optional property `agreement_download_url_job/filename` to the response with the `202` status

[Operation history](https://skmtc.dev/aurorasolar/apis/sync-api/changes/tenants/:tenant_id/agreements/:id/download_url/run/post.md)

---

[API](https://skmtc.dev/aurorasolar/apis/sync-api.md) - [All operations](https://skmtc.dev/aurorasolar/apis/sync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aurorasolar/apis/sync-api/revisions/97a7ad8a993a?raw)