Skip to content
/
List integration actions

Hyfn Public API (1.0.0)

Public REST API for managing your AI workforce programmatically. Create and manage AI agents, knowledge sources, scheduled jobs, track billable work tasks, and access invoices.

⚠️ SECURITY WARNING: This API is currently in development and uses a system-wide API key. Do not use in production without implementing per-organization API keys. See documentation for details.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://hyfn.ai/support

E-mail

support@hyfn.ai

License

MIT

Languages
Servers
Mock server

https://hyfn.redocly.app/_mock/openapi/

Production server

https://your-domain.replit.app/api/public/

Local development server

http://localhost:5000/api/public/

Agents

Manage AI agents

Operations

Knowledge

Manage knowledge sources and documents

Operations

Jobs

Manage scheduled AI jobs

Operations

Work Items

Track billable AI work tasks

Operations

Invoices

Access invoices and billing information (read-only)

Operations

Skills

Browse and execute integration actions from connected tools

Operations

List connected integrations

Request

Returns a list of all integrations (skills) connected to your organization. These are third-party tools like Notion, Slack, Salesforce, etc. that your AI agents can interact with.

Security
ApiKeyAuth and OrgIdAuth
curl -i -X GET \
  https://hyfn.redocly.app/_mock/openapi/skills \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-org-id: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
skillsArray of objects(Skill)
Response
application/json
{
  "skills": [
    { … },
    { … }
  ]
}

List integration actions

Request

Returns all available actions for a specific integration. Actions are capabilities like "Create Page" in Notion or "Send Message" in Slack.

Security
ApiKeyAuth and OrgIdAuth
Path
integrationstringrequired

Integration identifier (e.g., notion, slack, salesforce)

Example: notion
curl -i -X GET \
  https://hyfn.redocly.app/_mock/openapi/skills/notion/actions \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-org-id: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
actionsArray of objects(IntegrationAction)
Response
application/json
{
  "actions": [
    { … },
    { … },
    { … }
  ]
}

Execute integration action

Request

Executes a specific action for an integration with the provided parameters. For example, create a Notion page or send a Slack message.

Security
ApiKeyAuth and OrgIdAuth
Path
integrationstringrequired

Integration identifier (e.g., notion, slack, salesforce)

Example: notion
actionstringrequired

Action identifier for the integration

Example: NOTION_CREATE_PAGE
Bodyapplication/jsonrequired
parametersobject

Parameters to pass to the action

Example: {"parent":{"database_id":"abc123"},"properties":{"Name":{"title":[{"text":{"content":"My New Page"}}]}}}
curl -i -X POST \
  https://hyfn.redocly.app/_mock/openapi/skills/notion/actions/NOTION_CREATE_PAGE/execute \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-org-id: YOUR_API_KEY_HERE' \
  -d '{
    "parameters": {
      "parent": {
        "database_id": "abc123def456"
      },
      "properties": {
        "Name": {
          "title": [
            {
              "text": {
                "content": "New Project"
              }
            }
          ]
        },
        "Status": {
          "select": {
            "name": "In Progress"
          }
        },
        "Priority": {
          "select": {
            "name": "High"
          }
        }
      }
    }
  }'

Responses

Success

Bodyapplication/json
resultobject

The result returned by the integration action

Response
application/json
{
  "result": {
    "object": "page",
    "id": "page_abc123",
    "created_time": "2025-01-20T15:30:00.000Z",
    "last_edited_time": "2025-01-20T15:30:00.000Z",
    "properties": { … }
  }
}