---
title: "Create signed URL"
method: POST
path: "/upload/signed-url"
tags: ["Upload"]
---

# Create signed URL

`POST /upload/signed-url`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/upload/signed-url`
- Auth: API key in header `X-ESCAPE-API-KEY`

Retrieve a signed URL link to upload a file to the Escape Platform.

By running a query with this endpoint, you will receive a signed URL that you can use to upload a file to the Escape Platform.

```json
{
  "url": "[SIGNED URL]",
  "id": "[SIGNED URL ID]"
}
```

With the url, you are able to upload one file:

```bash
curl -X PUT --data-binary '@./schema.json' "[SIGNED URL]"
```

Now, you are able to use the previously received id in another query.
For example to update a schema of your application.

Optionally pass `contentType` and `filename` query parameters so the uploaded object keeps its
MIME type and original name:

```bash
curl -X POST "/v3/upload/signed-url?contentType=application/json&filename=schema.har"
```

When `contentType` is provided it is part of the signed request, so the `PUT` must send the same
`Content-Type` header:

```bash
curl -X PUT -H "Content-Type: application/json" --data-binary '@./schema.json' "[SIGNED URL]"
```

## Query parameters

- `contentType` string: The MIME type of the file to upload, e.g. `application/json`. Stored on the uploaded object. When provided, the `PUT` must send the same `Content-Type`.
- `filename` string: The original file name, e.g. `schema.har`. Used to build the storage key so the uploaded object keeps its original name.

## Response `200`

OK

- object
  - `url` string, uri, required: The signed URL to upload a file to the Escape Platform.
  - `id` string, uuid, required: The signed URL ID to upload a file to the Escape Platform.

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)