hdply-com API

openapi: 3.1.0
info:
  title: hdply-com API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 8 operation(s) read from 8 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; hdply-com has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 4
    documentation: 4
    pages-with-code: 8
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hdply.com/docs/api
  - https://hdply.com/ar/docs/api
  - https://hdply.com/de/docs/api
  - https://hdply.com/es/docs/api
  - https://hdply.com/fr/docs/api
  - https://hdply.com/hi/docs/api
  - https://hdply.com/id/docs/api
  - https://hdply.com/it/docs/api
servers:
- url: https://api.app.hdply.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://hdply.com/docs/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl, you can use hdply. \n Authentication \n Create your personal API key in the console dashboard (\"API key\" card). Send\
          \ it as a bearer token on every request: \n Authorization: Bearer hdply_sk_… \n The key is shown once at creation; regenerating replaces\
          \ it, deleting revokes it immediately. Keep it secret — it grants access to all of your projects. \n Base URL \n https://api.app.hdply.com\
          \ \n Endpoints"
  /v1/projects:
    get:
      operationId: get_v1_projects
      tags:
      - Projects
      summary: list your projects.
      x-source: https://hdply.com/docs/api
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_projects
      tags:
      - Projects
      summary: POST /v1/projects
      x-source: https://hdply.com/docs/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1ProjectsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://api.app.hdply.com/v1/projects  -H "Authorization: Bearer $HDPLY_KEY"  -H "Content-Type: application/json"  -d
          ''{"html": "<!doctype html><title>Hello</title><h1>Hi!</h1>"}'''
  /v1/projects/{id}:
    get:
      operationId: get_v1_projects_id
      tags:
      - Projects
      summary: one project.
      x-source: https://hdply.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/projects/{id}/deployments:
    get:
      operationId: get_v1_projects_id_deployments
      tags:
      - Projects
      summary: 'deploy history (API deploys are tagged "source": "api" ).'
      x-source: https://hdply.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/projects/{id}/html:
    get:
      operationId: get_v1_projects_id_html
      tags:
      - Projects
      summary: the currently live HTML.
      x-source: https://hdply.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_v1_projects_id_html
      tags:
      - Projects
      summary: publish new HTML (raw text/html body, live the moment the request returns).
      x-source: https://hdply.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV1ProjectsIdHtmlRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/projects/{id}/settings:
    patch:
      operationId: patch_v1_projects_id_settings
      tags:
      - Projects
      summary: switch search-engine indexing on or off.
      x-source: https://hdply.com/docs/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchV1ProjectsIdSettingsRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    PostV1ProjectsRequest:
      type: object
      properties:
        html:
          type: string
    PutV1ProjectsIdHtmlRequest:
      type: object
      properties:
        body:
          type: string
          description: raw text/html body
      required:
      - body
    PatchV1ProjectsIdSettingsRequest:
      type: object
      properties:
        indexable:
          type: boolean
      required:
      - indexable
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Projects