Skip to content
/
Get invoice with line ite...

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

List invoices

Request

Returns a list of all invoices for your organization (read-only).

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

Responses

Success

Bodyapplication/json
invoicesArray of objects(Invoice)
Response
application/json
{
  "invoices": [
    { … }
  ]
}

Get invoice with line items

Request

Returns details of a specific invoice including all line items.

Security
ApiKeyAuth and OrgIdAuth
Path
invoiceIdstring(uuid)required

Unique identifier for the invoice

Example: d4c124bb-f2fd-4117-b1ec-e3021e4fa6c8
curl -i -X GET \
  https://hyfn.redocly.app/_mock/openapi/invoices/d4c124bb-f2fd-4117-b1ec-e3021e4fa6c8 \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-org-id: YOUR_API_KEY_HERE'

Responses

Success

Bodyapplication/json
invoiceobject(Invoice)
lineItemsArray of objects(InvoiceLineItem)
Response
application/json
{
  "invoice": {
    "id": "d4c124bb-f2fd-4117-b1ec-e3021e4fa6c8",
    "orgId": "demo-org-123",
    "amount": "25.00",
    "currency": "usd",
    "status": "pending",
    "stripeInvoiceId": "inv_abc123",
    "stripeInvoiceUrl": "https://invoice.stripe.com/i/acct_abc/test_xyz",
    "periodStart": "2025-01-01T00:00:00Z",
    "periodEnd": "2025-01-31T23:59:59Z",
    "paidAt": null,
    "createdAt": "2025-02-01T00:00:00Z",
    "updatedAt": "2025-02-01T00:00:00Z"
  },
  "lineItems": [
    { … }
  ]
}

Skills

Browse and execute integration actions from connected tools

Operations