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

# Sign up

> Ask your person to approve a Stophy account for you. Send one request and get JSON back. Examples in cURL, TypeScript and Python.

> [!NOTE]
>
> Needs no API key.

Free, and needs no key. Returns a claimUrl for your person and a secret code. Your person signs in with GitHub or Google and approves. A new account starts with 5,000 free credits. Then send the code to POST /v1/signup/poll to collect the key. Each IP address can sign up a few times a day, then the answer is rateLimited with retryAfterSeconds.

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/signup
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/signup", {
  method: "POST",
});
console.log(await response.json());
```

```python Python theme={null}
import requests

response = requests.post(
    "https://api.stophy.dev/v1/signup",
)
print(response.json())
```

```json 201 theme={null}
{
  "success": true,
  "data": {
    "claimUrl": "<claimUrl>",
    "code": "<code>",
    "expiresAt": "2026-11-06T23:36:07.172Z"
  },
  "creditsUsed": 0,
  "requestId": "23ad30a8-6558-49cf-9c85-960f97d273a1"
}
```


## OpenAPI

````yaml api-reference/openapi.json POST /v1/signup
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description says it costs per 10 results, or
    per second of audio. Then x-credits is the lowest price and x-credits-max
    the most one call can cost. Where an operation takes limit, send it to
    return fewer results and pay for fewer.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/signup:
    post:
      summary: Ask your person to approve a Stophy account for you.
      description: >-
        Free, and needs no key. Returns a claimUrl for your person and a secret
        code. Your person signs in with GitHub or Google and approves. A new
        account starts with $10.00 to spend. Then send the code to POST
        /v1/signup/poll to collect the key. Each IP address can sign up a few
        times a day, then the answer is rateLimited with retryAfterSeconds.
      operationId: signUp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required: []
              properties:
                scopes:
                  type: array
                  items:
                    enum: []
                  description: What the key may do besides the calls every key can make.
      responses:
        '201':
          description: The link for your person and your code.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    required:
                      - claimUrl
                      - code
                      - expiresAt
                    properties:
                      claimUrl:
                        type: string
                        description: The link your person opens to approve the signup.
                      code:
                        type: string
                        description: >-
                          Keep it secret. Send it to /v1/signup/poll to collect
                          the key.
                      expiresAt:
                        type: string
                        format: date-time
                        description: >-
                          When the link and the code stop working. Sign up again
                          after that.
                  creditsUsed:
                    type: integer
                    const: 0
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      security: []
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. Retry-After says when trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: What went wrong and what to do next.
        code:
          type: string
          enum:
            - apiKeyRequired
            - cliSessionCompleted
            - cliSessionExists
            - cliSessionNotFound
            - forbidden
            - freeLimit
            - insufficientCredits
            - internalError
            - inviteClaimed
            - inviteDisabled
            - inviteExpired
            - inviteUsedUp
            - invalidCliSession
            - invalidCliVerifier
            - invalidRequest
            - jobFinished
            - methodNotAllowed
            - notFound
            - payloadTooLarge
            - profileBusy
            - profileTooLarge
            - rateLimited
            - sourceChanged
            - sourceRefused
            - siteNotRead
            - sourceTimeout
            - sourceUnavailable
            - unauthorized
            - unsupportedMediaType
        retryAfterSeconds:
          type: integer
        signupUrl:
          type: string
          const: https://stophy.dev/signup
          description: >-
            Where a person gets a key. Sent with apiKeyRequired, freeLimit and
            an invalid key.
        signup:
          type: string
          const: POST https://api.stophy.dev/v1/signup
          description: >-
            The call that gets an agent a key with no human. Sent next to
            signupUrl.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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