Associated Press
App · 16 actions
Bring Associated Press wire stories, photos, graphics, video and audio into your workflows: search and read AP content, follow your feed and saved searches, get a story's text, download files, and check your plan, downloads and feed monitors.
Actions
| Action | What it does |
|---|---|
| Create monitor | Create a feed monitor that emails up to 5 people when a feed it watches stops being read, or has many errors. |
| Delete monitor | Delete a feed monitor so it stops checking and alerting. |
| Download file | Download one of an item's files (the full-resolution photo or video, a preview, a thumbnail, or its text) and keep it as a file later steps can attach or upload. |
| Get feed | Get a page of incoming AP content, oldest first, for all of your plan or the products, media types, saved search or words chosen. |
| Get item | Get one AP item with its headline, caption, bylines, subjects, usage terms and the files you can download. |
| Get monitor | Get one feed monitor's settings. |
| Get On-Demand items | Get items your editors sent to an On-Demand queue in AP Newsroom, in the order they were sent. |
| Get request limits | Get how many requests your AP key may make a minute or a day, for each kind of request. |
| Get story text | Get the full text of an AP story as plain paragraphs (for a photo, graphic or video, its caption). |
| List downloads | List what you or your AP salesperson downloaded, with who, when and the charge. |
| List monitor alerts | List the alerts your feed monitors sent recently, newest first. |
| List monitors | List your feed monitors: the checks that email you when a feed stops being read or has many errors. |
| List plans | List your AP plans with how much of each you've used this billing cycle and the products and packages each includes. |
| List saved searches | List your AP Newsroom saved searches that have a feed, with the id the feed steps and triggers use. |
| Search content | Search AP stories, photos, graphics, video and audio your plan includes: the last 30 days of news and AP's photo, video and graphics archive. |
| Update monitor | Replace a feed monitor's settings with the ones given: who it alerts and what it watches for. |
Create monitor
Create a feed monitor that emails up to 5 people when a feed it watches stops being read, or has many errors.
Inputs
- Name
nametextRequired - The monitor's name: up to 20 letters, digits, '.', '_' or '-', with no spaces.
- Alert emails
emailslistRequired - Up to 5 email addresses to alert.
- Alert when the feed is idle for
idle_timetext - Alert when the watched feed stops being read for this long. Defaults to 15 minutes.One of:
off(Don't watch for an idle feed),PT2M(2 minutes),PT5M(5 minutes),PT10M(10 minutes),PT15M(15 minutes),PT30M(30 minutes),PT1H(1 hour),PT2H(2 hours),PT4H(4 hours),PT8H(8 hours),PT12H(12 hours). Default:PT15M. - Alert on many errors
quality_alertstrue/false - Also alert when the feed has many errors within five minutes.Default:
false. - Repeat the alert
repeat_alertstext - How often to send the alert again while the problem lasts.One of:
0(Never),PT10M(Every 10 minutes),PT30M(Every 30 minutes),PT1H(Every hour),PT2H(Every 2 hours),PT6H(Every 6 hours),PT12H(Every 12 hours),PT24H(Every 24 hours). - Description
descriptiontext - A short note on what the monitor is for.
- Troubleshooting steps
troubleshootingtext - What to do when the alert comes, included in it.
Outputs
nametext- The monitor's name
resultobject- AP's answer, as AP gave it
Example output
{
"name": "lodol_feed",
"result": {
"monitor": {
"conditions": [
{
"criteria": {
"idleTime": "PT15M"
},
"enabled": true,
"type": "idleFeed"
}
],
"description": "Watch the newsdesk feed.",
"name": "lodol_feed",
"notify": [
{
"channelDestinations": [
"newsdesk@example.com"
],
"channelType": "email"
}
],
"playbook": "Check the workflow is turned on.",
"repeatAlerts": "PT2H"
}
}
}Delete monitor
Delete a feed monitor so it stops checking and alerting.
Inputs
- Monitor
monitortextRequired - The monitor. Pick one, or give its name.
Outputs
deletedtrue/false- True once deleted
nametext- The monitor deleted
resultobject- AP's answer, as AP gave it
Example output
{
"deleted": true,
"name": "lodol_feed",
"result": {}
}Download file
Download one of an item's files (the full-resolution photo or video, a preview, a thumbnail, or its text) and keep it as a file later steps can attach or upload. Files that cost extra download only with 'Accept the charge' on.
Inputs
- Item ID
item_idtextRequired - The item's id (32 letters and digits): the item_id a search or feed step returns. An item's AP link works too.
- File
renditiontext - Which file. Previews and thumbnails never cost extra. Defaults to full resolution.One of:
main(Full resolution (main)),preview,thumbnail,story(Story text (NITF)),caption(Caption (NITF)),script(Video script and shot list (NITF)). Default:main. - Accept the charge
accept_chargetrue/false - Download even if AP charges for this file (money or credits on your plan). Off, a priced file is not downloaded and the step says what it would cost.Default:
false.
Outputs
content_typetext- The file's type
download_urltext- Where AP sent the file from; it expires soon
fileobject- The file, kept for later steps
file_nametext- The file's name
headlinetext- Its headline
item_idtext- The item
pricetagtext- What AP charged: Unlimited, MeterTick:1, USD:15.00
renditiontext- The file's name in AP's list, such as main
Example output
{
"content_type": "image/jpeg",
"download_url": "https://mapi.associatedpress.com/v1/items/0726a2a7a06b48d0af1e41bf04fe8f80/preview/preview.jpg",
"file": {
"content_type": "image/jpeg",
"document_ref": "doc_4b1c9e2a7d3f",
"filename": "0726a2a7a06b48d0af1e41bf04fe8f80-preview.jpg",
"size_bytes": 48211,
"url": "/actions/core/serve-document/doc_4b1c9e2a7d3f?teamId=64b0000000000000000000aa"
},
"file_name": "0726a2a7a06b48d0af1e41bf04fe8f80-preview.jpg",
"headline": "Southern Storms",
"item_id": "0726a2a7a06b48d0af1e41bf04fe8f80",
"pricetag": "",
"rendition": "preview"
}Get feed
Get a page of incoming AP content, oldest first, for all of your plan or the products, media types, saved search or words chosen. Give the next page link it returns to get only what came in since. A feed with search words starts empty and fills as news arrives.
Inputs
- Search words
querytext - Words to look for, in AP's search syntax: quotes for a phrase, AND, OR and NOT in capitals, or a field such as headline:storm. Example: "climate change" AND type:text.
- Media types
media_typeslist - Only these kinds of content. Leave empty for all of them.One or more of:
text(Stories (text)),picture(Photos),graphic(Graphics),video,audio. - AP products
product_idslist - Only content from these products or packages of your AP plan. Leave empty for everything your plan includes.
- Saved search
followed_topic_idtext - Only content matching one of your AP Newsroom saved searches that has a feed.
- How many
page_sizenumber - How many items to return, 1 to 100. AP's default is 10.From 1 to 100.
- Only what my plan includes
in_my_plantrue/false - Leave out items (and linked photos or videos) that cost extra.Default:
false. - Next page link
next_pagetext - The next_page link from an earlier run of this step. When given, the other filters are already in it and are ignored.
Outputs
countnumber- How many items on this page
itemslist- The items, each with its item_id
next_pagetext- Link to the next page: give it as 'Next page link' to get what came in since
querytext- The query AP ran
updatedtext- When AP answered (UTC)
Example output
{
"count": 1,
"items": [
{
"altids": {
"etag": "0726a2a7a06b48d0af1e41bf04fe8f80_0a1aza0c0",
"friendlykey": "24113461783915",
"itemid": "0726a2a7a06b48d0af1e41bf04fe8f80"
},
"associations": {},
"bylines": [
{
"by": "Jo Bloggs",
"title": "Staff"
}
],
"copyrightnotice": "Copyright 2026 The Associated Press. All rights reserved.",
"description_caption": "Storm clouds gather over Tupelo, Miss., on Nov. 16, 2026.",
"description_creditline": "AP",
"description_summary": "",
"ednote": "",
"embargoed": "",
"firstcreated": "2026-11-16T21:40:11Z",
"headline": "Southern Storms",
"item_id": "0726a2a7a06b48d0af1e41bf04fe8f80",
"keywords": [
"storms",
"weather"
],
"language": "en",
"located": "Tupelo, Miss.",
"meta": {
"products": [
{
"id": 31989,
"name": "AP Online Top General Headlines"
}
]
},
"person": [],
"place": [],
"profile": "Spot Development",
"pubstatus": "usable",
"renditions": {
"caption_nitf": {
"fileextension": "xml",
"format": "IIM",
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?type=text&format=nitf&text=caption",
"mimetype": "text/xml",
"rel": "Caption",
"title": "NITF Caption Download",
"type": "text"
},
"main": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 3648,
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?role=main",
"mimetype": "image/jpeg",
"pricetag": "Unlimited",
"rel": "Main",
"title": "Full Resolution (JPG)",
"type": "picture",
"width": 5472
},
"preview": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 341,
"href": "https://mapi.associatedpress.com/v1/items/0726a2a7a06b48d0af1e41bf04fe8f80/preview/preview.jpg",
"mimetype": "image/jpeg",
"rel": "Preview",
"title": "Preview (JPG)",
"type": "picture",
"width": 512
}
},
"slugline": "Southern Storms",
"subject": [
{
"code": "f25af2d07e4e100484f5df092526b43e",
"name": "General news",
"rels": [
"direct"
]
}
],
"title": "Southern Storms",
"type": "picture",
"urgency": 3,
"uri": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80",
"usageterms": [],
"version": 0,
"versioncreated": "2026-11-16T21:43:02Z"
}
],
"next_page": "https://api.ap.org/media/v/content/feed?qt=sym86viZrF&seq=64292965",
"query": "productid:31989",
"updated": "2026-11-16T21:45:00.421Z"
}Get item
Get one AP item with its headline, caption, bylines, subjects, usage terms and the files you can download.
Inputs
- Item ID
item_idtextRequired - The item's id (32 letters and digits): the item_id a search or feed step returns. An item's AP link works too.
- Include prices
include_pricingtrue/false - Add each item's full price, use code and pricing message.Default:
false. - Only what my plan includes
in_my_plantrue/false - Leave out items (and linked photos or videos) that cost extra.Default:
false.
Outputs
itemobject- The item
Example output
{
"item": {
"altids": {
"etag": "0726a2a7a06b48d0af1e41bf04fe8f80_0a1aza0c0",
"friendlykey": "24113461783915",
"itemid": "0726a2a7a06b48d0af1e41bf04fe8f80"
},
"associations": {},
"bylines": [
{
"by": "Jo Bloggs",
"title": "Staff"
}
],
"copyrightnotice": "Copyright 2026 The Associated Press. All rights reserved.",
"description_caption": "Storm clouds gather over Tupelo, Miss., on Nov. 16, 2026.",
"description_creditline": "AP",
"description_summary": "",
"ednote": "",
"embargoed": "",
"firstcreated": "2026-11-16T21:40:11Z",
"headline": "Southern Storms",
"item_id": "0726a2a7a06b48d0af1e41bf04fe8f80",
"keywords": [
"storms",
"weather"
],
"language": "en",
"located": "Tupelo, Miss.",
"meta": {
"products": [
{
"id": 31989,
"name": "AP Online Top General Headlines"
}
]
},
"person": [],
"place": [],
"profile": "Spot Development",
"pubstatus": "usable",
"renditions": {
"caption_nitf": {
"fileextension": "xml",
"format": "IIM",
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?type=text&format=nitf&text=caption",
"mimetype": "text/xml",
"rel": "Caption",
"title": "NITF Caption Download",
"type": "text"
},
"main": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 3648,
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?role=main",
"mimetype": "image/jpeg",
"pricetag": "Unlimited",
"rel": "Main",
"title": "Full Resolution (JPG)",
"type": "picture",
"width": 5472
},
"preview": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 341,
"href": "https://mapi.associatedpress.com/v1/items/0726a2a7a06b48d0af1e41bf04fe8f80/preview/preview.jpg",
"mimetype": "image/jpeg",
"rel": "Preview",
"title": "Preview (JPG)",
"type": "picture",
"width": 512
}
},
"slugline": "Southern Storms",
"subject": [
{
"code": "f25af2d07e4e100484f5df092526b43e",
"name": "General news",
"rels": [
"direct"
]
}
],
"title": "Southern Storms",
"type": "picture",
"urgency": 3,
"uri": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80",
"usageterms": [],
"version": 0,
"versioncreated": "2026-11-16T21:43:02Z"
}
}Get monitor
Get one feed monitor's settings.
Inputs
- Monitor
monitortextRequired - The monitor. Pick one, or give its name.
Outputs
nametext- The monitor's name
resultobject- AP's answer, as AP gave it
Example output
{
"name": "lodol_feed",
"result": {
"monitor": {
"conditions": [
{
"criteria": {
"idleTime": "PT15M"
},
"enabled": true,
"type": "idleFeed"
}
],
"description": "Watch the newsdesk feed.",
"name": "lodol_feed",
"notify": [
{
"channelDestinations": [
"newsdesk@example.com"
],
"channelType": "email"
}
],
"playbook": "Check the workflow is turned on.",
"repeatAlerts": "PT2H"
}
}
}Get On-Demand items
Get items your editors sent to an On-Demand queue in AP Newsroom, in the order they were sent. Each item comes back once per reader name, then leaves the queue for that name.
Inputs
- Queue ID
queue_idtext - The On-Demand queue, from AP Newsroom's configuration dashboard. Leave empty for your default queue.
- Reader name
consumer_nametext - A name for what reads the queue: each name gets every item once, so a different name doesn't take items from your newsroom system. Defaults to lodol.
- How many
page_sizenumber - How many items to return, 1 to 100. AP's default is 10.From 1 to 100.
Outputs
consumer_nametext- The reader name the items were read as
countnumber- How many items on this page
itemslist- The items, each with its item_id
updatedtext- When AP answered (UTC)
Example output
{
"consumer_name": "lodol",
"count": 1,
"items": [
{
"altids": {
"etag": "0726a2a7a06b48d0af1e41bf04fe8f80_0a1aza0c0",
"friendlykey": "24113461783915",
"itemid": "0726a2a7a06b48d0af1e41bf04fe8f80"
},
"associations": {},
"bylines": [
{
"by": "Jo Bloggs",
"title": "Staff"
}
],
"copyrightnotice": "Copyright 2026 The Associated Press. All rights reserved.",
"description_caption": "Storm clouds gather over Tupelo, Miss., on Nov. 16, 2026.",
"description_creditline": "AP",
"description_summary": "",
"ednote": "",
"embargoed": "",
"firstcreated": "2026-11-16T21:40:11Z",
"headline": "Southern Storms",
"item_id": "0726a2a7a06b48d0af1e41bf04fe8f80",
"keywords": [
"storms",
"weather"
],
"language": "en",
"located": "Tupelo, Miss.",
"meta": {
"products": [
{
"id": 31989,
"name": "AP Online Top General Headlines"
}
]
},
"person": [],
"place": [],
"profile": "Spot Development",
"pubstatus": "usable",
"renditions": {
"caption_nitf": {
"fileextension": "xml",
"format": "IIM",
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?type=text&format=nitf&text=caption",
"mimetype": "text/xml",
"rel": "Caption",
"title": "NITF Caption Download",
"type": "text"
},
"main": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 3648,
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?role=main",
"mimetype": "image/jpeg",
"pricetag": "Unlimited",
"rel": "Main",
"title": "Full Resolution (JPG)",
"type": "picture",
"width": 5472
},
"preview": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 341,
"href": "https://mapi.associatedpress.com/v1/items/0726a2a7a06b48d0af1e41bf04fe8f80/preview/preview.jpg",
"mimetype": "image/jpeg",
"rel": "Preview",
"title": "Preview (JPG)",
"type": "picture",
"width": 512
}
},
"slugline": "Southern Storms",
"subject": [
{
"code": "f25af2d07e4e100484f5df092526b43e",
"name": "General news",
"rels": [
"direct"
]
}
],
"title": "Southern Storms",
"type": "picture",
"urgency": 3,
"uri": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80",
"usageterms": [],
"version": 0,
"versioncreated": "2026-11-16T21:43:02Z"
}
],
"updated": "2026-11-16T21:45:00.421Z"
}Get request limits
Get how many requests your AP key may make a minute or a day, for each kind of request.
Inputs
None.
Outputs
accounttext- The account they apply to
countnumber- How many limits
quotaslist- The limits
updatedtext- When AP answered (UTC)
Example output
{
"account": "",
"count": 3,
"quotas": [
{
"limit": 10,
"method": "search",
"period": "PT1M",
"unlimited": false
},
{
"limit": 20,
"method": "feed",
"period": "PT1M",
"unlimited": false
},
{
"limit": 0,
"method": "other",
"period": "",
"unlimited": true
}
],
"updated": "2026-11-16T15:13:42.927Z"
}Get story text
Get the full text of an AP story as plain paragraphs (for a photo, graphic or video, its caption). AP counts this as a download.
Inputs
- Item ID
item_idtextRequired - The item's id (32 letters and digits): the item_id a search or feed step returns. An item's AP link works too.
Outputs
headlinetext- Its headline
item_idtext- The item
paragraphslist- The paragraphs
renditiontext- Which of its files the text came from
texttext- The text, paragraphs separated by blank lines
typetext- text, picture, graphic, audio or video
word_countnumber- How many words
Example output
{
"headline": "Damaging hail and tornadoes threatened for southeast US",
"item_id": "c116ac3656f240238ee7529720e4a4b8",
"paragraphs": [
"ATLANTA (AP) Severe storms are expected across the Southeast.",
"Forecasters warned of large hail."
],
"rendition": "nitf",
"text": "ATLANTA (AP) Severe storms are expected across the Southeast.\n\nForecasters warned of large hail.",
"type": "text",
"word_count": 15
}List downloads
List what you or your AP salesperson downloaded, with who, when and the charge. Covers up to 60 days at a time within the last year; the last 30 days unless dates are given.
Inputs
- From
min_datedate - Downloads on or after this date. Defaults to 30 days ago.
- To
max_datedate - Downloads on or before this date. Defaults to today.
- Order number
order_idtext - Only this order, its id from an earlier list. Its date must be in the range.
Outputs
countnumber- How many on this page
downloadslist- The downloads
max_datetext- The range's end
min_datetext- The range's start
total_itemsnumber- How many in the range
Example output
{
"count": 1,
"downloads": [
{
"charge": 10.0,
"currency": "USD",
"download_date": "2026-11-10T22:01:54Z",
"downloaded_by": "First Last",
"duplicate": false,
"id": 32800283,
"item": {
"friendlykey": "17003157050469",
"id": "https://api.ap.org/media/v/content/a342d7bd56394600b7594d5f395eb387",
"source": "Invision",
"title": "Palm Springs International Film Festival",
"type": "Picture"
}
}
],
"max_date": "2026-11-16",
"min_date": "2026-10-17",
"total_items": 1
}List monitor alerts
List the alerts your feed monitors sent recently, newest first.
Inputs
- Full details
show_detailtrue/false - Include each monitor's settings and latest alert in full.Default:
false.
Outputs
resultobject- AP's answer, as AP gave it
Example output
{
"result": {
"alerts": [
{
"condition": "idleFeed",
"last_alerted": "2026-11-16T03:15:00Z",
"monitor": "lodol_feed",
"status": "alarm"
}
]
}
}List monitors
List your feed monitors: the checks that email you when a feed stops being read or has many errors.
Inputs
None.
Outputs
monitorslist- The monitors found in it
resultobject- AP's answer, as AP gave it
Example output
{
"monitors": [
{
"conditions": [
{
"criteria": {
"idleTime": "PT15M"
},
"enabled": true,
"type": "idleFeed"
}
],
"description": "Watch the newsdesk feed.",
"name": "lodol_feed",
"notify": [
{
"channelDestinations": [
"newsdesk@example.com"
],
"channelType": "email"
}
],
"playbook": "Check the workflow is turned on.",
"repeatAlerts": "PT2H"
}
],
"result": {
"monitors": [
{
"conditions": [
{
"criteria": {
"idleTime": "PT15M"
},
"enabled": true,
"type": "idleFeed"
}
],
"description": "Watch the newsdesk feed.",
"name": "lodol_feed",
"notify": [
{
"channelDestinations": [
"newsdesk@example.com"
],
"channelType": "email"
}
],
"playbook": "Check the workflow is turned on.",
"repeatAlerts": "PT2H"
}
]
}
}List plans
List your AP plans with how much of each you've used this billing cycle and the products and packages each includes.
Inputs
None.
Outputs
countnumber- How many plans
planslist- The plans
updatedtext- When AP answered (UTC)
Example output
{
"count": 1,
"plans": [
{
"entitlements": [
{
"feed_link": "https://api.ap.org/media/v/content/feed?q=productid:31989",
"id": 31989,
"media_type": "Text",
"name": "AP Online Top General Headlines",
"overage_allowed": false,
"search_link": "https://api.ap.org/media/v/content/search?q=productid:31989",
"sub_type": "Full",
"type": "Product"
}
],
"id": 123,
"interval": "P1M",
"name": "Metered Plan",
"next_cycle_begins": "2026-12-01",
"plan_style": "downloads",
"updated": "2026-11-02T17:28:14.051Z",
"usage_limit": 100,
"used": 12
}
],
"updated": "2026-11-16T16:19:29.616Z"
}List saved searches
List your AP Newsroom saved searches that have a feed, with the id the feed steps and triggers use.
Inputs
None.
Outputs
countnumber- How many
followed_topicslist- The saved searches
updatedtext- When AP answered (UTC)
Example output
{
"count": 2,
"followed_topics": [
{
"id": "714005",
"name": "Italy Earthquake"
},
{
"id": "714006",
"name": "Soccer"
}
],
"updated": "2026-11-16T14:01:27.728Z"
}Search content
Search AP stories, photos, graphics, video and audio your plan includes: the last 30 days of news and AP's photo, video and graphics archive. Gets one page; run it again with the next page number for more.
Inputs
- Search words
querytext - Words to look for, in AP's search syntax: quotes for a phrase, AND, OR and NOT in capitals, or a field such as headline:storm. Example: "climate change" AND type:text.
- Media types
media_typeslist - Only these kinds of content. Leave empty for all of them.One or more of:
text(Stories (text)),picture(Photos),graphic(Graphics),video,audio. - Subjects
subjectslist - Only content about any of these subjects.One or more of:
c8e409f8858510048872ff2260dd383e(Business),8783d248894710048286ba0a2b2ca13e(Climate and environment),1af99ec3cb954ff4b349b32d60d0376d(Education),16cb0ba3e6d24d97ace39f5a1924669a(Entertainment),f25af2d07e4e100484f5df092526b43e(General news),a4677d70863b4012b846a1b00f5079f5(U.S. news),bb2d2c5f441a452cb24bb511a2ab5eea(World news),abfca78268874726966cdad8c35c4ae3(Washington news),cc7a76087e4e10048482df092526b43e(Health),3e37e4b87df7100483d5df092526b43e(Lifestyle), and 9 more. - AP products
product_idslist - Only content from these products or packages of your AP plan. Leave empty for everything your plan includes.
- Published on or after
from_datedate - Only content published on or after this date.
- Published on or before
to_datedate - Only content published on or before this date.
- Order
sorttext - Best match first, or by when it was published.One of:
_score:desc(Best match (default)),versioncreated:desc(Newest first),versioncreated:asc(Oldest first). Default:_score:desc. - How many
page_sizenumber - How many items to return, 1 to 100. AP's default is 10.From 1 to 100.
- Page
pagenumber - Which page of results, starting at 1.At least 1.
- Only what my plan includes
in_my_plantrue/false - Leave out items (and linked photos or videos) that cost extra.Default:
false. - Include prices
include_pricingtrue/false - Add each item's full price, use code and pricing message.Default:
false.
Outputs
countnumber- How many items on this page
feed_hreftext- On the last page, a feed link for new matches
itemslist- The items, each with its item_id
next_pagetext- Link to the next page, empty on the last
pagenumber- This page's number
querytext- The query AP ran
total_itemsnumber- How many items match in all
Example output
{
"count": 1,
"feed_href": "",
"items": [
{
"altids": {
"etag": "0726a2a7a06b48d0af1e41bf04fe8f80_0a1aza0c0",
"friendlykey": "24113461783915",
"itemid": "0726a2a7a06b48d0af1e41bf04fe8f80"
},
"associations": {},
"bylines": [
{
"by": "Jo Bloggs",
"title": "Staff"
}
],
"copyrightnotice": "Copyright 2026 The Associated Press. All rights reserved.",
"description_caption": "Storm clouds gather over Tupelo, Miss., on Nov. 16, 2026.",
"description_creditline": "AP",
"description_summary": "",
"ednote": "",
"embargoed": "",
"firstcreated": "2026-11-16T21:40:11Z",
"headline": "Southern Storms",
"item_id": "0726a2a7a06b48d0af1e41bf04fe8f80",
"keywords": [
"storms",
"weather"
],
"language": "en",
"located": "Tupelo, Miss.",
"meta": {
"products": [
{
"id": 31989,
"name": "AP Online Top General Headlines"
}
],
"score": 8.23
},
"person": [],
"place": [],
"profile": "Spot Development",
"pubstatus": "usable",
"renditions": {
"caption_nitf": {
"fileextension": "xml",
"format": "IIM",
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?type=text&format=nitf&text=caption",
"mimetype": "text/xml",
"rel": "Caption",
"title": "NITF Caption Download",
"type": "text"
},
"main": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 3648,
"href": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80/download?role=main",
"mimetype": "image/jpeg",
"pricetag": "Unlimited",
"rel": "Main",
"title": "Full Resolution (JPG)",
"type": "picture",
"width": 5472
},
"preview": {
"fileextension": "jpg",
"format": "JPEG Baseline",
"height": 341,
"href": "https://mapi.associatedpress.com/v1/items/0726a2a7a06b48d0af1e41bf04fe8f80/preview/preview.jpg",
"mimetype": "image/jpeg",
"rel": "Preview",
"title": "Preview (JPG)",
"type": "picture",
"width": 512
}
},
"slugline": "Southern Storms",
"subject": [
{
"code": "f25af2d07e4e100484f5df092526b43e",
"name": "General news",
"rels": [
"direct"
]
}
],
"title": "Southern Storms",
"type": "picture",
"urgency": 3,
"uri": "https://api.ap.org/media/v/content/0726a2a7a06b48d0af1e41bf04fe8f80",
"usageterms": [],
"version": 0,
"versioncreated": "2026-11-16T21:43:02Z"
}
],
"next_page": "",
"page": 1,
"query": "type:picture AND subject:f25af2d07e4e100484f5df092526b43e",
"total_items": 1
}Update monitor
Replace a feed monitor's settings with the ones given: who it alerts and what it watches for.
Inputs
- Monitor
monitortextRequired - The monitor. Pick one, or give its name.
- Alert emails
emailslistRequired - Up to 5 email addresses to alert.
- Alert when the feed is idle for
idle_timetext - Alert when the watched feed stops being read for this long. Defaults to 15 minutes.One of:
off(Don't watch for an idle feed),PT2M(2 minutes),PT5M(5 minutes),PT10M(10 minutes),PT15M(15 minutes),PT30M(30 minutes),PT1H(1 hour),PT2H(2 hours),PT4H(4 hours),PT8H(8 hours),PT12H(12 hours). Default:PT15M. - Alert on many errors
quality_alertstrue/false - Also alert when the feed has many errors within five minutes.Default:
false. - Repeat the alert
repeat_alertstext - How often to send the alert again while the problem lasts.One of:
0(Never),PT10M(Every 10 minutes),PT30M(Every 30 minutes),PT1H(Every hour),PT2H(Every 2 hours),PT6H(Every 6 hours),PT12H(Every 12 hours),PT24H(Every 24 hours). - Description
descriptiontext - A short note on what the monitor is for.
- Troubleshooting steps
troubleshootingtext - What to do when the alert comes, included in it.
Outputs
nametext- The monitor's name
resultobject- AP's answer, as AP gave it
Example output
{
"name": "lodol_feed",
"result": {
"monitor": {
"conditions": [
{
"criteria": {
"idleTime": "PT15M"
},
"enabled": true,
"type": "idleFeed"
}
],
"description": "Watch the newsdesk feed.",
"name": "lodol_feed",
"notify": [
{
"channelDestinations": [
"newsdesk@example.com"
],
"channelType": "email"
}
],
"playbook": "Check the workflow is turned on.",
"repeatAlerts": "PT2H"
}
}
}