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

# Get Attribute

> Get a single metadata attribute by ID.

System global attributes are readable by any authenticated user.
For share users, hidden attributes (configured in share settings) return 404.



## OpenAPI

````yaml /api-reference/openapi.json get /metadata/attributes/{attribute_id}
openapi: 3.1.0
info:
  title: Aspect API
  description: Manage and search media in Aspect.
  version: 1.0.0
servers:
  - url: https://api.aspect.inc
security:
  - ApiKeyAuth: []
tags:
  - name: Users
  - name: API Keys
  - name: Workspaces
  - name: Projects
  - name: Directories
  - name: Assets
  - name: Attachments
  - name: Filesystem Items
  - name: Jobs
  - name: Collections
  - name: Comments
  - name: Search
  - name: Transcription
  - name: Metadata
  - name: Shares
  - name: Share Templates
  - name: Watermarks
paths:
  /metadata/attributes/{attribute_id}:
    get:
      tags:
        - Metadata
      summary: Get Attribute
      description: >-
        Get a single metadata attribute by ID.


        System global attributes are readable by any authenticated user.

        For share users, hidden attributes (configured in share settings) return
        404.
      operationId: get_attribute
      parameters:
        - name: attribute_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Attribute ID
            title: Attribute Id
          description: Attribute ID
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataAttributeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MetadataAttributeResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier for this attribute
        project_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Project Id
          description: Project ID for project-specific attributes, null for system global
        name:
          type: string
          title: Name
          description: Human-readable display name
        data_type:
          $ref: '#/components/schemas/MetadataDataType'
          description: Type of value this attribute holds
        options:
          anyOf:
            - items:
                $ref: '#/components/schemas/SelectOption'
              type: array
            - type: 'null'
          title: Options
          description: Available options for select types
        source:
          $ref: '#/components/schemas/MetadataSource'
          description: Whether attribute is system-defined or user-created
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
          description: Grouping category for UI display
        asset_column:
          anyOf:
            - type: string
            - type: 'null'
          title: Asset Column
          description: 'For ASSET source: the asset property this attribute maps to'
        is_filterable:
          type: boolean
          title: Is Filterable
          description: Whether this attribute can be used in filters
        is_displayable:
          type: boolean
          title: Is Displayable
          description: Whether this attribute can be shown in generic metadata display UI
        is_editable:
          type: boolean
          title: Is Editable
          description: >-
            Whether values for this attribute can be edited through metadata
            APIs
        is_sortable:
          type: boolean
          title: Is Sortable
          description: Whether assets can be sorted by this attribute
        generation_config:
          anyOf:
            - $ref: '#/components/schemas/MetadataGenerationConfig'
            - type: 'null'
          description: AI generation settings; null when generation is off
        created_by_user_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Created By User Id
          description: >-
            User who created the attribute; null for system attributes and ones
            created before creators were recorded
        created:
          type: string
          format: date-time
          title: Created
          description: When the attribute was created
        updated:
          type: string
          format: date-time
          title: Updated
          description: When the attribute was last updated
      type: object
      required:
        - id
        - name
        - data_type
        - source
        - is_filterable
        - is_displayable
        - is_editable
        - is_sortable
        - created
        - updated
      title: MetadataAttributeResponse
      description: API response schema for metadata attribute.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MetadataDataType:
      type: string
      enum:
        - string
        - integer
        - float
        - boolean
        - datetime
        - single_select
        - multi_select
        - user_id
        - person_id
        - object_id
        - directory_id
      title: MetadataDataType
      description: Data types for metadata attribute values.
    SelectOption:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        label:
          type: string
          title: Label
        color:
          anyOf:
            - type: string
            - type: 'null'
          title: Color
          description: >-
            UI color name. Supported values: red, orange, yellow, green, teal,
            blue, indigo, purple, pink, brown
        archived:
          type: boolean
          title: Archived
          default: false
      type: object
      required:
        - label
      title: SelectOption
      description: Option for single_select/multi_select types.
    MetadataSource:
      type: string
      enum:
        - system
        - user
        - asset
      title: MetadataSource
      description: Source of metadata attribute or value.
    MetadataGenerationConfig:
      properties:
        prompt:
          type: string
          maxLength: 8000
          title: Prompt
          description: >-
            Prompt template; variables like {{transcript}} must match
            input_sources
        input_sources:
          items:
            $ref: '#/components/schemas/GenerationInputSource'
          type: array
          minItems: 1
          title: Input Sources
          description: Inputs the AI reads when generating a value
        watch:
          anyOf:
            - $ref: '#/components/schemas/Watch'
            - type: 'null'
          description: >-
            Watch folders: directories whose new assets are generated
            automatically as they finish processing, and what a `watch` run
            covers. Null means not watching: nothing runs by itself, and a
            `watch` run is rejected — run on `directories` or `assets` instead
      type: object
      required:
        - prompt
        - input_sources
      title: MetadataGenerationConfig
      description: Settings for generating an attribute's values with AI.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    GenerationInputSource:
      type: string
      enum:
        - transcript
        - visual
      title: GenerationInputSource
      description: An input the AI reads when generating a value.
    Watch:
      properties:
        resource_ids:
          items:
            type: string
            format: uuid
          type: array
          minItems: 1
          title: Resource Ids
          description: >-
            Directories whose assets are watched. Use the project's
            root_directory_id for the whole project
        asset_types:
          anyOf:
            - items:
                $ref: '#/components/schemas/AssetType'
              type: array
            - type: 'null'
          title: Asset Types
          description: Limit to these asset types; null means every compatible type
      type: object
      required:
        - resource_ids
      title: Watch
      description: >-
        What an attribute or object watches: directory subtrees plus an optional

        asset-type limit. A watch is where the column runs on its own — new
        assets

        landing inside it are run as they finish processing — and what a

        watch run covers; a folder or asset run looks where it is told

        instead. Ids are always concrete directories of the project (at least
        one;

        whole project = root directory; trash is never allowed); deleted ids
        simply

        stop matching.
    AssetType:
      type: string
      enum:
        - video
        - image
        - audio
        - document
        - vector
        - other
      title: AssetType
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

````

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