> ## Documentation Index > Fetch the complete documentation index at: https://docs.yalg.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a component > Update component metadata (name, description, tags, etc.) ## OpenAPI ````yaml https://api.yalg.ai/openapi.v1-3.1.json patch /v1/components/{id} openapi: 3.1.0 info: title: YALG Developer API description: >- Public v1 API for integrating with YALG content workflows. Authenticate server-side requests with the `x-api-key` header. Every request is scoped to the API key owner. version: '1.0' contact: name: YALG Support url: https://yalg.ai email: support@yalg.ai termsOfService: https://yalg.ai/terms license: name: Proprietary url: https://yalg.ai servers: - url: https://api.yalg.ai description: Production security: [] tags: - name: public-v1 description: Stable public developer API - name: anecdotes description: Public anecdote endpoints - name: posts description: Public post endpoints - name: post-generation description: Public post generation endpoints - name: script-jobs description: Public script job endpoints - name: shorts description: Public short-form video endpoints - name: carousel description: Public carousel endpoints - name: carousel-generation description: Public carousel generation endpoints - name: broll description: Public B-roll generation endpoints - name: components description: Public component library endpoints - name: Blog description: Public blog endpoints - name: youtube-suggestions description: Public YouTube suggestion endpoints - name: statistics description: Public statistics endpoints paths: /v1/components/{id}: patch: tags: - components summary: Update a component description: Update component metadata (name, description, tags, etc.) operationId: ComponentLibraryController_update[1] parameters: - name: id required: true in: path description: Component UUID schema: type: string example: 018f9f40-7d7b-7712-9b0f-2e5d9fd5df3f requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateComponentDto' examples: default: summary: Example request value: name: Metric comparison card prompt: Create a clean animated metric card for a 9:16 video. category: metric responses: '200': description: Component updated successfully headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 content: application/json: schema: $ref: '#/components/schemas/YalgGeneratedComponent' examples: success: summary: Example response value: id: 018f9f51-4b89-778f-9c0b-fd4626f47326 name: Metric comparison card category: metric isPublic: false isValidated: true createdAt: '2026-06-20T17:24:39.000Z' updatedAt: '2026-06-20T17:24:39.000Z' '400': description: >- Bad request. The request body, query string, path parameter, or uploaded file is invalid. content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: validation_failed: summary: Bad Request value: statusCode: 400 message: Validation failed error: Bad Request code: validation_failed headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 '401': description: >- Authentication failed. Provide a valid `x-api-key` header for public API requests. content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: unauthorized: summary: Unauthorized value: statusCode: 401 message: Invalid or missing API key error: Unauthorized code: unauthorized headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 '403': description: >- Forbidden. The authenticated owner does not have access to this feature or resource. content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: forbidden: summary: Forbidden value: statusCode: 403 message: Access denied error: Forbidden code: forbidden headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 '404': description: Component not found content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: not_found: summary: Not Found value: statusCode: 404 message: Resource not found error: Not Found code: not_found headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 '409': description: >- Conflict. The request cannot be completed because the resource is already in another state. content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: conflict: summary: Conflict value: statusCode: 409 message: Resource conflict error: Conflict code: conflict headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 '429': description: >- Rate limit exceeded. Wait for the window to reset before retrying the request. content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: rate_limit_exceeded: summary: Too Many Requests value: statusCode: 429 message: Rate limit exceeded error: Too Many Requests code: rate_limit_exceeded retryAfter: 60 headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 Retry-After: description: Seconds to wait before retrying the request. schema: type: integer example: 60 '500': description: Internal server error. An unexpected YALG backend error occurred. content: application/json: schema: $ref: '#/components/schemas/YalgErrorResponse' examples: internal_server_error: summary: Internal Server Error value: statusCode: 500 message: Internal server error error: Internal Server Error code: internal_server_error headers: X-RateLimit-Limit: description: Maximum number of API requests allowed in the current window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Number of API requests remaining in the current window. schema: type: integer example: 119 X-RateLimit-Reset: description: >- Unix timestamp, in seconds, when the current rate limit window resets. schema: type: integer example: 1766246400 security: - ApiKeyAuth: [] - bearer: [] components: schemas: UpdateComponentDto: type: object properties: name: type: string maxLength: 200 description: Name for the component description: type: string maxLength: 1000 description: Description of the component category: enum: - text - stat - transition - cta - custom type: string description: Category for the component tags: description: Tags for searchability type: array items: type: string defaultProps: type: object description: Default props for the component isPublic: type: boolean description: Whether the component should be public YalgGeneratedComponent: type: object description: Generated visual component. properties: id: type: string format: uuid description: Component identifier. example: 018f9f40-7d7b-7712-9b0f-2e5d9fd5df3f name: type: string example: Metric counter category: type: string example: chart code: type: string description: Generated component source code. isPublic: type: boolean example: false isValidated: type: boolean example: true createdAt: type: string format: date-time example: '2026-06-20T17:24:39.000Z' updatedAt: type: string format: date-time example: '2026-06-20T17:24:39.000Z' additionalProperties: true YalgErrorResponse: type: object required: - statusCode - message description: >- Standard error payload returned by YALG API endpoints. Validation errors may return `message` as an array of field-level messages. properties: statusCode: type: integer example: 400 message: oneOf: - type: string example: Bad request - type: array items: type: string example: - field must be a string error: type: string example: Bad Request code: type: string example: validation_failed description: Stable machine-readable error code when the backend can provide one. requestId: type: string example: req_01HX7Y6D3XQ4J8W9Z0A1B2C3D4 description: >- Request correlation identifier. Include this when contacting YALG support. retryAfter: type: integer example: 60 description: >- Seconds to wait before retrying. Present on some rate-limit responses. details: type: object additionalProperties: true description: Optional structured details for validation or domain errors. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- YALG Developer API key. Send it in the `x-api-key` header from a server-side environment only. x-default: yalg_live_your_api_key bearer: scheme: bearer bearerFormat: JWT type: http ````