find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/escape:escape-upload-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Escape Upload API
  version: 3.0.0
  description: 'Operations tagged Upload across 2 of this provider''s published API definitions: escape-openapi.json, escape-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://public.escape.tech/v3
security:
- apiKey: []
tags:
- name: Upload
  description: 'Upload helper for Escape Platform.


    The public API provides endpoints to upload files to the platform.'
paths:
  /upload/signed-url:
    post:
      tags:
      - Upload
      summary: Create signed URL
      operationId: createUploadSignedUrl
      description: '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]"

        ```'
      parameters:
      - schema:
          type: string
          minLength: 1
          maxLength: 255
          description: 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`.
          example: application/json
        required: false
        description: 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`.
        name: contentType
        in: query
      - schema:
          type: string
          minLength: 1
          maxLength: 255
          description: The original file name, e.g. `schema.har`. Used to build the storage key so the uploaded object keeps its original name.
          example: schema.har
        required: false
        description: The original file name, e.g. `schema.har`. Used to build the storage key so the uploaded object keeps its original name.
        name: filename
        in: query
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    maxLength: 1024
                    format: uri
                    description: The signed URL to upload a file to the Escape Platform.
                  id:
                    type: string
                    format: uuid
                    description: The signed URL ID to upload a file to the Escape Platform.
                required:
                - url
                - id
    servers:
    - url: https://public.escape.tech/v3
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-ESCAPE-API-KEY
x-refined-from:
- escape-openapi.json
- escape-openapi.yml