Anything Domains API

The Domains API from Anything — 3 operation(s) for domains.

OpenAPI Specification

anything-domains-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Anything Assets Domains API
  version: 0.1.0
  description: The Anything API is the fastest way for agents to build and launch mobile and web apps.
servers:
- url: /
tags:
- name: Domains
paths:
  /v0/api/domains:
    get:
      summary: List organization domains
      description: Returns the apex domains for an organization, including verification status and linked project information.
      tags:
      - Domains
      security:
      - basicAuth: []
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: organizationId
        in: query
      responses:
        '200':
          description: Domains list
          content:
            application/json:
              schema:
                type: object
                properties:
                  domains:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        domain:
                          type: string
                        vercelVerified:
                          type: boolean
                        vercelVerification: {}
                        projectGroup:
                          type:
                          - object
                          - 'null'
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type: string
                          required:
                          - id
                          - name
                      required:
                      - id
                      - domain
                      - vercelVerified
                      - projectGroup
                required:
                - domains
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '404':
          description: Not found — the referenced resource does not exist (including malformed resource IDs)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
    post:
      summary: Add a domain
      description: Adds a custom domain to an organization, optionally linked to a project group.
      tags:
      - Domains
      security:
      - basicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                organizationId:
                  type: string
                  format: uuid
                domain:
                  type: string
                  minLength: 1
                projectGroupId:
                  type:
                  - string
                  - 'null'
                  format: uuid
              required:
              - organizationId
              - domain
      responses:
        '201':
          description: Domain created
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                      domain:
                        type: string
                      vercelVerified:
                        type: boolean
                      vercelVerification: {}
                      projectGroup:
                        type:
                        - object
                        - 'null'
                        properties:
                          id:
                            type: string
                            format: uuid
                          name:
                            type: string
                        required:
                        - id
                        - name
                    required:
                    - id
                    - domain
                    - vercelVerified
                    - projectGroup
                required:
                - domain
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '404':
          description: Not found — the referenced resource does not exist (including malformed resource IDs)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
  /v0/api/domains/{domainId}:
    delete:
      summary: Remove a domain
      description: Removes a custom domain.
      tags:
      - Domains
      security:
      - basicAuth: []
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: domainId
        in: path
      responses:
        '204':
          description: Domain deleted
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '404':
          description: Domain not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
  /v0/api/domains/{domainId}/verify:
    post:
      summary: Verify a domain
      description: Triggers verification for a custom domain.
      tags:
      - Domains
      security:
      - basicAuth: []
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: domainId
        in: path
      responses:
        '200':
          description: Domain verification result
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: string
                  verified:
                    type: boolean
                  vercelVerification: {}
                required:
                - domain
                - verified
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
        '404':
          description: Domain not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  details:
                    type: array
                    items: {}
                  message:
                    type: string
                required:
                - error
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: 'Use your Anything API key as the Basic auth username and leave the password empty. Example credentials: anything_xxx:'