> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hitl.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Sign up an agent

> Gets an API key with the human's email, no browser needed. The human gets an email with a 6-digit code and a Confirm link. Until they confirm, the key can read and draft workflows; anything else answers `403` with `code: confirmation_required`. The answer is the same whether the email has an account. Limits: 3 an hour and 5 a day per email. No API key needed.



## OpenAPI

````yaml POST /api/signup
openapi: 3.1.0
info:
  title: HITL API
  version: 1.0.0
  description: >-
    Run the workflows you build in HITL, follow each run until a person has
    answered, and manage who reviews them.
servers:
  - url: https://api.hitl.sh/v1
security:
  - bearerAuth: []
tags:
  - name: Workflows
  - name: Runs
  - name: Reviewers
  - name: Webhooks
  - name: Account
  - name: Uploads
paths:
  /api/signup:
    post:
      tags:
        - Account
      summary: Sign up an agent
      description: >-
        Gets an API key with the human's email, no browser needed. The human
        gets an email with a 6-digit code and a Confirm link. Until they
        confirm, the key can read and draft workflows; anything else answers
        `403` with `code: confirmation_required`. The answer is the same whether
        the email has an account. Limits: 3 an hour and 5 a day per email. No
        API key needed.
      operationId: account-signup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                agent_name:
                  type: string
                  description: Shown in the email
            example:
              email: ada@example.com
              agent_name: Claude Code
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
              example:
                error: false
                msg: Check your email
                data:
                  api_key: hitl_live_…
                  status: pending
                  email: a***@example.com
                  next: >-
                    Ask your human for the 6-digit code in the email, then POST
                    /v1/api/signup/confirm
        '400':
          $ref: '#/components/responses/E400'
        '429':
          $ref: '#/components/responses/E429'
      security: []
components:
  responses:
    E400:
      description: Invalid input; `msg` says what to fix
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: true
            msg: Invalid execution id
    E429:
      description: 'Rate limit: 1,000 requests an hour per key on /workflows and /executions'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: true
            msg: Rate limit exceeded
  schemas:
    Error:
      type: object
      required:
        - error
        - msg
      properties:
        error:
          type: boolean
          example: true
        msg:
          type: string
          description: What went wrong, in plain words
        code:
          type: string
          description: >-
            A machine-readable reason, when there is one (for example
            `confirmation_required`)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: `hitl_live_…`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.