An AI tool for generating working integrations from API documentation.
Try it out now at superface.ai/edgar
EDGAR reads and analyzes API documentation so you don't have to. Then, based on your plain english input, EDGAR builds the API integration to be used via Superface OneService. For example, you no longer need to understand how to send emails with SendGrid that also include click tracking, you can ask EDGAR and the code for exactly that implementation will be provided to you.
This repository is the datasource of APIs for EDGAR.
→ Add API
→ Check available APIs
→ Provide feedback
You can add an API to EDGAR by opening a new pull request with the API documentation. Upon review and merging, EDGAR will index the documentation and once ready, it will become available at superface.ai/edgar
The format for the API documentation is a plain text file. Markdown is welcome but not required.
When formating the API documentation, it is important to use the separator. Documentation consists of various topics, divided by pages or headings. These includes authentication, rate limiting, general instructions, API operations (often grouped by resources), and others. When submitting the API docs, use the the separator to split these topics up and help EDGAR distinguish between them.
The separator is a sequence of equal signs (===========) terminated by a newline. At minimum use 5 equal (=) characters to form a separator. The API docs ready for EDGAR might look something like the following:
# Welcome to our docs
(...)
================================
# API Basics
(...)
================================
# Authorizing Requests
(...)
================================
# /todos/:id/items
This endpoint lists all items (...)
================================
(...)
Still not sure? Check existing APIs for more examples.
You can submit your API documentation as a single text .txt file in docs directory.
Opened pull request are usually reviewed in few hours. In the meantime, consider starring this repo so that you don't miss new developments.
If you don't want to submit an API docs on your own, feel free to suggest a new API and we will add it for you!