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

# Create a brand

> Create a brand from a website. The name, description and logo are enriched automatically in the background. **No prompts are created** — add them with `POST /brands/{id}/prompts`, and note that a brand with no active prompts is never scanned.

Idempotent per account+domain: posting a domain your account already has returns the existing brand unchanged (200, and it does not count against your brand limit).



## OpenAPI

````yaml https://agentled.co/api/v1/openapi.json post /brands
openapi: 3.1.0
info:
  title: agentled API
  version: 1.0.0
  description: >-
    Programmatic access to the agentled AI Search monitor: manage brands and
    prompts, set a brand's measurement location, and read scan results — the
    same data behind the dashboard.


    All requests are authenticated with an API key you mint in the Account tab,
    sent as `Authorization: Bearer agl_live_...`. Every key is scoped to your
    account: you only ever see brands your account belongs to.


    **Base URL:** `https://agentled.co/api/v1`
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: agentled
    url: https://agentled.co
servers:
  - url: https://agentled.co/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Plan
    description: The account's plan and its limits.
  - name: Brands
    description: Brands the account monitors.
  - name: Prompts
    description: The questions asked about a brand each scan.
  - name: Answers
    description: Per-scan answer history for a prompt.
  - name: Metrics
    description: A brand's AI-visibility metrics.
  - name: Scans
    description: Scan runs.
  - name: Geo
    description: Valid country/city values for a brand's location.
paths:
  /brands:
    post:
      tags:
        - Brands
      summary: Create a brand
      description: >-
        Create a brand from a website. The name, description and logo are
        enriched automatically in the background. **No prompts are created** —
        add them with `POST /brands/{id}/prompts`, and note that a brand with no
        active prompts is never scanned.


        Idempotent per account+domain: posting a domain your account already has
        returns the existing brand unchanged (200, and it does not count against
        your brand limit).
      operationId: createBrand
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBrandInput'
      responses:
        '200':
          description: >-
            The account already had this domain; the existing brand is returned
            unchanged.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandEnvelope'
        '201':
          description: A new brand was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrandEnvelope'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          $ref: '#/components/responses/LimitReached'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    CreateBrandInput:
      type: object
      required:
        - website
      properties:
        website:
          type: string
          maxLength: 2048
          description: >-
            The brand's website or domain, e.g. `example.com`. Must be a valid
            domain.
          example: example.com
        about:
          type: string
          maxLength: 5000
          description: Optional context to improve enrichment.
    BrandEnvelope:
      type: object
      required:
        - brand
      properties:
        brand:
          $ref: '#/components/schemas/Brand'
    Brand:
      type: object
      properties:
        id:
          type: string
          format: uuid
        domain:
          type: string
        name:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        logoUrl:
          type:
            - string
            - 'null'
          format: uri
        status:
          type: string
          enum:
            - anonymous
            - active
          description: '`active` once the brand is claimed by an account.'
        isActive:
          type: boolean
        firstScanCompletedAt:
          type:
            - string
            - 'null'
          format: date-time
        lastScanAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        claimedAt:
          type:
            - string
            - 'null'
          format: date-time
        location:
          $ref: '#/components/schemas/Location'
    Error:
      type: object
      description: Every error has this shape. Branch on the stable `error.code`.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Stable machine-readable code.
              enum:
                - unauthorized
                - not_found
                - bad_request
                - limit_reached
                - server_error
            message:
              type: string
              description: Human-readable explanation.
            upgradeUrl:
              type: string
              description: >-
                Present only when `code` is `limit_reached`: where to upgrade
                the plan.
    Location:
      type: object
      description: The market a brand's AI answers are measured from.
      required:
        - mode
        - country
        - city
        - label
      properties:
        mode:
          type: string
          enum:
            - worldwide
            - country
            - city
          description: Scope granularity.
        country:
          type:
            - string
            - 'null'
          description: ISO 3166-1 alpha-2 code, when scoped to a country or city.
        city:
          type:
            - string
            - 'null'
          description: City name, when scoped to a city.
        label:
          type:
            - string
            - 'null'
          description: Human-readable label, e.g. "Austin, United States".
  responses:
    BadRequest:
      description: The request body or a parameter was invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    LimitReached:
      description: A plan limit was reached. The error carries `upgradeUrl`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: Something went wrong. Retry.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the Account tab, sent as `Authorization: Bearer
        agl_live_...`. Keys are secret; store them server-side.

````