Acoustic Authoring search API

## General Use the Content authoring search service REST API to access assets, categories, content, content types, image profiles, and taxonomies by searching the content hub. You need prior authentication to use the authoring search service. The authoring search service contains content in all states including draft, ready, and retired. ## Content workflow (status) The status of a content item can be determined by the **suffix** of the ID: - An ID like xxxx:**draft** indicates that the item is a draft. This is the initial status of a new content item until it is published. A draft of a published content item will also have this suffix. - An ID like xxxx:***[publishing_job_id]*** - indicates that the content item has been scheduled for publish in the given publishing job. - An ID like xxxx with no suffix indicates that the content is **published** or **retired**. A draft can be created from published. When such a draft is published, it will override the previously published content. **Key notes:** - The base ID (xxxx) does not change. Only the suffix changes according to the workflow status of the item. - Where content and assets are referenced from within a content item, the 'raw' ID form, without a suffix, is always used. For example, when a draft content item is referenced by another draft content item, the reference appears as a raw ID, and thus does not change when the items are published.

Operations 2

GET /authoring/v1/search Search in the authoring collection #
POST /authoring/v1/search/json Search in the authoring collection using post request with json body #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/acoustic-authoring-search-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

acoustic-authoring-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.142
  x-ibm-name: ibm-watson-content-hub-api
  title: Acoustic Content Authoring search API
  description: Copyright © Acoustic, L.P. 2023
tags:
- name: Authoring search
  description: '## General

    Use the Content authoring search service REST API to access assets, categories, content, content types, image profiles, and taxonomies by searching the content hub.'
paths:
  /authoring/v1/search:
    get:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      tags:
      - Authoring search
      summary: Search in the authoring collection
      description: Performs a search query by passing all query parameters to Solr.
      parameters:
      - name: defType
        description: The Solr "defType" parameter. Specify "defType=edismax" to use the edismax query parser.
        in: query
        required: false
        schema:
          type: string
      - name: df
        description: Either the Solr "df" or "qf" parameter is required. The parameter is supported by the edismax query parser.
        in: query
        required: false
        schema:
          type: string
      - name: facet
        description: The Solr "facet" parameter enables faceted search. Always set this parameter to true if you are using the other "facet" parameters.
        in: query
        required: false
        schema:
          type: string
      - name: facet.contains
        description: The Solr "facet.contains" parameter returns only facets containing this term.
        in: query
        required: false
        schema:
          type: string
      - name: facet.containsIgnoreCase
        description: The Solr "facet.containsIgnoreCase" parameter ignores case when the "facet.contains" parameter is applied.
        in: query
        required: false
        schema:
          type: string
      - name: facet.field
        description: The Solr "facet.field" parameter identifies a field to be used as a facet.
        in: query
        required: false
        schema:
          type: string
      - name: facet.limit
        description: The Solr "facet.limit" parameter specifies a limit for the number of results that are returned for each facet. Default value is 100.
        in: query
        required: false
        schema:
          type: string
      - name: facet.offset
        description: The Solr "facet.offset" parameter specifies an offset into the facet results that are returned and can be used for paging facet results. Default value is 0.
        in: query
        required: false
        schema:
          type: string
      - name: facet.prefix
        description: The Solr "facet.prefix" parameter returns only facets with this prefix.
        in: query
        required: false
        schema:
          type: string
      - name: facet.range
        description: The Solr "facet.range" parameter.
        in: query
        required: false
        schema:
          type: string
      - name: facet.range.end
        description: The Solr "facet.range.end" parameter.
        in: query
        required: false
        schema:
          type: string
      - name: facet.range.gap
        description: The Solr "facet.range.gap" parameter.
        in: query
        required: false
        schema:
          type: string
      - name: facet.range.start
        description: The Solr "facet.range.start" parameter.
        in: query
        required: false
        schema:
          type: string
      - name: fl
        description: The Solr "fl" parameter defines the fields that are returned in the response. By default, the search service returns all fields that are highlighted in the "Stored" column of the table at the beginning of this document.
        in: query
        required: false
        schema:
          type: string
      - name: fq
        description: The Solr "fq" parameter applies a filter query to the search results.
        in: query
        required: false
        schema:
          type: string
      - name: f.<fieldName>.<FacetParam>
        description: Many "facet" parameters can be overridden on a per-field basis using the syntax "f.<fieldName>.<FacetParam>=<value>". For example, to specify a general limit of 10 terms for all facet fields and a specific limit of 5 terms for only the "category" facet field, use "facet.limit=10" and "f.category.facet.limit=5".
        in: query
        required: false
        schema:
          type: string
      - name: indent
        description: If the Solr "indent" parameter is not "off" and has a non-blank value, then Solr attempts at indenting the XML response such that it is easier to read. The default behavior is not to indent the XML response.
        in: query
        required: false
        schema:
          type: string
      - name: q
        description: The Solr "q" parameter uses Solr/Lucene standard query syntax.
        in: query
        required: false
        schema:
          type: string
      - name: qf
        description: Either the Solr "df" or "qf" parameter is required. The parameter is supported by the edismax query parser.
        in: query
        required: false
        schema:
          type: string
      - name: rows
        description: The Solr "rows" parameter controls how many documents are returned at the most, and can be used for paging query results. The default value is 10. The maximum allowed value is 1000.
        in: query
        required: false
        schema:
          type: integer
      - name: sort
        description: The Solr "sort" parameter controls sorting of the query response. Sorting on not unique fields can cause paging to return duplicate or missing entries in subsequent pages of results. It's recommended to sort by unique field or a combination ex. sort=lastModied desc, status desc.
        in: query
        required: false
        schema:
          type: string
      - name: start
        description: The Solr "start" parameter specifies an offset into the responses, which are returned and can be used for paging query results. Default value is 0.
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: See the description above for examples of response data for different queries.
        '400':
          description: Bad request - Unable to complete your request due to missing parameters. Provide all required parameters and try again.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
        '404':
          description: Not found - The authoring collection was not found.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
        '414':
          description: The request URL that addresses the search service is larger than the supported size of 4,096 bytes. Reduce the length of the query.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
        '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: Internal server error - Unable to complete your request due to an exception. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
      operationId: getAuthoringV1Search
      x-operation-id-source: derived
  /authoring/v1/search/json:
    parameters: []
    post:
      x-ibm-dx-security-user-roles:
      - admin
      - manager
      - editor
      - viewer
      tags:
      - Authoring search
      summary: Search in the authoring collection using post request with json body
      description: 'The request body contains an json object with search query


        User roles: admin, manager, editor, viewer'
      responses:
        '200':
          description: See the description above for examples of response data for different queries.
        '400':
          description: Bad request - Unable to complete your request due to missing parameters. Provide all required parameters and try again.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
        '404':
          description: Not found - The authoring collection was not found.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
        '414':
          description: The request URL that addresses the search service is larger than the supported size of 4,096 bytes. Reduce the length of the query.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
        '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: Internal server error - Unable to complete your request due to an exception. Try again later.
          content:
            application/json:
              schema:
                type: object
                description: This JSON object describes an error condition.
                properties:
                  requestId:
                    type: string
                    description: The unique identifier of the request that failed.
                  service:
                    type: string
                    description: The name of the service that reports the error.
                  errors:
                    type: array
                    items:
                      type: object
                      description: This JSON object describes a specific error of an error condition.
                      properties:
                        code:
                          type: integer
                          description: An error code that is specific to the service that reports the error.
                        message:
                          type: string
                          description: A message that describes what went wrong.
                        description:
                          type: string
                          description: A more detailed explanation of the error condition and recommended steps to resolve the issue.
                        more_info:
                          type: string
                          description: A URL pointing to a source that provides more information on this error.
                        level:
                          type: string
                          enum:
                          - ERROR
                          - WARNING
                          description: The severity of this error.
                        parameters:
                          type: object
                          description: Additional properties that represent dynamic parts used in the 'message'.
                        cause:
                          type: object
                          description: The error message that was produced by a downstream service and represents the cause of this error.
                        locale:
                          type: string
                          description: The locale information of the text provided as 'message' and as 'description' of this error.
                      required:
                      - code
                      - message
                required:
                - requestId
                - errors
      operationId: postAuthoringV1SearchJson
      x-operation-id-source: derived
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