Awzor Media LLC Access API

openapi: 3.2.0
info:
  title: Hook Detector Access API
  description: 'Find short-form hooks that already work.


    Sign up with a beta access code (ask at https://hookdetector.com/access): one POST to

    `/v1/accounts` with `access_code` gives an API key and free credits. The same operations are available as MCP tools at `/mcp`.


    Full guide, always current, at `/llms.txt`.'
  contact:
    name: Hook Detector
    url: https://hookdetector.com/
    email: contact@hookdetector.com
  version: 3.0.0
tags:
- name: Access
paths:
  /v1/access/requests:
    post:
      tags:
      - Access
      summary: Ask for a beta access code by email. No auth
      description: 'Ask for the beta access code a new account needs. Send your email and, if you like,

        a short note. The owner approves the request and the code is emailed to you at once;

        it works once, on the web or as access_code on POST /v1/accounts. The answer is 202

        with status pending (waiting for approval) or emailed (sent now). Asking again while a

        request is pending changes nothing. Limited to 5 requests per address per hour (429).

        No key needed. Free. MCP: request_access.'
      operationId: request_access_v1_access_requests_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessRequestIn'
        required: true
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessRequestOut'
        '413':
          description: request body over the size cap
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: rate limited; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '500':
          description: our fault; names the request id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
components:
  schemas:
    AccessRequestOut:
      properties:
        status:
          type: string
          enum:
          - pending
          - emailed
          title: Status
          description: 'pending: waits for the owner''s approval, then the code is emailed; emailed: the code is on its way now'
        message:
          type: string
          title: Message
      additionalProperties: true
      type: object
      required:
      - status
      - message
      title: AccessRequestOut
      examples:
      - message: Thanks. We will email your access code once the request is approved.
        status: pending
    ErrorOut:
      properties:
        detail:
          type: string
          title: Detail
          description: one sentence a person can read
        code:
          type: string
          title: Code
          description: stable machine code; see the Errors section of /llms.txt
        errors:
          anyOf:
          - items:
              additionalProperties: true
              type: object
            type: array
          - type: 'null'
          title: Errors
          description: 'on a 422 only: the field level list'
      additionalProperties: true
      type: object
      required:
      - detail
      - code
      title: ErrorOut
      examples:
      - code: run_not_found
        detail: no such run for this account
    AccessRequestIn:
      properties:
        email:
          type: string
          title: Email
          description: where the code is sent
          examples:
          - you@example.com
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
          description: 'optional: who you are, what you will use it for (up to 500 characters)'
          examples:
          - I run a clipping agency
      type: object
      required:
      - email
      title: AccessRequestIn