Skip to content

Add API Integrations

Got an API you’d love to see in the Open Agentic Knowledge (OAK) repository? If you can point us to its OpenAPI specification, you’re only one GitHub issue away from having it live in OAK.

Important: Please use the GitHub issue template named “Import OpenAPI to Jentic OAK” for all new API integration requests.

This template captures every detail our automation and reviewers need. While Discord is great for questions, GitHub issues are the official intake channel for new integrations.

How to Request a New API Integration

  1. Open a New Issue on GitHub

    • Navigate to the Jentic OAK Issues page.
    • Click the “New issue” button.
    • Select the “Import OpenAPI to Jentic OAK” issue template.

  2. Complete the Issue Template Provide the following details:

    • OpenAPI Specification URL: A direct raw link to the YAML/JSON file. Alternatively, you can attach the file to the issue.
    • Vendor_name: e.g., “apisetu.gov.in/asrb”.
    • Additional Information (optional): Any additional information that might help reviewers.

    Example of a Completed Template

    ## OpenAPI Specification URL
import_oas_url: https://api.apis.guru/v2/specs/apisetu.gov.in/asrb/3.0.0/openapi.json

## Vendor Name (Required)
vendor_name: apisetu.gov.in/asrb

## Additional Information

  3. Submit and Track

    • After you click “Submit new issue”, automated bots will assign labels.
    • A maintainer will review the submission and verify the specification.

  4. Import and Publication Process

    • The provided OpenAPI specification is validated and copied into the OAK repository (typically under apis/<provider>/<api>/<version>/openapi.yaml).
    • Continuous Integration (CI) processes will run format and lint checks. An automated Pull Request (PR) may be opened if minor fixes are needed.
    • Once merged, the API becomes searchable and runnable within the OAK ecosystem.

  5. (Optional) Create Agent Workflows

    • After the API is successfully integrated, you can request higher-level agent workflows using the separate “Generate Arazzo Specification for Jentic OpenAPI” issue template.
    • Learn more at Create Agent Workflows.

Frequently Asked Questions (FAQ)

Do I need to understand Arazzo to request an API integration or a subsequent workflow?

No. For API integration requests, you only need to provide the OpenAPI specification. Similarly, when you later request a multi-step agentic workflow using our Create Agent Workflows process, you do not need to understand the Arazzo specification language. You will describe the desired workflow steps in plain English, and our automated tooling will handle the generation of the Arazzo specification.

What if I don't have an OpenAPI specification for my API?

While an existing OpenAPI specification (v3.0+) is the fastest way to integrate an API, we understand that not all APIs have one readily available. If you don't have a spec, you can still raise an issue using the "Import OpenAPI to Jentic OAK" template. In the "OpenAPI spec URL" field, please state that a spec is not available and provide a link to the API's developer documentation.

Our team can then assess the effort required to create a spec. You might also explore online tools that can help generate an OpenAPI specification from other formats (like Postman collections) or assist in creating one from scratch. If you need guidance on this or want to discuss your specific API, please feel free to join our Discord server and ask for assistance.

Can I request an API that requires specific authentication methods (e.g., OAuth 2.0 with specific grant types)?

Yes. The OpenAPI specification should ideally define the security schemes for the API. When you fill out the issue template, please provide as much detail as possible about the authentication method in the "Auth method" field and any relevant "Notes". This helps us ensure the API is correctly configured for use within OAK.

Additional Support

If you have questions or need guidance, feel free to ask in the Discord server. Our community and maintainers are happy to help!

➡️ Ready to add an API? Open the “Import OpenAPI to Jentic OAK” issue template