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

# Build a tool

> Build a new tool for a task on a website. A build takes about 10 minutes and runs the requested example once; the tool is reused after that. Answers its job at once; follow it with GET /v1/jobs/{id} or job webhooks. A build that finds an existing tool covering the task hands it over as tool_id and build.existing_tool_id. Builds for ticket, bank and government sites are refused with site_not_supported.

**Authentication:** `Authorization: Bearer <token>` with Dashboard session, Pomerado MCP OAuth token, API key, integration API key.

**Permission:** `tools:build`.

**Effect:** Write: creates or changes something in your account.

**Errors:** [`effect_required`](/errors#effect_required) (400), [`invalid_request`](/errors#invalid_request) (400), [`unauthorized`](/errors#unauthorized) (401), [`reauthentication_required`](/errors#reauthentication_required) (401), [`save_forbidden`](/errors#save_forbidden) (403), [`site_not_supported`](/errors#site_not_supported) (403), [`forbidden`](/errors#forbidden) (403), [`not_found`](/errors#not_found) (404), [`idempotency_conflict`](/errors#idempotency_conflict) (409), [`quota_expired`](/errors#quota_expired) (409), [`account_selection_required`](/errors#account_selection_required) (409), [`saved_login_conflict`](/errors#saved_login_conflict) (409), [`login_identity_conflict`](/errors#login_identity_conflict) (409), [`legacy_duplicate_saved_logins`](/errors#legacy_duplicate_saved_logins) (409), [`saved_login_unsettled`](/errors#saved_login_unsettled) (409), [`request_too_large`](/errors#request_too_large) (413), [`quota_exceeded`](/errors#quota_exceeded) (429), [`internal_error`](/errors#internal_error) (500), [`not_configured`](/errors#not_configured) (501), [`acceptance_unknown`](/errors#acceptance_unknown) (503), [`temporarily_unavailable`](/errors#temporarily_unavailable) (503). Every error has the same [envelope](/errors).


## OpenAPI

````yaml /api-reference/openapi.json post /v1/builds
openapi: 3.1.0
info:
  title: Pomerado API
  version: '1'
  description: >-
    Run and build website tools, follow their jobs, and manage logins, API keys
    and webhooks. Authenticate with a Pomerado API key (pom_…), an MCP OAuth
    token or a Dashboard session as a Bearer token.
servers:
  - url: https://api.pomerado.ai
security: []
tags:
  - name: account
    x-group: Account
  - name: api_keys
    x-group: API keys
  - name: connected_apps
    x-group: Connected apps
  - name: usage
    x-group: Usage
  - name: quota
    x-group: Quota
  - name: billing
    x-group: Billing
  - name: integrations
    x-group: Integrations
  - name: connect
    x-group: Connect
  - name: logins
    x-group: Logins
  - name: tools
    x-group: Tools
  - name: webhooks
    x-group: Webhooks
  - name: runs
    x-group: Runs
  - name: builds
    x-group: Builds
  - name: jobs
    x-group: Jobs
  - name: support
    x-group: Support
paths:
  /v1/builds:
    post:
      tags:
        - builds
      summary: Build a tool
      description: >-
        Build a new tool for a task on a website. A build takes about 10 minutes
        and runs the requested example once; the tool is reused after that.
        Answers its job at once; follow it with GET /v1/jobs/{id} or job
        webhooks. A build that finds an existing tool covering the task hands it
        over as tool_id and build.existing_tool_id. Builds for ticket, bank and
        government sites are refused with site_not_supported.
      operationId: builds.create
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Repeat a request safely: the same key and body answer the first
            request's job again with Idempotent-Replayed: true; the same key
            with a different body answers idempotency_conflict.
          schema:
            type: string
            description: 1 to 200 letters, digits, _ or -, such as a UUID
            pattern: ^[A-Za-z0-9_-]{1,200}$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - task
              properties:
                task:
                  type: string
                  description: What the tool should do, in words
                  minLength: 1
                  maxLength: 20000
                site_url:
                  type: string
                  description: >-
                    The website's https address; omit it for offline parsing,
                    which is a read
                  maxLength: 2048
                start_url:
                  type: string
                  description: >-
                    The exact https page on site_url the build starts on, path,
                    query and fragment kept
                  maxLength: 4096
                effect:
                  type: string
                  enum:
                    - read
                    - write
                    - ask
                  description: >-
                    read when the tool only looks things up; write when it
                    changes the website (submitting, booking, saving a form,
                    uploads, account updates); ask to have the build ask first.
                    A website build needs one.
                example_input:
                  anyOf:
                    - type: object
                    - type: array
                    - type: string
                    - type: number
                    - type: boolean
                    - type: 'null'
                  description: The input of the one real example the build runs
                login_id:
                  allOf:
                    - $ref: '#/components/schemas/login_id'
                  description: The saved login to sign in with, when the site has several
                login:
                  type: object
                  required:
                    - username
                  properties:
                    label:
                      type: string
                      description: a string at most 200 character(s) long
                      minLength: 1
                      maxLength: 200
                    username:
                      type: string
                      description: a string at most 1024 character(s) long
                      minLength: 1
                      maxLength: 1024
                    password:
                      type: string
                      description: a string at most 16384 character(s) long
                      minLength: 1
                      maxLength: 16384
                    mode:
                      type: string
                      enum:
                        - code
                    email:
                      type: string
                      description: a string at most 320 character(s) long
                      minLength: 3
                      maxLength: 320
                    phone:
                      type: string
                      description: a string at most 64 character(s) long
                      minLength: 3
                      maxLength: 64
                    account_number:
                      type: string
                      description: a string at most 128 character(s) long
                      minLength: 1
                      maxLength: 128
                    date_of_birth:
                      type: string
                      description: >-
                        a string matching the pattern
                        ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$
                      pattern: ^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$
                    zip:
                      type: string
                      description: a string at most 10 character(s) long
                      minLength: 3
                      maxLength: 10
                  additionalProperties: false
                  description: >-
                    A login for this call, used only when the site has no saved
                    login: a username (or email, phone or account number) with
                    its password, or mode "code" and no password when the site
                    sends a code. It reaches this caller's client and model
                    provider; without one, the run asks the person on its answer
                    page.
                save_login:
                  type: boolean
                  description: Keep login as a saved login (requires login)
                redact_at_rest:
                  type: boolean
                  description: >-
                    Staging and preview only: true seals what this job stores
                    and redacts it once it settles, false keeps it readable,
                    overriding the environment's setting. Production refuses a
                    request that names it with invalid_request.
              additionalProperties: false
      responses:
        '200':
          description: >-
            The job this Idempotency-Key already started, with
            Idempotent-Replayed: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '202':
          description: The new build's job
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          description: effect_required, invalid_request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: unauthorized, reauthentication_required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: save_forbidden, site_not_supported, forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            idempotency_conflict, quota_expired, account_selection_required,
            saved_login_conflict, login_identity_conflict,
            legacy_duplicate_saved_logins, saved_login_unsettled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: request_too_large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: quota_exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: internal_error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '501':
          description: not_configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: acceptance_unknown, temporarily_unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearer: []
components:
  schemas:
    login_id:
      type: string
      description: 'a saved login ID: login_ and 32 lowercase hex digits'
      examples:
        - login_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
    Job:
      type: object
      required:
        - id
        - type
        - status
        - tool_id
        - input_request
        - result
        - result_expires_at
        - write_status
        - login_save
        - error
        - message
        - maintenance
        - build
        - watch_url
        - created_at
        - updated_at
        - completed_at
      properties:
        id:
          $ref: '#/components/schemas/job_id'
        type:
          type: string
          enum:
            - run
            - build
        status:
          type: string
          enum:
            - queued
            - running
            - needs_input
            - succeeded
            - failed
            - cancelled
        tool_id:
          anyOf:
            - type: string
            - type: 'null'
        input_request:
          anyOf:
            - $ref: '#/components/schemas/InputRequest'
            - type: 'null'
        result:
          $id: /schemas/unknown
        result_expires_at:
          anyOf:
            - $ref: '#/components/schemas/Date'
            - type: 'null'
        write_status:
          anyOf:
            - type: string
              enum:
                - not_attempted
                - may_have_applied
                - applied
                - not_applied
            - type: 'null'
        login_save:
          anyOf:
            - type: object
              required:
                - status
                - login_id
                - reason
              properties:
                status:
                  type: string
                  enum:
                    - saved
                    - not_saved
                    - failed
                login_id:
                  anyOf:
                    - type: string
                    - type: 'null'
                reason:
                  anyOf:
                    - type: string
                    - type: 'null'
              additionalProperties: false
            - type: 'null'
        error:
          anyOf:
            - $ref: '#/components/schemas/Error'
            - type: 'null'
        message:
          anyOf:
            - type: string
            - type: 'null'
        maintenance:
          anyOf:
            - type: object
              required:
                - status
                - result_recovered
                - message
              properties:
                status:
                  type: string
                  enum:
                    - repairing
                    - repaired
                    - incomplete
                result_recovered:
                  type: boolean
                message:
                  type: string
              additionalProperties: false
            - type: 'null'
        build:
          anyOf:
            - $ref: '#/components/schemas/JobBuild'
            - type: 'null'
        watch_url:
          type: string
        tip:
          type: string
        created_at:
          $ref: '#/components/schemas/Date'
        updated_at:
          $ref: '#/components/schemas/Date'
        completed_at:
          anyOf:
            - $ref: '#/components/schemas/Date'
            - type: 'null'
      additionalProperties: false
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - docs_url
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
            docs_url:
              type: string
            details:
              type: object
              required: []
              properties: {}
              additionalProperties:
                $id: /schemas/unknown
          additionalProperties: false
      additionalProperties: false
    job_id:
      type: string
      description: 'a job ID: job_ and 32 lowercase hex digits'
      examples:
        - job_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
    InputRequest:
      type: object
      required:
        - id
        - expires_at
        - answer_url
        - message
        - questions
      properties:
        id:
          type: string
          description: 'An input request ID: req_ and 32 lowercase hex digits'
          examples:
            - req_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
          pattern: ^req_[0-9a-f]{32}$
        expires_at:
          type: string
        answer_url:
          type: string
        message:
          type: string
        questions:
          type: array
          items:
            $ref: '#/components/schemas/Question'
      additionalProperties: false
    Date:
      type: string
      description: a string to be decoded into a Date
    JobBuild:
      type: object
      required:
        - integration_id
        - stage
        - stages
        - eta
        - example_result
        - existing_tool_id
      properties:
        integration_id:
          anyOf:
            - $ref: '#/components/schemas/integration_id'
            - type: 'null'
        stage:
          type: string
          enum:
            - queued
            - checking_login
            - exploring
            - building
            - publishing
        stages:
          type: array
          items:
            type: object
            required:
              - key
              - label
              - status
              - started_at
              - completed_at
            properties:
              key:
                type: string
                enum:
                  - queued
                  - checking_login
                  - exploring
                  - building
                  - publishing
              label:
                type: string
              status:
                type: string
                enum:
                  - done
                  - active
                  - pending
              started_at:
                anyOf:
                  - type: string
                  - type: 'null'
              completed_at:
                anyOf:
                  - type: string
                  - type: 'null'
            additionalProperties: false
        eta:
          anyOf:
            - type: object
              required:
                - min_seconds
                - max_seconds
              properties:
                min_seconds:
                  type: number
                max_seconds:
                  type: number
              additionalProperties: false
            - type: 'null'
        example_result:
          $id: /schemas/unknown
        existing_tool_id:
          anyOf:
            - type: string
            - type: 'null'
      additionalProperties: false
    Question:
      anyOf:
        - type: object
          required:
            - id
            - prompt
            - type
            - options
            - allow_other
            - allow_note
          properties:
            id:
              type: string
            prompt:
              type: string
            type:
              type: string
              enum:
                - choice
            options:
              type: array
              items:
                type: object
                required:
                  - id
                  - label
                properties:
                  id:
                    type: string
                  label:
                    type: string
                additionalProperties: false
            allow_other:
              type: boolean
            allow_note:
              type: boolean
          additionalProperties: false
        - type: object
          required:
            - id
            - prompt
            - type
            - options
            - min_selections
            - max_selections
            - allow_other
            - allow_note
          properties:
            id:
              type: string
            prompt:
              type: string
            type:
              type: string
              enum:
                - multi_choice
            options:
              type: array
              items:
                type: object
                required:
                  - id
                  - label
                properties:
                  id:
                    type: string
                  label:
                    type: string
                additionalProperties: false
            min_selections:
              $ref: '#/components/schemas/Int'
            max_selections:
              $ref: '#/components/schemas/Int'
            allow_other:
              type: boolean
            allow_note:
              type: boolean
          additionalProperties: false
        - type: object
          required:
            - id
            - prompt
            - type
            - max_length
          properties:
            id:
              type: string
            prompt:
              type: string
            type:
              type: string
              enum:
                - text
            max_length:
              anyOf:
                - $ref: '#/components/schemas/Int'
                - type: 'null'
          additionalProperties: false
        - type: object
          required:
            - id
            - prompt
            - type
            - follow_up
          properties:
            id:
              type: string
            prompt:
              type: string
            type:
              type: string
              enum:
                - confirm
            follow_up:
              anyOf:
                - type: object
                  required:
                    - prompt
                  properties:
                    prompt:
                      type: string
                  additionalProperties: false
                - type: 'null'
          additionalProperties: false
        - type: object
          required:
            - id
            - prompt
            - type
            - kind
          properties:
            id:
              type: string
            prompt:
              type: string
            type:
              type: string
              enum:
                - secret
            kind:
              type: string
              enum:
                - one_time_code
                - authenticator_code
                - private_text
          additionalProperties: false
        - type: object
          required:
            - id
            - prompt
            - type
            - site_url
            - fields
            - reason
            - username_masked
            - can_save
          properties:
            id:
              type: string
            prompt:
              type: string
            type:
              type: string
              enum:
                - login
            site_url:
              type: string
            fields:
              type: array
              items:
                type: string
                enum:
                  - username
                  - password
            reason:
              type: string
              enum:
                - missing
                - rejected
                - expired
            username_masked:
              anyOf:
                - type: string
                - type: 'null'
            can_save:
              type: boolean
          additionalProperties: false
    integration_id:
      type: string
      description: 'an integration ID: int_ and 32 lowercase hex digits'
      examples:
        - int_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190
    Int:
      type: integer
      description: an integer
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

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