> ## Documentation Index > Fetch the complete documentation index at: https://docs.rainbrand.com/llms.txt > Use this file to discover all available pages before exploring further. # Inspect a Brand Skill > Retrieve the complete active Brand Skill as an immutable snapshot of the brand's profile, guidance, and assets. See [Use a Brand Skill](/guides/use-brand-skill). ## OpenAPI ````yaml https://www.rainbrand.com/api/v1/spec.json get /brands/{id}/skill openapi: 3.1.1 info: title: Rainbrand API version: 1.0.0 servers: - url: https://www.rainbrand.com/api/v1 security: - apiKey: [] - bearer: [] tags: - name: Uploads description: >- Stage private local files for brand sources, the Library, and other supported operations. - name: Account description: >- Inspect the authenticated account — profile, credit balance, and accessible workspaces. - name: Brands description: Manage brands and brand identity. - name: Library description: Add, list, and remove a brand's images, video, and audio. - name: Images description: Retrieve and manage images. - name: Videos description: Retrieve and manage video files. - name: Audio description: Retrieve and manage audio files. - name: Briefs description: Get brand guidance and selected assets for a specific task. - name: Models description: Find available models and check their inputs. - name: Generations description: Create and retrieve model generations. - name: Reviews description: >- Check an asset against a brand's color, typography, logo, and copy guidance. paths: /brands/{id}/skill: get: tags: - Brands summary: Inspect a Brand Skill description: >- Retrieve the complete active Brand Skill as an immutable snapshot of the brand's profile, guidance, and assets. See [Use a Brand Skill](/guides/use-brand-skill). operationId: brands.inspect parameters: - name: id in: path required: true schema: type: string format: uuid description: Brand ID responses: '200': description: OK content: application/json: schema: type: object properties: data: type: object properties: schemaVersion: const: 7 description: Response schema version id: type: string format: uuid description: Brand ID skillId: type: string format: uuid description: >- Canonical identity of this complete immutable Brand Skill; use it for caching and versioning basedOnSkillId: anyOf: - type: string format: uuid - type: 'null' description: >- Base Skill ID this Skill was derived from, when available createdAt: type: string format: date-time x-native-type: date description: Time this immutable Skill was created profile: anyOf: - type: object properties: name: anyOf: - type: string - type: 'null' primaryLogo: anyOf: - type: object properties: assetId: {} additionalProperties: false - type: 'null' colors: anyOf: - type: array minItems: 1 items: type: object properties: hex: type: string pattern: ^#[0-9A-Fa-f]{6}$ description: >- Six-digit HEX color value, including the leading #. name: type: string minLength: 1 maxLength: 80 description: >- The color's name, when established by the source. group: type: string minLength: 1 maxLength: 80 description: >- The source's palette group label. Omit when the source does not group this color. usage: type: string minLength: 1 maxLength: 500 description: >- Source-supported guidance on when and how to use this color. required: - hex additionalProperties: false - type: 'null' gradients: type: array items: type: object properties: name: type: string minLength: 1 maxLength: 80 description: >- The gradient's name, as established by the source. angle: type: number minimum: 0 exclusiveMaximum: 360 description: >- The linear gradient's angle in degrees, from 0 up to but not including 360. stops: type: array minItems: 2 items: type: object properties: hex: type: string pattern: ^#[0-9A-Fa-f]{6}$ description: >- Six-digit HEX color value for this stop, including the leading #. position: type: number minimum: 0 maximum: 100 description: >- The stop's position as a percentage from 0 to 100. required: - hex - position additionalProperties: false description: >- At least two color stops in non-decreasing position order. Adjacent stops may share a position to create a hard transition. usage: type: string minLength: 1 maxLength: 500 description: >- Source-supported guidance on when and how to use this gradient. required: - name - angle - stops additionalProperties: false description: >- The Brand's evidenced linear gradients in source order, including exact angles, stops, and usage guidance. typography: type: object properties: heading: anyOf: - anyOf: - type: object properties: family: type: string minLength: 1 status: const: unavailable reason: type: string minLength: 1 files: type: array maxItems: 0 items: not: {} required: - family - status - reason - files additionalProperties: false - type: object properties: source: const: google family: type: string minLength: 1 maxLength: 120 weight: type: integer minimum: 1 maximum: 1000 description: >- The weight to use from this Google Fonts family, such as 400 for regular or 700 for bold. specimen: type: object properties: url: type: string format: uri description: >- A temporary signed URL for downloading the font specimen PNG. mediaType: const: image/png description: The media type of the font specimen. required: - url - mediaType description: >- A font specimen: a PNG rendered from this Google Fonts family at the specified weight. required: - source - family additionalProperties: false - type: object properties: source: const: custom family: type: string minLength: 1 maxLength: 120 files: type: array minItems: 1 items: type: object properties: url: type: string format: uri description: >- Temporary signed font URL; retrieve the Brand Skill again if the URL expires mediaType: type: string byteLength: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 sha256: type: string pattern: ^[a-f0-9]{64}$ format: enum: - ttf - otf - woff - woff2 type: string weight: type: integer minimum: 1 maximum: 1000 variable: type: boolean primary: type: boolean specimen: type: object properties: url: type: string format: uri description: >- A temporary signed URL for downloading the font specimen PNG. mediaType: const: image/png description: The media type of the font specimen. required: - url - mediaType description: >- A font specimen: a PNG rendered from this exact font file at the specified weight. required: - url - mediaType - byteLength - sha256 - format - weight - variable - primary required: - source - family - files additionalProperties: false - type: 'null' description: >- Deprecated. Font of the role named Heading, if any. body: anyOf: - anyOf: - type: object properties: family: type: string minLength: 1 status: const: unavailable reason: type: string minLength: 1 files: type: array maxItems: 0 items: not: {} required: - family - status - reason - files additionalProperties: false - type: object properties: source: const: google family: type: string minLength: 1 maxLength: 120 weight: type: integer minimum: 1 maximum: 1000 description: >- The weight to use from this Google Fonts family, such as 400 for regular or 700 for bold. specimen: type: object properties: url: type: string format: uri description: >- A temporary signed URL for downloading the font specimen PNG. mediaType: const: image/png description: The media type of the font specimen. required: - url - mediaType description: >- A font specimen: a PNG rendered from this Google Fonts family at the specified weight. required: - source - family additionalProperties: false - type: object properties: source: const: custom family: type: string minLength: 1 maxLength: 120 files: type: array minItems: 1 items: type: object properties: url: type: string format: uri description: >- Temporary signed font URL; retrieve the Brand Skill again if the URL expires mediaType: type: string byteLength: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 sha256: type: string pattern: ^[a-f0-9]{64}$ format: enum: - ttf - otf - woff - woff2 type: string weight: type: integer minimum: 1 maximum: 1000 variable: type: boolean primary: type: boolean specimen: type: object properties: url: type: string format: uri description: >- A temporary signed URL for downloading the font specimen PNG. mediaType: const: image/png description: The media type of the font specimen. required: - url - mediaType description: >- A font specimen: a PNG rendered from this exact font file at the specified weight. required: - url - mediaType - byteLength - sha256 - format - weight - variable - primary required: - source - family - files additionalProperties: false - type: 'null' description: >- Deprecated. Font of the role named Body, if any. roles: type: array items: type: object properties: name: type: string description: >- The brand's name for this typography role, such as Eyebrow. weight: anyOf: - type: integer minimum: 1 maximum: 1000 - type: 'null' description: >- Font weight for this role, or null when unspecified. font: anyOf: - type: object properties: family: type: string minLength: 1 status: const: unavailable reason: type: string minLength: 1 files: type: array maxItems: 0 items: not: {} required: - family - status - reason - files additionalProperties: false - type: object properties: source: const: google family: type: string minLength: 1 maxLength: 120 weight: type: integer minimum: 1 maximum: 1000 description: >- The weight to use from this Google Fonts family, such as 400 for regular or 700 for bold. specimen: type: object properties: url: type: string format: uri description: >- A temporary signed URL for downloading the font specimen PNG. mediaType: const: image/png description: The media type of the font specimen. required: - url - mediaType description: >- A font specimen: a PNG rendered from this Google Fonts family at the specified weight. required: - source - family additionalProperties: false - type: object properties: source: const: custom family: type: string minLength: 1 maxLength: 120 files: type: array minItems: 1 items: type: object properties: url: type: string format: uri description: >- Temporary signed font URL; retrieve the Brand Skill again if the URL expires mediaType: type: string byteLength: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 sha256: type: string pattern: ^[a-f0-9]{64}$ format: enum: - ttf - otf - woff - woff2 type: string weight: type: integer minimum: 1 maximum: 1000 variable: type: boolean primary: type: boolean specimen: type: object properties: url: {} mediaType: {} description: >- A font specimen: a PNG rendered from this exact font file at the specified weight. required: - url - mediaType - byteLength - sha256 - format - weight - variable - primary required: - source - family - files additionalProperties: false required: - name - weight - font description: >- The brand's typography roles, most prominent first. required: - heading - body - roles logoCatalog: anyOf: - type: object properties: primaryLogoImageId: anyOf: - type: string format: uuid - type: 'null' items: type: array items: type: object properties: imageId: type: string format: uuid form: enum: - icon - wordmark - lockup type: string contrastsBestOn: anyOf: - type: array items: enum: - light - dark type: string - type: 'null' description: >- Backgrounds that independently pass the visibility check for a transparent logo. An empty array means neither passes. Null means analysis was unavailable for a transparent asset or does not apply to an opaque asset. This heuristic does not establish Brand approval. asset: type: object properties: path: type: string mediaType: type: string byteLength: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 sha256: type: string pattern: ^[a-f0-9]{64}$ width: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 height: type: integer minimum: -9007199254740991 maximum: 9007199254740991 exclusiveMinimum: 0 aspectRatio: type: number exclusiveMinimum: 0 hasTransparency: type: boolean url: type: string format: uri description: >- Temporary signed URL for the logo bytes saved with this Brand Skill version. Read the version again to refresh an expired URL. required: - path - mediaType - byteLength - sha256 - width - height - aspectRatio - hasTransparency - url required: - imageId - form - contrastsBestOn - asset required: - primaryLogoImageId - items - type: 'null' description: >- Supported logos saved with this Brand Skill version. Null means no catalog was published; an empty items array explicitly records no supported logos. Asset URLs are temporary. Follow exact caller selection and relevant Brand Skill guidance before visibility hints, with the primary logo as a general fallback. required: - name - primaryLogo - gradients - typography - logoCatalog additionalProperties: false - type: 'null' description: >- Structured brand profile, including temporary signed URLs for custom font files files: type: array items: anyOf: - type: object properties: path: type: string description: Skill-relative Markdown file path mediaType: const: text/markdown kind: const: text byteLength: type: integer minimum: 0 maximum: 9007199254740991 description: The size of the Markdown file in bytes. content: type: string description: Complete Markdown file contents libraryAssetIds: type: array items: type: string format: uuid description: >- Brand Library asset IDs referenced by this file required: - path - mediaType - kind - byteLength - content - libraryAssetIds additionalProperties: false - type: object properties: path: type: string description: >- Skill-relative image, font, or other file path mediaType: type: string kind: enum: - image - font - other type: string byteLength: type: integer minimum: 0 maximum: 9007199254740991 description: >- The size of the file in bytes. Omitted for font specimens. description: type: string description: >- What an image or font specimen shows, when recorded. url: type: string format: uri description: >- Temporary signed download URL; retrieve the Skill again if the URL expires required: - path - mediaType - kind - url additionalProperties: false description: >- Every file in this Skill: Markdown files in order with their contents, then images, fonts, and font specimens with download URLs required: - schemaVersion - id - skillId - basedOnSkillId - createdAt - profile - files required: - data '401': description: '401' content: application/json: schema: $ref: '#/components/schemas/BrandsInspect401ErrorResponse' '403': description: '403' content: application/json: schema: $ref: '#/components/schemas/BrandsInspect403ErrorResponse' '404': description: '404' content: application/json: schema: $ref: '#/components/schemas/BrandsInspect404ErrorResponse' '409': description: '409' content: application/json: schema: $ref: '#/components/schemas/BrandsInspect409ErrorResponse' '429': description: '429' content: application/json: schema: $ref: '#/components/schemas/BrandsInspect429ErrorResponse' headers: Retry-After: description: >- Seconds until the applicable request or operation limit resets. Present when the limiter can calculate the delay. schema: type: integer minimum: 0 '500': description: '500' content: application/json: schema: $ref: '#/components/schemas/BrandsInspect500ErrorResponse' components: schemas: BrandsInspect401ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: UNAUTHORIZED status: const: 401 message: type: string default: Invalid or missing API credentials data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsInspect403ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: ACCOUNT_BANNED status: const: 403 message: type: string default: This account has been suspended. data: {} required: - code - status - message - type: object properties: code: const: FORBIDDEN status: const: 403 message: type: string default: Plan upgrade required data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsInspect404ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: BRAND_NOT_FOUND status: const: 404 message: type: string default: Brand not found data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsInspect409ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: BRAND_SKILL_UNAVAILABLE status: const: 409 message: type: string default: Brand has no inspectable Skill data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsInspect429ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: TOO_MANY_REQUESTS status: const: 429 message: type: string default: Rate limit exceeded data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error BrandsInspect500ErrorResponse: type: object properties: error: allOf: - $ref: '#/components/schemas/ApiError' - anyOf: - type: object properties: code: const: INTERNAL_ERROR status: const: 500 message: type: string default: Failed to inspect Brand data: {} required: - code - status - message - type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message required: - error ApiError: type: object properties: code: type: string status: type: integer message: type: string data: {} required: - code - status - message securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: 'Rainbrand API key, for example `x-api-key: bloom_sk_...`.' bearer: type: http scheme: bearer description: >- Rainbrand API key (`Bearer bloom_sk_...`) or Rainbrand OAuth access token. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.