How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zinnia Illustration Engine API

API Endpoints for use by the internal illustration engines

Zinnia Illustration Engine API is one of 42 APIs that Zinnia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Illustration Engine. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 30 schemas. It is described by OpenAPI 3.2.0, at version 3.5.3.

Requests are made against a single base URL, https://dev.api.zinnia.io.

4 operations 4 paths 30 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.5.3
Base URL
https://qa.api.zinnia.io
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Zinnia Illustration Engine API declares 1 security scheme for authenticating requests. It supports OpenID Connect (Auth0) discovered at https://login.dev.zinnia.com/.well-known/openid-configuration.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Illustration Engine 4

API Endpoints for use by the internal illustration engines

POST
/illustration/v3/illustration-request
Create an illustration
create-illustration 1 param body → 201400500
GET
/illustration/v3/illustration-request/{id}
Get a specific illustration
get-illustration 2 params → 200202400404
GET
/illustration/v3/illustration-request/{id}/results/{format}
Get a specific illustration result
get-illustration-result 2 params → 200404415500
POST
/illustration/v3/illustration
Illustration for immediate processing
illustration-for-immediate-processing body → 200400500

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Policy-State (13 properties), Arrangement (10 properties), Calculation-Illustration (5 properties), Account-Value (4 properties). Each schema is shown below with its type and property counts.

Financial-Activity
object
1 property 1 required
Arrangement
object
Describes an arbitrary agreement
10 properties
Arrangements
array
An unkeyed collection of arrangement objects
Message
object
A structured signal
4 properties 2 required
Coverage-Collection
array
A collection of benefits
Policy-State
object
Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.
13 properties 13 required
Output-Status
object
2 properties
Schedule
object
Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and B…
3 properties 1 required
Fund-Collection
array
An unkeyed collection of funds
Basic-Collection
object
A simple object that only contains a collection of unique attributes and no further structure.
1 property 1 required
Participant-Collection
array
An unkeyed collection of unique participant objects
Arrangement-Type
string
Enumeration of allowable arrangement types
Variable-Value
the value of a variable, may be constant or time-dependent
Arrangement-Source
object
A source of funding for an arrangement
2 properties 2 required
Result
array
The output from a cmputation, which may vary with time
Fund
object
A source of money
2 properties 2 required
Account-Value
object
A description of the monetary value of an investment contract
4 properties 4 required
Multiple-Scenario-Results
object
A grouping of uniquely identifiable scenarios containing their results
Attribute-Collection
object
A collection of uniquely named variables, must be camel-cased.
1 property
Output-Format
string
identifier for an output format
Coverage
object
A benefit conferred to a group of one or more participants
3 properties 3 required
Active-Segment
object
A segment of a source of money that has some form of financial activity
2 properties 1 required
Scheduled-Entry
object
Represents a limited time period for which a value is constant.
3 properties 3 required
Party
object
A unique entity
4 properties 4 required
Calculation-Illustration
object
Describes the payload required for calculation of a single transaction
5 properties 2 required
Participant
object
An entity with a stake in a policy
2 properties 2 required
Multiple-Basic-Collections
array
Parties
array
An unkeyed collection of unique Party objects
Scenario-Results
object
A grouping of uniquely identifiable results, typically produced under a common set of assumptions
1 property
Features
object
Well-known geatures associated with a policy
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinnia-illustration-engine-api-openapi.yml Raw ↑

Other APIs Zinnia publishes across the network.

Zinnia Annuity Health Check API
Zinnia Annuity Version 1 API
Zinnia Annuity Version 2 API
Zinnia Attachment API
Zinnia Authorization Status Update API
Zinnia Case Instance API
Zinnia Client Case API
Zinnia Comments API
Zinnia Dataset API
Zinnia Details API
Zinnia Documents V2 API
Zinnia Documents V3 API
Where this information came from

This is an independent, third-party profile of Zinnia Illustration Engine API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.