Skip to content

Create Agent Workflows from Existing APIs

Open Agentic Knowledge (OAK) doesn't just manage single API calls; it also powers agent workflows. These are deterministic, multi-step sequences that agents can follow to achieve specific goals.

Workflows in OAK are described using Arazzo, an open standard developed under the OpenAPI Initiative and the Linux Foundation. This allows any compatible tool or AI agent to reliably execute these pre-defined workflows.

Important: To request a new workflow, please use the GitHub issue template named "Generate Arazzo Specification for Jentic OpenAPI".

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.

Prerequisites for Requesting a Workflow

Before submitting a workflow request, please ensure the following:

  • The core API(s) needed for the workflow must already be integrated into OAK. (If not, please first submit a request via Add API Integrations).
  • You have a clear, repeatable sequence of operations in mind (e.g., "1. Translate text using DeepL. 2. Send the translated text via a SendGrid email.").

How to Request a New Agent Workflow

1. Open a New Issue on GitHub

  • Navigate to the Jentic OAK Issues page.
  • Click the "New issue" button.
  • Select the "Generate Arazzo Specification for Jentic OpenAPI" issue template.

2. Fill Out the Template

OpenAPI Specification URL (required)

Paste the RAW URL to the spec file that is already in OAK.

✅ https://raw.githubusercontent.com/jentic/oak/refs/heads/main/apis/openapi/vendor.com/api/version/openapi.json
❌ https://github.com/jentic/oak/blob/main/apis/openapi/vendor.com/api/version/openapi.json

Why RAW? The generator fetches the JSON/YAML directly. Links to GitHub's web UI won't work.

Request Workflow Descriptions

Describe the workflows you want, one bullet per workflow. If you leave this section blank, the generator will try to auto-discover common patterns.

Additional Information (optional)

Any additional information that might help reviewers..

Examples of Workflow Descriptions:
- Create a new user and assign them a role
- Authenticate a user and fetch their profile
- Submit an order and retrieve order status

Tip: Plain English descriptions are fine, the maintainer or bot will map them to specific endpoints.

Example of a Completed Template

### OpenAPI Specification URL
openapi_url: https://raw.githubusercontent.com/jentic/oak/refs/heads/main/apis/openapi/linqr.app/main/2.0/openapi.json

### Additional Information

### Request Workflow Descriptions
#### Workflow Descriptions (Optional)
- Generate and email a custom QR code
- Create a Wifi QR code and display on a web page
- Batch generate QR codes and archive them

3. What Happens Next?

  • We process this, and create an Arazzo file using your bullet points.
  • Maintainers will review
  • The workflow file(s) land in workflows/<provider>/<api>/... and your issue is closed with links.
  • Test & iterate: run with oak-runner run <workflow>. If tweaks are needed, reply in the issue or open a follow-up.

Need Help?

Additional Support

If you have questions about defining your workflow or using the issue template, please ask in the Discord server. Our community and maintainers are happy to assist!

➡️ Ready to request a workflow? Go to the new issue page and select the "Generate Arazzo Specification for Jentic OpenAPI" template.