APIs

This page contains information related to using existing agency APIs with AI Personal Assistants so that the technical POCs for each company can assist with this specific issue.

Several of the pilot concepts involve using AI Personal Assistants to interact with existing agency Application Programming Interfaces (APIs). This makes "wrapping" an existing API with the AI Personal Assistant one of the critical use cases for the pilot, and useful to have a specific page on it for ease of access during the pilot. (Yes we are aware that "APIs through IPAs" is going to be confusing!)

Info Learned at 5/17/2017 Pilot Workshop:

• thing 1
• thing 2

Representative User Story

As: an API owner

I want to: make my existing APIs available through AI Personal Assistants

So that: the Public can interact with my existing public API through new channels

Questions and Answers

• Q: What is the best path to expose an existing REST API on each AI Personal Assistant?

  • A:

• Q: Are there technical limitations on the type of API that can be exposed on each AI Personal Assistant? (e.g. REST, SOAP/XML)

  • A:

List of APIs in Pilot

The following pilot concepts include existing APIs that need to be exposed through this project:

AIDS.gov

• https://locator.hiv.gov/data-how-to.html

HUD

• numerous APIs available via the website egis.hud.gov

DOL

• http://developer.dol.gov/
• https://www.careeronestop.org/Developers/WebAPI/web-api.aspx
• https://www.bls.gov/developers/
• https://www.onetcenter.org/dev_web.html
• https://services.onetcenter.org/
• https://www.careeronestop.org/developers/linktous/link-to-us.aspx

DOT

• https://one.nhtsa.gov/webapi/Default.aspx?Recalls/API/83
• https://www.cpsc.gov/Recalls/CPSC-Recalls-Application-Program-Interface-API-Information
• https://open.fda.gov/api/status/

National Library of Medicine

• https://medlineplus.gov/connect/service.html
• https://medlineplus.gov/webservices.html

NPS

• https://developer.nps.gov/api/index.htm

NOAA

• https://forecast-v3.weather.gov/documentation

Recreation.gov

• http://usda.github.io/RIDB/

DoS

• https://cadataapi.state.gov
• https://cadatacatalog.state.gov/dataset
• https://catalog.data.gov/dataset?q=&sort=metadata_modified+desc&publisher=U.S.+Department+of+State&ext_location=&ext_bbox=&ext_prev_extent=-142.03125%2C8.754794702435605%2C-59.0625%2C61.77312286453148

USAGov

• https://platform-api.usa.gov/
• https://github.com/usagov/USAGov-Platform-API-Documentation/wiki

API-Related Technical Links for Each AI Personal Assistant

(In this section, technical POCs for the AI Personal Assistants can share the best technical links related to this use case.)

AI Personal Assistant #1

• link to reference docs

AI Personal Assistant #2

• link to reference docs

API Design Recommendations for use with AI Personal Assistants

(These recommendations can be included or referenced in agency API standards or design guidelines).

• recommendation 1
• recommendation 2