> ## Documentation Index > Fetch the complete documentation index at: https://docs.artbucket.io/llms.txt > Use this file to discover all available pages before exploring further. # What an asset is and may be used for > Title, credit, tags, effective field values, rights, provenance, what supersedes it, its URLs, the transforms it allows and ready-made rendition URLs. Whether a particular use is allowed: POST /api/v1/check. Scope: `read`. ## OpenAPI ````yaml /openapi.json get /api/v1/assets/{id}/description openapi: 3.1.0 info: title: artbucket version: '1' description: >- Agent-first asset management. The web UI is built on this API and nothing else, beside signing in at /api/auth. Send `Authorization: Bearer `: a key works in one workspace with one scope, and scopes are a ladder: read < propose < write < admin. People signed in to the app carry a session cookie instead, and their scope is what their grants add up to: on the organization, the workspace, or single collections and assets. A scope shown as needed on the workspace is also enough on the one collection or asset a route acts on. Agents (MCP at POST /api/v1/mcp) usually get `propose`: what they add waits for a human. servers: - url: http://localhost:3000 security: - bearer: [] - session: [] - {} paths: /api/v1/assets/{id}/description: parameters: - name: id in: path required: true description: Asset id schema: type: string get: summary: What an asset is and may be used for description: >- Title, credit, tags, effective field values, rights, provenance, what supersedes it, its URLs, the transforms it allows and ready-made rendition URLs. Whether a particular use is allowed: POST /api/v1/check. Scope: `read`. responses: '200': description: The description content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ filename: type: string mime: type: string size: type: integer minimum: -9007199254740991 maximum: 9007199254740991 width: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' height: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' sha256: type: string status: type: string enum: - draft - proposed - active - archived - rejected state: type: string enum: - draft - proposed - active - expired - archived - rejected - deleted description: >- Only active is served at /a/{id} to anyone; expired and archived answer 410 version: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: Its number in its stack of versions; null when it has one current: type: boolean description: >- The version to use: its stack's current one, or the only one proposedBy: type: - string - 'null' reviewNote: type: - string - 'null' title: type: - string - 'null' description: type: - string - 'null' creator: type: - string - 'null' copyright: type: - string - 'null' tags: type: array items: type: string fields: type: object propertyNames: type: string additionalProperties: type: - string - number - boolean description: 'Effective values: own over inherited' collections: type: array items: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ rights: anyOf: - type: object properties: license: type: - string - 'null' territories: type: array items: type: string description: 'ISO 3166-1 alpha-2; empty: anywhere' channels: type: array items: type: string description: 'empty: any use' embargo: anyOf: - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - type: 'null' description: Not before this day expires: anyOf: - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ - type: 'null' description: The last day it may be used modelRelease: anyOf: - type: string enum: - released - missing - not-needed - type: 'null' required: - license - territories - channels - embargo - expires - modelRelease additionalProperties: false - type: 'null' provenance: type: object properties: origin: anyOf: - type: string enum: - shot - licensed - generated - type: 'null' parentAssetId: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' generator: type: - string - 'null' prompt: type: - string - 'null' c2pa: anyOf: - type: object properties: manifests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 generator: description: The app that signed it type: - string - 'null' title: type: - string - 'null' signedBy: description: >- The signing certificate's organization, as the file claims it; not verified type: - string - 'null' actions: type: array items: type: string digitalSourceType: description: >- IPTC: digitalCapture, trainedAlgorithmicMedia... type: - string - 'null' softwareAgent: description: The tool the actions name, often the model type: - string - 'null' ingredients: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - manifests - generator - title - signedBy - actions - digitalSourceType - softwareAgent - ingredients additionalProperties: false - type: 'null' description: >- Content Credentials read from the file; the original keeps the signed manifest required: - origin - parentAssetId - generator - prompt - c2pa additionalProperties: false supersededBy: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' description: 'Replaced: use this one instead' urls: type: object properties: original: type: string format: uri download: type: string format: uri description: The original with current metadata written in rendition: description: 'Template: replace {transform}, e.g. w_800,f_webp' type: - string - 'null' required: - original - download - rendition additionalProperties: false constraints: anyOf: - type: object properties: w: type: array prefixItems: - type: number - type: number items: false minItems: 2 maxItems: 2 h: type: array prefixItems: - type: number - type: number items: false minItems: 2 maxItems: 2 q: type: array prefixItems: - type: number - type: number items: false minItems: 2 maxItems: 2 fit: type: array items: type: string enum: - cover - contain - inside - outside - fill f: type: array items: type: string enum: - jpeg - png - webp - avif enlarges: type: boolean const: false required: - w - h - q - fit - f - enlarges additionalProperties: false - type: 'null' description: >- What a rendition of this asset may ask for; null when it can't be transformed alternatives: type: array items: type: object properties: name: type: string url: type: string format: uri required: - name - url additionalProperties: false description: Ready-made renditions required: - id - filename - mime - size - width - height - sha256 - status - state - version - current - proposedBy - reviewNote - title - description - creator - copyright - tags - fields - collections - rights - provenance - supersededBy - urls - constraints - alternatives additionalProperties: false default: description: An error content: application/json: schema: type: object properties: error: type: object properties: code: type: string message: type: string detail: {} required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: bearer: type: http scheme: bearer description: 'An API key: ab_...' session: type: apiKey in: cookie name: better-auth.session_token description: Signed in, at /api/auth ````