> ## Documentation Index > Fetch the complete documentation index at: https://docs.aiderx.io/llms.txt > Use this file to discover all available pages before exploring further. # Add a field to a native format. ## OpenAPI ````yaml /openapi/adm.openapi.en-dev.json post /api/manager/native-formats/{fid}/fields openapi: 3.1.0 info: description: > ## Introduction The Data Management APIs comprehensively oversees the **diverse data** used by advertising and recommendation systems, ensuring that the Decision API runs accurately and efficiently. From registering, updating, and deleting campaigns and placements to **log and statistics analysis**, it provides the insights necessary for effective system operation. The resulting data and metrics are used by the Decision API to **optimize ad and content decisions**, ultimately boosting the overall performance of the advertising and recommendation system. title: Data Management APIs version: dev servers: [] security: [] tags: - description: >- Authentication endpoints. All roles (admin, operator, advertiser) use these to log in, refresh tokens, and manage their own credentials. name: Auth - description: >- Advertiser account management. Operators and admins onboard advertisers, manage their budgets, and deactivate accounts. Advertisers can only read their own profile and balance — they cannot create, delete, or modify another advertiser's account. name: Advertisers - description: >- Internal user (operator / admin) account management. Admin only. Covers creating operator accounts, changing roles, toggling activation status, and hard-deleting accounts. Operators have no access to this resource. name: Users - description: >- The AdUnit Management API provides comprehensive functionalities for managing ad units and related resources. AdUnits are organized in a hierarchical path structure derived from their code and parent path. Only admin and operator roles have access — advertisers cannot access raw inventory. References: [Placement](https://docs.aiderx.io/guides/about-a2/en/placement) name: AdUnit - description: >- Ad catalog management. CRUD for ad catalogs plus public shared-view access via a share link. name: Ad Catalogs - description: >- Ad source (demand partner) management. CRUD for external ad sources that supply demand to ad units. name: AdSource - description: >- Allocation management. An allocation binds a line item to a serving target such as an ad unit. Covers CRUD, status counts, and single-allocation lookup. name: Allocations - description: >- Associated items pool (admin). Bulk upsert/delete and lookup of associated-items pools used by the recommendation pipeline. name: AssociatedItemsPool - description: >- Custom targeting segment management. CRUD and bulk operations for custom targeting segments. name: Custom Targeting Segment - description: Audit log access. Read the system audit log of administrative actions. name: Audit Logs - description: >- Creative block list. List, block, and unblock creatives to exclude them from serving. name: Blocked Creative - description: Catalog item management. List and update catalog (product/data) items. name: Catalogs - description: >- Creative asset management. Operators and admins manage creatives; advertisers see only their own. Deletion is blocked while any line-item association (LICA) still exists. name: Creatives - description: >- Dashboard aggregates. Summary data, inventory, and line-item metric rollups for the console dashboard. name: Dashboard - description: Experiment management. CRUD for A/B and optimization experiments. name: Experiment - description: >- External creative inspection. Read-only access to creatives ingested from external demand sources. name: External Creative - description: >- Third-party integration management. Manage integration sources (external data/serving connectors), probe connectivity, and read public (sensitive-config-redacted) configs. name: Integration - description: >- Line Item–Creative Associations (LICA). Associates creatives with line items, including batch create and delete (max 100, partial failure allowed) and dashboard counts. name: LICAs - description: License information. Read available license features and usage metrics. name: License - description: >- Line item management within an order. Covers create, update, delete, batch operations (max 100, partial failure allowed), and status transitions. A line item defines budget, goal, schedule, and targeting under its parent order. name: LineItems - description: Media library. List, upload, and delete media files used by creatives. name: Media Library - description: >- Metric query endpoints. Retrieve aggregated metrics for ad units, creatives, line items, and related entities. name: Metric - description: >- Advertiser order management. Operators and admins create and manage orders that group line items under a single budget; advertisers can read their own. Includes batch operations (max 100) and draft-only deletion rules. name: Orders - description: >- Placement management. A placement maps ad units to a serving surface. Endpoints cover CRUD and replacing the ad units bound to a placement. name: Placements - description: >- System settings. Read and update system configuration, including site logo, public URL, TLS, and access-token regeneration. name: Settings - description: System resources. Public static resources such as the site logo. name: System - description: >- Operational/developer control endpoints. Low-level ext patches and health checks intended for internal operation, not general API consumers. name: developer - description: >- Operational allocation control. Update allocation ext or force-update status (admin only). name: developer/control/allocations - description: >- Ad-serving monitoring (operational). Read ad-serving status, ad-unit monitoring history, and alerts. name: developer/monitoring - description: Internal health and probe endpoints. name: internal - description: >- Manager-level utility endpoints (e.g. service health) not tied to a specific resource. name: manager - description: Manage mappings between ad units, native formats, and native styles. name: Ad Unit Native Style - description: Manage custom targeting keys, including lifecycle and bulk operations. name: Custom Targeting Key - description: >- Manage values belonging to custom targeting keys, including lifecycle and bulk operations. name: Custom Targeting Value - description: Manage native formats and the fields that define each format. name: Native Format - description: List templates available for native styles. name: Native Style Template - description: Manage native rendering styles. name: Native Style paths: /api/manager/native-formats/{fid}/fields: post: tags: - Native Format summary: Add a field to a native format. operationId: >- handle_add_native_format_field_api_manager_native_formats__fid__fields_post parameters: - in: path name: fid required: true schema: format: uuid title: Fid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NativeFormatFieldCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NativeFormatDetailResponse' description: Successful Response '400': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Bad Request '403': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Forbidden '404': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Not found '409': content: application/json: schema: $ref: '#/components/schemas/HTTPExceptionResponse' description: Conflict '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - HTTPBearer: [] components: schemas: NativeFormatFieldCreate: properties: asset_binding: $ref: '#/components/schemas/AssetBinding' constraints: anyOf: - discriminator: mapping: image: $ref: '#/components/schemas/ImageConstraints' number: $ref: '#/components/schemas/NumberConstraints' text: $ref: '#/components/schemas/TextConstraints' url: $ref: '#/components/schemas/UrlConstraints' video: $ref: '#/components/schemas/VideoConstraints' propertyName: input_type oneOf: - $ref: '#/components/schemas/TextConstraints' - $ref: '#/components/schemas/ImageConstraints' - $ref: '#/components/schemas/VideoConstraints' - $ref: '#/components/schemas/UrlConstraints' - $ref: '#/components/schemas/NumberConstraints' - type: 'null' title: Constraints description: anyOf: - type: string - type: 'null' title: Description input_type: $ref: '#/components/schemas/NativeInputType' default: text is_required: default: false title: Is Required type: boolean label: minLength: 1 title: Label type: string name: pattern: ^[a-z_]+$ title: Name type: string required: - asset_binding - label - name title: NativeFormatFieldCreate type: object NativeFormatDetailResponse: properties: created_at: format: date-time title: Created At type: string description: anyOf: - type: string - type: 'null' description: Optional description of the format. title: Description fields: default: [] items: $ref: '#/components/schemas/NativeFormatFieldResponse' title: Fields type: array format_type: $ref: '#/components/schemas/NativeFormatType' default: user_defined description: Whether this format is system-defined or user-defined. id: description: Unique identifier (UUID v7). format: uuid title: Id type: string name: description: Human-readable name of the format. title: Name type: string 'no': anyOf: - type: integer - type: 'null' title: 'No' owner_id: description: ID of the operator who owns this format. format: uuid title: Owner Id type: string owner_name: anyOf: - type: string - type: 'null' description: Name of the format owner title: Owner Name status: $ref: '#/components/schemas/NativeFormatStatus' default: inactive description: Operational status of the format. updated_at: format: date-time title: Updated At type: string required: - id - created_at - updated_at - name - owner_id title: NativeFormatDetailResponse type: object HTTPExceptionResponse: properties: detail: description: Detailed explanation for the exception title: Detail type: string required: - detail title: HTTPExceptionResponse type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object AssetBinding: properties: asset_kind: $ref: '#/components/schemas/AssetKind' asset_type: anyOf: - type: integer - type: 'null' description: >- OpenRTB asset subtype. 500 = reserved for "other" (no standard subtype). title: Asset Type required: - asset_kind title: AssetBinding type: object ImageConstraints: properties: allowed_ratios: anyOf: - items: type: string type: array - type: 'null' title: Allowed Ratios input_type: const: image default: image title: Input Type type: string title: ImageConstraints type: object NumberConstraints: properties: input_type: const: number default: number title: Input Type type: string max: anyOf: - type: number - type: 'null' title: Max min: anyOf: - type: number - type: 'null' title: Min title: NumberConstraints type: object TextConstraints: properties: input_type: const: text default: text title: Input Type type: string max_length: anyOf: - type: integer - type: 'null' title: Max Length title: TextConstraints type: object UrlConstraints: properties: allowed_schemes: items: type: string title: Allowed Schemes type: array input_type: const: url default: url title: Input Type type: string title: UrlConstraints type: object VideoConstraints: properties: allowed_ratios: anyOf: - items: type: string type: array - type: 'null' title: Allowed Ratios input_type: const: video default: video title: Input Type type: string title: VideoConstraints type: object NativeInputType: enum: - text - image - video - url - number title: NativeInputType type: string NativeFormatFieldResponse: properties: asset_binding: $ref: '#/components/schemas/AssetBinding' constraints: anyOf: - {} - type: 'null' description: |- Input-type-specific constraints (shape varies by `input_type`). Validated in Python service layer via native_types.NativeConstraint. title: Constraints created_at: format: date-time title: Created At type: string description: anyOf: - type: string - type: 'null' title: Description format_id: description: NativeFormat this field belongs to. format: uuid title: Format Id type: string id: format: uuid title: Id type: string input_type: $ref: '#/components/schemas/NativeInputType' default: text is_required: default: false title: Is Required type: boolean label: minLength: 1 title: Label type: string name: pattern: ^[a-z_]+$ title: Name type: string 'no': default: 0 title: 'No' type: integer updated_at: format: date-time title: Updated At type: string required: - id - created_at - updated_at - asset_binding - format_id - label - name title: NativeFormatFieldResponse type: object NativeFormatType: enum: - system_defined - user_defined title: NativeFormatType type: string NativeFormatStatus: enum: - active - inactive title: NativeFormatStatus type: string ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object AssetKind: enum: - title - image - video - data - link title: AssetKind type: string securitySchemes: HTTPBearer: description: >- Bearer authentication. Pass the access token in the `Authorization: Bearer ` header. scheme: bearer type: http ````