Speakeasy ShortURLs API

REST APIs for managing short URLs

OpenAPI Specification

speakeasy-shorturls-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  description: The Subscriptions API manages subscriptions for CLI and registry events
  title: Speakeasy Artifacts ShortURLs API
  version: 0.4.0
servers:
- url: https://api.prod.speakeasy.com
  x-speakeasy-server-id: prod
security:
- APIKey: []
- WorkspaceIdentifier: []
- Bearer: []
tags:
- name: ShortURLs
  description: REST APIs for managing short URLs
paths:
  /v1/short_urls:
    post:
      summary: Shorten a URL
      operationId: create
      tags:
      - ShortURLs
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: URL to shorten
              required:
              - url
        required: true
      responses:
        2XX:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShortURL'
components:
  schemas:
    ShortURL:
      type: object
      properties:
        short_url:
          type: string
        full_url:
          type: string
      required:
      - short_url
      - full_url
  securitySchemes:
    APIKey:
      description: The API Key for the workspace
      in: header
      name: x-api-key
      type: apiKey
    WorkspaceIdentifier:
      description: The API Key for the workspace
      in: header
      name: x-workspace-identifier
      type: apiKey
    Bearer:
      description: The Bearer token for the workspace
      type: http
      scheme: bearer
externalDocs:
  url: /docs
  description: The Speakeasy Platform Documentation
x-speakeasy-globals:
  parameters:
  - name: workspace_id
    in: path
    schema:
      type: string