API Deliverables And Integration

Iricity delivers AI-generated outputs through authenticated API requests. Each successful execution consumes usage units from the customer account allocation.

Primary Workflows

Authentication

API access is account-scoped. Requests are authenticated with a customer token issued after registration. Billing and usage allocation are linked to the authenticated account.

Example Execution Pattern

Typical flow for one AI task execution:

  1. Client submits job payload to a service endpoint.
  2. Platform checks account balance for required usage units.
  3. If available, job executes and units are debited.
  4. Response returns the generated digital output and execution metadata.

Illustrative API Request

POST /v1/services/landing-copy/run
Authorization: Bearer <account_token>
Content-Type: application/json

{
  "product_name": "SaaS Analytics Platform",
  "target_audience": "B2B growth teams",
  "tone": "professional"
}

Illustrative API Response

{
  "status": "completed",
  "service": "landing-copy",
  "units_debited": 24,
  "output": {
    "headline": "Turn Analytics Into Action",
    "body": "Track conversion signals and optimize faster.",
    "cta": "Start Free Trial"
  }
}
Commercial definition:

Customers purchase usage allocations for API task execution (see Pricing). These allocations are usage units only, non-transferable, and not redeemable for cash.

Hands-on execution is available in the Workspace.