Skip to content
Back to Home

Frequently Asked Questions

AP Media API FAQs

What is AP Media API?

AP Media API a new programmatic delivery platform where you can access all your licensed multimedia content through a simple API interface. You can receive a continuous feed of news content or perform granular searches across archives of all media types.

What is AP Media Agent?

AP Media Agent is a Java application for content ingestion that allows you to automatically download news content available through AP Media API feeds. You can configure and manage your content ingest agents on the AP Media API portal.

Which AP services will AP Media API eventually replace?

The AP Media API is aimed at consolidating and streamlining AP's content distribution services. This new, modern, cloud-based distribution platform will eventually replace AP's legacy WebFeeds (both direct and agent) and API services (AP Content API and AP Breaking News API).

Note

AP Metadata Services (APMS) and Elections API will NOT be replaced by AP Media API.

When will I need to migrate to the new AP Media API?

We plan to have all AP WebFeeds, AP Content API and AP Breaking News API customers migrated to the new API by the end of 2019. Migration phases will begin in January 2019 and continue throughout the year. Depending on the migration phase your organization is included in, you may be asked to begin the migration process as early as January 2019.

When will AP WebFeeds be retired?

We plan to retire AP WebFeeds by the end of 2019.

When will AP Content API be retired?

We plan to retire AP Content API by the end of 2019.

When will AP Breaking News API be retired?

We plan to retire AP Breaking News API by the end of 2019.

Does the AP Media API support B2C (Business-to-Consumer) syndication?

No, AP Media API is designed for B2B (Business-to-Business) integration with your content ingestion systems or CMSs. The content and feeds must not be published directly to your websites. Usage beyond the standard B2B profile may be subject to auditing.

Should I use AP Media Agent or write a program to make direct calls to the AP Media API?

Writing a custom program is recommended if you are looking for tighter integration of your content ingestion system or CMS with AP Media API. However, this requires software development resources to implement a solution for processing a feed or searching and downloading content.

Alternatively, you can use the AP Media API Agent and Portal, an out-of-the box solution for automatic content downloads that offers a wide variety of configuration options to meet your needs and allows you to start downloading content right away.

How do I get my list of entitlements?

Use this API request:

https://api.ap.org/media/v/account/plans?apikey={apikey}[&format=csv]

By default, JSON is returned. Optionally, you can receive your plan details in the CSV format by adding the format=csv parameter to your request (see Account Plans).

What is the basic syntax and parameters used to make search requests?

See Search Examples and Search.

What is the basic syntax and parameters used to make feed requests?

See Feed Examples and Feed.

How do I authenticate the AP Media API and Agent?

An API key is required for making AP Media API calls.

A username/password is required to log in to the AP Media API Portal, and an API key is required to register the AP Media Agent with the portal.

What format is the API response in?

The API responses are delivered in JSON.

Is there somewhere I can build and test live API calls?

The Swagger-based API Explorer is available. The API Explorer is an interactive quick reference that lists the API methods and parameters and allows for testing live API calls and generating sample code. An API key is required for testing live API calls.

What media types are available in the AP Media API?

Media types include text (stories with linked curated content), pictures, print graphics, video and audio in various sizes and renditions (see Content File Formats and Renditions).

What kinds of metadata are available in the AP Media API?

Content item metadata returned by AP Media API includes AP classification metadata, which is designed to help you get the most out of the content delivered by the AP. For more information, see Content Metadata Fields (for the descriptions of the returned metadata fields), Leveraging AP Metadata (for metadata benefits, solutions and use cases) and AP Classification Metadata (for the possible values of the AP classification metadata elements).

What is linked curated media?

See Linked Media.

The AP Media API Search method provides programmatic access to 30 days of content, as well as the full library of current and archive audio and print graphics content; depending on your contract terms. Access will subsequently be expanded to include the entire AP image and video archives.

How far back in time can I go in Feed?

The AP Media API Feed method and the AP Media Agent allow downloading content up to the last 72 hours; depending on your contract terms.

How can I get a Followed Topic feed via AP Media API?

See Followed Topic Feed Delivery.

What is Long Polling?

See About Long Polling.

How many product IDs should I combine into a single request?

To minimize duplicate content and maintain optimal efficiency, we recommend combining all package/product IDs into a single request unless your workflow calls for querying specific products in separate batches. If you are querying by package ID, there is no need to query individual products within that package because by default, querying a package includes all products within the package.

How do I use the include/exclude parameters in my requests?

See Customizing Response Fields.

Why can't I remove certain fields from the JSON response using the exclude parameter?

See Required vs. Default Fields.

How can I manage revisions of a story/item?

See Managing Revisions and Duplicates.

Why do I get duplicate stories?

See What are duplicates?

How can I manage duplicate content?

See How can I determine if a content item is a duplicate of one previously downloaded?

How can I determine which AP content is publishable?

See Identifying Publishable Content.

What are AP Top Headlines?

See AP Top Headlines.

How can I exclude AP Top News Headline packages from my feed/search results?

Add +AND+NOT+profile:(extendedheadlinepackage+OR+headlinepackage) to the value of your query parameter; for example:

https://api.ap.org/media/v/content/search?q=soccer+AND+NOT+profile:(extendedheadlinepackage+OR+headlinepackage)&apikey={apikey}

How many items will be returned in my search/feed results?

The default is 10 items with a maximum of 100 per page. The page size can also be specified in the query using the page_size parameter (see optional parameters for Search and Feed).

How can I ensure that I'm only getting new content with each feed request?

To check for any updates since your previous request, use the "next_page" link returned in the feed response for the next request (see Getting Content Updates Using Next Request Links).

How can I create a feed from search results in the API?

To get your most recent licensed content that meets your search criteria, turn your search into a feed by following the "feed_href" link at the end of the last page of the search results.

{// Example:
"page_size": 10,
"total_items": 8162,
"current_item_count": 2,
"feed_href": "https://api.ap.org/media/v/content/search?page=follow-0/fff481c2cb084068b1b58a9d2954d152",}

Do you offer Entry XML as one of the new formats in the AP Media API?

No. Content item metadata is available in the JSON format.

Can I get the full body content from the story delivered in the feed response?

No, the full story body in not embedded in the feed response. The feed response includes links to the stories in the NITF and ANPA formats.

I am interested in specific video renditions. How can I ensure that I ingest them properly?

Each video delivered by AP Media API is made available in various renditions (formats, quality and encodings). To deliver new content to you as fast as possible, videos are released into AP Media API feeds as soon as some of the renditions are available and not necessarily when all renditions have finished being produced. As more renditions become available, the video content item will appear in your feed again with the same version and item ID (altids.itemid), but with more renditions available for download and a different ETag (altids.etag).

To avoid discarding video rendition updates as duplicates and therefore missing some of the renditions that you may be interested in (for example, MP4), make sure to use ETag rather than version to manage revisions and duplicates. For more information, see Managing Revisions and Duplicates.

How can I download metered or priced (non-subscription) content using the API?

When a content item rendition download incurs a charge, AP Media API requires the charge acknowledgment on the download of the content item rendition. See Acknowledging Pricing on Rendition Downloads.

How can I find a specific piece of content using the API?

Use the item ID of the content item in the Item Metadata request; for example:

https://api.ap.org/media/v/content/fedf6ff0f6564fc29449f189d9242349?apiKey={apiKey}

How can I go to a specific point in time (within the last 72 hours) in a feed?

See Resetting Ingestion Time.

What are the possible error messages I could receive in the AP Media API?

See API Codes.

What are the throttle/quota limits for an API key?

Throttle/quota limits specify the maximum number of API calls allowed during a certain interval; for example, per minute or per day. These limits are used to manage the API's system capacity and the access rights of the API. AP Media API allows you to look up the throttle quota limits for an API key (see Account Quotas).

AP Media Agent FAQs

See the AP Media Agent and Portal Quick Reference FAQs.

General FAQs

How can I determine what kind of content I will receive over a particular product or package ID?

Go to AP Newsroom, log in with your AP Media API credentials, enter productid:{productID} in the Search box, and you will see what content moved on this product ID in the last 30 days.

What is an abstract/summary? How can I get it?

Note

Abstract (story summary) is an optional add-on to existing text services to which your organization may or may not be entitled. If you are interested in receiving this story element, please contact your AP sales representative.

The Abstract provides a summary of text stories written by AP journalists, which encapsulates the story in approximately 50-75 words. These summaries are great for digital and mobile use, social media properties, text-to-audio applications, and more.

If included in your service, the story summary is delivered in the "description_summary" field in the JSON search or feed response and in the <abstract> field in NITF stories.

{// Example:
"description_summary": "U.S. industrial production jumped a solid 0.9 percent in October. Factory activity recovered from the previous months' shuttering of assembly lines by Hurricanes Harvey and Irma. The Federal Reserve says that manufacturing activity surged 1.3 percent last month. Many of the gains came from a sharp increase in the production of chemical and petroleum and coal products. Motor vehicles and metals also posted decent gains."}
- <nitf version="-//IPTC//DTD NITF 3.4//EN" change.date="October 18, 2006" change.time="19:30">
  + <head>
  - <body>
    - <body.head>
          ...
       + <dateline>
         <abstract>U.S. industrial production jumped a solid 0.9 percent in October. Factory activity recovered from the previous months' shuttering of assembly lines by Hurricanes Harvey and Irma. The Federal Reserve says that manufacturing activity surged 1.3 percent last month. Many of the gains came from a sharp increase in the production of chemical and petroleum and coal products. Motor vehicles and metals also posted decent gains.</abstract>
        </body.head>
           ...

What is the difference between S-wire and Z-wire tables?

Depending on the format required by your Content Management System (CMS), you may be using either S-wire or Z-wire ANPA sports content. Most AP members work with the S-wire content. The difference between the S-wire and Z-wire ANPA content is in the agate (table) formatting -- to separate tabular data, S-wire uses tabs, while Z-wire uses semicolons.

Example: S-wire (tab-delimited tabular data)

S-wire data sample

Example: Z-wire (semicolon-delimited tabular data)

Z-wire data sample

For detailed examples of tabular data, see "Agate/Tabular Formatted Stories" in the AP WebFeeds ANPA Delivery Reference Guide (note that AP Media API delivers ANPA stories in the same format as AP WebFeeds).

What are photo banners that I am receiving?

See Picture Notification Banners.

What are access modes, and which modes does the AP Media API support?

You can access each of the available AP Media API versions in one or more of these modes: live, preview and sandbox (see Access Modes).

For agent users, only the live and preview modes are available, and it is recommended not to change the default mode and version. See What is Access Mode and Version? in the AP Media Agent and Portal FAQs.