---
updatedAt: 2026-04-08T10:21:10.000Z
agentTools:
projectIndex: https://developer.goacoustic.com/acoustic-content/llms.txt
---
# Create new image profiles.
Use the /image-profiles end-point to create a new image profile.
User roles: admin, manager
# OpenAPI definition
```json
{
"openapi": "3.0.0",
"info": {
"version": "1.0.142",
"x-ibm-name": "ibm-watson-content-hub-api",
"title": "Acoustic Content API",
"description": "Copyright © Acoustic, L.P. 2019"
},
"tags": [
{
"name": "Authoring image profiles",
"description": "Use the Acoustic Content authoring image profile service Rest APIs to work with image profiles. You can create, retrieve, and update image profiles in a database."
}
],
"paths": {
"/authoring/v1/image-profiles": {
"post": {
"summary": "Create new image profiles.",
"description": "Use the /image-profiles end-point to create a new image profile.
User roles: admin, manager",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "An new image profile.",
"properties": {
"name": {
"type": "string",
"description": "The name of the image profile.",
"pattern": "^[a-zA-Z0-9*. \\-+_~$!',()]*$",
"minLength": 1
},
"description": {
"type": "string",
"description": "The description of the image profile.",
"pattern": "^[a-zA-Z0-9*. \\-+_~$!',()]*$"
},
"classification": {
"enum": [
"image-profile"
]
},
"created": {
"type": "string",
"description": "Optional creation date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. Value is ignored if set in the future.",
"format": "date-time"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"example": [
"news",
"sample"
]
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"description": "A indiviual dimension within an image profile.",
"properties": {
"label": {
"type": "string",
"description": "The dimension label."
},
"key": {
"type": "string",
"description": "The dimension key."
},
"description": {
"type": "string",
"description": "The description of the dimension."
},
"width": {
"type": "number",
"description": "The dimension's width"
},
"height": {
"type": "number",
"description": "The dimension's height"
}
}
}
},
"isSystem": {
"type": "boolean",
"description": "Indicates whether this item is a 'system item' or not.",
"default": false
}
},
"required": [
"name",
"classification",
"dimensions"
]
}
}
},
"description": "Contains the image profile to create.",
"required": true
},
"responses": {
"200": {
"description": "Success.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "An existing image profile.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the image profile.",
"pattern": "^[a-zA-Z0-9*.\\-+_~$!',()]*$",
"minLength": 1
},
"rev": {
"type": "string",
"description": "The current revision of the image profile.",
"minLength": 1
},
"name": {
"type": "string",
"description": "The name of the image profile.",
"pattern": "^[a-zA-Z0-9*. \\-+_~$!',()]*$",
"minLength": 1
},
"description": {
"type": "string",
"description": "The description of the image profile.",
"pattern": "^[a-zA-Z0-9*. \\-+_~$!',()]*$"
},
"classification": {
"enum": [
"image-profile"
]
},
"creatorId": {
"type": "string",
"description": "The ID of the user that created the image profile.",
"minLength": 1
},
"creator": {
"type": "string",
"description": "The display name of the user that created the image profile. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\nThis field is read only.\n"
},
"created": {
"type": "string",
"description": "The created date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.",
"format": "date-time",
"minLength": 1
},
"lastModifierId": {
"type": "string",
"description": "The ID of the user that last modified the image profile.",
"minLength": 1
},
"lastModifier": {
"type": "string",
"description": "The display name of the last user that modified the image profile. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.\nThis field is read only.\n"
},
"lastModified": {
"type": "string",
"description": "The last modified date of this image profile in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.",
"format": "date-time",
"minLength": 1
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"example": [
"news",
"sample"
]
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"description": "A indiviual dimension within an image profile.",
"properties": {
"label": {
"type": "string",
"description": "The dimension label."
},
"key": {
"type": "string",
"description": "The dimension key."
},
"description": {
"type": "string",
"description": "The description of the dimension."
},
"width": {
"type": "number",
"description": "The dimension's width"
},
"height": {
"type": "number",
"description": "The dimension's height"
}
}
}
},
"isSystem": {
"type": "boolean",
"description": "Indicates whether this item is a 'system item' or not.",
"default": false
}
},
"required": [
"rev",
"name",
"classification",
"creatorId",
"dimensions"
]
}
}
}
},
"400": {
"description": "Empty body or Invalid input.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "an error response.",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"description": "an individual error, info or warning message.",
"properties": {
"code": {
"type": "integer",
"description": "The message code."
},
"key": {
"type": "string",
"description": "The message key."
},
"message": {
"type": "string",
"description": "The error message."
},
"description": {
"type": "string",
"description": "Optional detailed error message."
},
"more_info": {
"type": "string",
"description": "Optional additional information for the message."
},
"category": {
"type": "string",
"description": "The message category whereby only user messages are designed to be shown to an end user.",
"enum": [
"API",
"USER"
]
},
"level": {
"type": "string",
"description": "Indicates the message level.",
"enum": [
"INFO",
"WARNING",
"ERROR"
]
},
"parameters": {
"type": "object",
"description": "The message parameters of this message."
},
"field": {
"type": "string",
"description": "Only present on field validation errors, indicates the field in error."
},
"locale": {
"type": "string",
"description": "The current locale used to produce the error message."
}
}
}
},
"requestId": {
"type": "string",
"description": "The current request ID."
},
"service": {
"type": "string",
"description": "The name of the service that produced the error."
},
"requestMethod": {
"type": "string",
"description": "The Http method type of the current request."
},
"requestUri": {
"type": "string",
"description": "The current request uri."
}
}
}
}
}
},
"404": {
"description": "Current tenant's database is not provisioned.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "an error response.",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"description": "an individual error, info or warning message.",
"properties": {
"code": {
"type": "integer",
"description": "The message code."
},
"key": {
"type": "string",
"description": "The message key."
},
"message": {
"type": "string",
"description": "The error message."
},
"description": {
"type": "string",
"description": "Optional detailed error message."
},
"more_info": {
"type": "string",
"description": "Optional additional information for the message."
},
"category": {
"type": "string",
"description": "The message category whereby only user messages are designed to be shown to an end user.",
"enum": [
"API",
"USER"
]
},
"level": {
"type": "string",
"description": "Indicates the message level.",
"enum": [
"INFO",
"WARNING",
"ERROR"
]
},
"parameters": {
"type": "object",
"description": "The message parameters of this message."
},
"field": {
"type": "string",
"description": "Only present on field validation errors, indicates the field in error."
},
"locale": {
"type": "string",
"description": "The current locale used to produce the error message."
}
}
}
},
"requestId": {
"type": "string",
"description": "The current request ID."
},
"service": {
"type": "string",
"description": "The name of the service that produced the error."
},
"requestMethod": {
"type": "string",
"description": "The Http method type of the current request."
},
"requestUri": {
"type": "string",
"description": "The current request uri."
}
}
}
}
}
},
"409": {
"description": "Image profile with the same name exists."
},
"429": {
"description": "Too Many Requests, the server has reached a limit, the request must be sent again at a later time.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "an error response.",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"description": "an individual error, info or warning message.",
"properties": {
"code": {
"type": "integer",
"description": "The message code."
},
"key": {
"type": "string",
"description": "The message key."
},
"message": {
"type": "string",
"description": "The error message."
},
"description": {
"type": "string",
"description": "Optional detailed error message."
},
"more_info": {
"type": "string",
"description": "Optional additional information for the message."
},
"category": {
"type": "string",
"description": "The message category whereby only user messages are designed to be shown to an end user.",
"enum": [
"API",
"USER"
]
},
"level": {
"type": "string",
"description": "Indicates the message level.",
"enum": [
"INFO",
"WARNING",
"ERROR"
]
},
"parameters": {
"type": "object",
"description": "The message parameters of this message."
},
"field": {
"type": "string",
"description": "Only present on field validation errors, indicates the field in error."
},
"locale": {
"type": "string",
"description": "The current locale used to produce the error message."
}
}
}
},
"requestId": {
"type": "string",
"description": "The current request ID."
},
"service": {
"type": "string",
"description": "The name of the service that produced the error."
},
"requestMethod": {
"type": "string",
"description": "The Http method type of the current request."
},
"requestUri": {
"type": "string",
"description": "The current request uri."
}
}
}
}
}
}
},
"x-ibm-dx-security-user-roles": [
"admin",
"manager"
],
"tags": [
"Authoring image profiles"
]
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"description": "This JSON record represents an error condition.",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"description": "This JSON record represents an individual error or warning contained in an error message.",
"type": "object",
"properties": {
"code": {
"type": "integer",
"description": "An error code"
},
"message": {
"type": "string",
"description": "A message describing what went wrong."
},
"description": {
"type": "string",
"description": "Further explanation of the error condition and potential next steps to resolve the problem."
},
"more_info": {
"type": "string",
"description": "A URL pointing to a web site that provides more information on the given error condition."
},
"level": {
"type": "string",
"enum": [
"ERROR",
"WARNING"
],
"description": "The severity level of the message. Default is error."
},
"parameters": {
"type": "object",
"description": "Additional properties reflecting the dynamic parts of the error condition."
},
"cause": {
"type": "object",
"description": "This property can be used to transport causing error message records produced by a down stream service calls."
},
"locale": {
"type": "string",
"description": "This property represents the locale of the text contained in properties 'message', and 'description'. This property is mandatory if message and description contain translated text."
}
},
"required": [
"code",
"message"
]
}
},
"requestId": {
"type": "string",
"description": "The ID of the failing request."
},
"service": {
"type": "string",
"description": "The name of the service serving the error message."
}
},
"required": [
"errors",
"requestId"
]
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```