> ## Documentation Index > Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # Register asset ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/assets openapi: 3.0.3 info: title: SegmentFlow.ai API description: Unified SegmentFlow.ai API documentation version: 1.0.0 servers: - url: http://localhost:3001 description: Local development - url: https://api-staging.segmentflow.ai description: Staging - url: https://api.segmentflow.ai description: Production security: - apiKeyAuth: [] tags: - name: Profiles description: Profiles (Contacts) - name: Events description: Server-side business event tracking - name: Assets description: Assets - name: BackgroundJobs description: Background job progress - name: Brand-Kit description: Brand kits - name: Catalog-Products description: Catalog products - name: Templates description: Templates - name: Broadcasts description: Broadcasts - name: Segments description: Segments - name: Journeys description: Journeys - name: Emails description: Email sends paths: /api/v1/assets: post: tags: - Assets summary: Register asset operationId: Assets_Assets_Create requestBody: content: application/json: schema: type: object properties: assetType: default: content-image type: string enum: - content-image - content-document - lead-magnet filename: type: string minLength: 1 s3Key: type: string minLength: 1 contentType: type: string minLength: 1 size: type: number imageType: type: string enum: - logo - hero - header - product - background - icon - other description: Category of image for use in email templates websiteId: 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)$ required: - filename - s3Key - contentType - size required: true responses: '200': description: Default Response content: application/json: schema: type: object properties: success: type: boolean asset: type: object properties: id: type: string assetType: type: string filename: type: string contentType: type: string size: type: number url: type: string createdAt: type: string updatedAt: type: string description: type: string nullable: true altText: type: string nullable: true tags: type: array items: type: string imageType: nullable: true type: string enum: - logo - hero - header - product - background - icon - other description: Category of image for use in email templates width: type: number nullable: true height: type: number nullable: true source: type: string enum: - custom - brand_kit - product - ai_chat - external description: >- Origin of the asset (user upload, brand extraction, product sync, or AI chat). sourceProvider: type: string nullable: true sourceProviderId: type: string nullable: true sourceUrl: type: string nullable: true licenseName: type: string nullable: true licenseUrl: type: string nullable: true attributionText: type: string nullable: true enrichmentReview: type: object properties: assetId: 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)$ pendingSuggestionCount: type: integer minimum: 0 maximum: 9007199254740991 status: nullable: true type: string enum: - pending_review - partially_reviewed - completed - rejected - expired - failed reviewRunId: 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)$ nullable: true required: - assetId - pendingSuggestionCount - status - reviewRunId additionalProperties: false required: - id - assetType - filename - contentType - size - url - createdAt - updatedAt - description - altText - tags - imageType - width - height - source - sourceProvider - sourceProviderId - sourceUrl - licenseName - licenseUrl - attributionText additionalProperties: false required: - success - asset additionalProperties: false '400': description: Default Response content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Default Response content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Default Response content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Default Response content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: ErrorResponse: type: object properties: errorCode: $ref: '#/components/schemas/SegmentflowErrorCode' description: >- Stable machine-readable error code. SDKs map this to typed exception classes. example: TEMPLATE_NAME_EXISTS message: type: string description: >- Human-readable error message. May change between releases; do not parse. example: Template name 'Hello' already exists in this organization. details: description: >- Optional structured detail. `issues` carries per-field validation problems; other keys are reserved. type: object properties: issues: type: array items: $ref: '#/components/schemas/ErrorIssue' additionalProperties: description: Any JSON value. nullable: true x-stainless-any: true required: - errorCode - message additionalProperties: false description: 'Canonical error envelope (ADR-0008): `{ errorCode, message, details? }`.' SegmentflowErrorCode: type: string enum: - BAD_REQUEST - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - GONE - UNPROCESSABLE_ENTITY - TOO_MANY_REQUESTS - VALIDATION_ERROR - INTERNAL_ERROR - NOT_IMPLEMENTED - SERVICE_UNAVAILABLE - DATABASE_ERROR - IDEMPOTENCY_KEY_TOO_LONG - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_IN_FLIGHT - JOURNEY_NOT_FOUND - JOURNEY_WRONG_ENTRY_NODE - JOURNEY_MISSING_RECIPIENT_EMAIL - JOURNEY_MISSING_REQUIRED_VARIABLES - JOURNEY_RECIPIENT_ERASED - JOURNEY_RUN_NOT_FOUND - BROADCAST_NOT_FOUND - BROADCAST_SCHEDULING_NOT_IMPLEMENTED - BROADCAST_INVALID_STATE - BROADCAST_SEND_NOT_ALLOWED - PREPARED_SEND_NOT_FOUND - PREPARED_SEND_EXPIRED - PREPARED_SEND_CROSS_USER - PREPARED_SEND_CORRUPT - PREPARED_SEND_CONCURRENT_REDEEM - PREPARED_SEND_VALIDATION_FAILED - TEMPLATE_NOT_FOUND - TEMPLATE_NAME_EXISTS - PROFILE_NOT_FOUND - PROFILE_SUBSCRIPTION_GROUP_NOT_FOUND - PROFILE_TRAITS_WRITE_UNSUPPORTED - MISSING_CREDENTIAL - INVALID_API_KEY - INVALID_OAUTH_TOKEN - AMBIGUOUS_CREDENTIAL - INSUFFICIENT_SCOPE - MULTIPLE_CREDENTIALS_PRESENT - BEARER_CREDENTIAL_REMOVED - SESSION_ROLE_INSUFFICIENT - API_KEY_SCOPE_INSUFFICIENT - BILLING_DISABLED - BILLING_NOT_CONFIGURED description: >- Stable machine-readable error code. SDK codegen maps these to typed exception classes. ErrorIssue: type: object properties: path: anyOf: - type: string - type: array items: anyOf: - type: string - type: number description: >- Where in the request the issue occurred. String for simple paths; array for nested paths. example: name code: type: string description: >- Stable, machine-readable kind of issue (e.g. 'required', 'invalid_type'). example: duplicate message: type: string description: Human-readable description of the issue. example: Template name already exists in this organization. required: - path - code - message additionalProperties: false description: A single validation issue inside an error response's `details.issues[]`. securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: Unified API key for server-side SDK and API integrations ````