API referencenpm packages@openagentid/sdk
OpenAgentIDAPI reference
@openagentid/sdk/character-api
API contract shipped by @openagentid/sdk 0.7.2. Exact exports, signatures, dependencies and availability.
All packages · Runnable examples · Start an agent
| Contract | Value |
|---|---|
| Package | @openagentid/sdk@0.7.2 |
| Entry point | @openagentid/sdk/character-api |
| Availability | Current integration path |
| Reference source | Published TypeScript declarations |
| Package engines | node >=20 |
Before integrating
The published VERSION constant is still the literal "0.6.0" in the 0.7.2 archive. Use package metadata or your lockfile to identify the installed release; do not use VERSION as a release check.
When using @openagentid/crypto-wasm 0.1.1 for ACT verification, call the SDK verifier builder .atTime(Math.floor(Date.now() / 1000)) on every verification. The default WASM system-clock path traps in Node. Supply trusted receiver current epoch seconds; never token-supplied time or a timestamp captured once at startup. The complete ACT example covers this requirement.
In SDK 0.7.2, withAct and requireActExpress do not expose a verification-clock option. The raw crypto-wasm 0.1.1 binding alone therefore traps for these wrappers; use the tested fluent .atTime(...) example, or qualify a binding adapter that supplies fresh trusted receiver time on every verification.
This reference is generated from the integrity-verified npm archive for this exact version. Signatures describe the public contract; they are not standalone programs. Complete examples are checked separately.
Import conditions
Use the public entry point above. The package resolves it to these shipped files; do not import its internal files directly.
| Condition | Published file |
|---|---|
| types | ./dist/character-api.d.ts |
| import | ./dist/character-api.js |
| require | ./dist/character-api.cjs |
Exports
CharacterApiHandlerOptions
Type-only declaration; it is not a runtime value.
interface CharacterApiHandlerOptions {
readonly basePath?: string;
}Source: @openagentid/sdk@0.7.2, dist/character-api.d.ts:1.
characterApiOpenApi
Bundled OpenAPI 3.1 contract; mirrored in docs/character-api.openapi.json.
declare const characterApiOpenApi: {
readonly openapi: "3.1.0";
readonly info: {
readonly title: "OpenAgentID Character API";
readonly version: "0.7.2";
readonly description: "Public, unauthenticated stateless deterministic agent decoration. Autos is the default rounded pill family. The catalog contains 17 families and 62 distinct character kinds, including Halloween, Thanksgiving and Christmas. Avatar rendering frames the face by default; view=full restores the complete character. Skin controls body and face geometry; expressions and live-v1 eyes are shared across skins. This API neither mints identities nor verifies possession, ownership, lineage, revocation or permissions. No secrets, external assets, JavaScript, CSS or fonts. Every response including errors and 304 includes wildcard CORS; credentials are not required. Unknown and duplicate query parameters are rejected. Input, streamed body chunks and geometry are bounded; hosted infrastructure supplies request rate and duration limits. Runtime state resolves state.expression before status mapping, then outer preferred expression, then neutral. Status is presentation state only and establishes no agent activity or authority. Independent glasses and headphones can be combined on every family. Accessories default to an empty selection, do not change identity-derived shape/color or live-eye state, and normalize to catalog order. Unknown, duplicate or malformed selections are refused. Every family supports shared finish (plush default, flat optional) and eyePlacement (face default, raised optional). These strictly closed appearance selectors do not change identity-derived shape/color or runtime state. Descriptors include both resolved values.";
};
readonly servers: readonly [
{
readonly url: "/v1/characters";
}
];
readonly security: readonly [
];
readonly paths: {
readonly "/skins": {
readonly get: {
readonly summary: "List versioned character skins";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly type: "array";
readonly items: {
readonly $ref: "#/components/schemas/CharacterSkinV1";
};
};
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
readonly head: {
readonly summary: "Headers for list versioned character skins";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly description: "Same status, headers and Content-Length as GET, no response body.";
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly description: "Invalid request, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "404": {
readonly description: "Not found, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "405": {
readonly description: "Not allowed, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
};
};
};
readonly options: {
readonly summary: "Public CORS preflight";
readonly parameters: readonly [
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "GET, HEAD, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
readonly "/statuses": {
readonly get: {
readonly summary: "List runtime status-to-expression mappings";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly type: "array";
readonly items: {
readonly $ref: "#/components/schemas/CharacterStatusV1";
};
readonly minItems: 26;
readonly maxItems: 26;
readonly description: "Immutable SDK mapping catalog serialized as JSON, including all expressions and runtime aliases.";
};
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
readonly head: {
readonly summary: "Headers for runtime status-to-expression mappings";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly description: "Same status, headers and Content-Length as GET, no response body.";
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly description: "Invalid request, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "404": {
readonly description: "Not found, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "405": {
readonly description: "Not allowed, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
};
};
};
readonly options: {
readonly summary: "Public CORS preflight";
readonly parameters: readonly [
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "GET, HEAD, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
readonly "/svg/{did}": {
readonly get: {
readonly summary: "Render a character SVG";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/did";
},
{
readonly $ref: "#/components/parameters/skin";
},
{
readonly $ref: "#/components/parameters/skinVersion";
},
{
readonly $ref: "#/components/parameters/eyeStyle";
},
{
readonly $ref: "#/components/parameters/size";
},
{
readonly $ref: "#/components/parameters/animated";
},
{
readonly $ref: "#/components/parameters/blink";
},
{
readonly $ref: "#/components/parameters/gazeX";
},
{
readonly $ref: "#/components/parameters/gazeY";
},
{
readonly $ref: "#/components/parameters/IfNoneMatch";
},
{
readonly $ref: "#/components/parameters/shape";
},
{
readonly $ref: "#/components/parameters/expression";
},
{
readonly $ref: "#/components/parameters/status";
},
{
readonly $ref: "#/components/parameters/view";
},
{
readonly $ref: "#/components/parameters/accessories";
},
{
readonly $ref: "#/components/parameters/finish";
},
{
readonly $ref: "#/components/parameters/eyePlacement";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
readonly "Content-Security-Policy": {
readonly $ref: "#/components/headers/SvgCsp";
};
};
readonly content: {
readonly "image/svg+xml": {
readonly schema: {
readonly type: "string";
};
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
readonly "Content-Security-Policy": {
readonly $ref: "#/components/headers/SvgCsp";
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
readonly head: {
readonly summary: "Headers for render a character svg";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/did";
},
{
readonly $ref: "#/components/parameters/skin";
},
{
readonly $ref: "#/components/parameters/skinVersion";
},
{
readonly $ref: "#/components/parameters/eyeStyle";
},
{
readonly $ref: "#/components/parameters/size";
},
{
readonly $ref: "#/components/parameters/animated";
},
{
readonly $ref: "#/components/parameters/blink";
},
{
readonly $ref: "#/components/parameters/gazeX";
},
{
readonly $ref: "#/components/parameters/gazeY";
},
{
readonly $ref: "#/components/parameters/IfNoneMatch";
},
{
readonly $ref: "#/components/parameters/shape";
},
{
readonly $ref: "#/components/parameters/expression";
},
{
readonly $ref: "#/components/parameters/status";
},
{
readonly $ref: "#/components/parameters/view";
},
{
readonly $ref: "#/components/parameters/accessories";
},
{
readonly $ref: "#/components/parameters/finish";
},
{
readonly $ref: "#/components/parameters/eyePlacement";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly description: "Same status, headers and Content-Length as GET, no response body.";
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
readonly "Content-Security-Policy": {
readonly $ref: "#/components/headers/SvgCsp";
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
readonly "Content-Security-Policy": {
readonly $ref: "#/components/headers/SvgCsp";
};
};
};
readonly "400": {
readonly description: "Invalid request, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "404": {
readonly description: "Not found, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "405": {
readonly description: "Not allowed, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
};
};
};
readonly options: {
readonly summary: "Public CORS preflight";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/did";
},
{
readonly $ref: "#/components/parameters/skin";
},
{
readonly $ref: "#/components/parameters/skinVersion";
},
{
readonly $ref: "#/components/parameters/eyeStyle";
},
{
readonly $ref: "#/components/parameters/size";
},
{
readonly $ref: "#/components/parameters/animated";
},
{
readonly $ref: "#/components/parameters/blink";
},
{
readonly $ref: "#/components/parameters/gazeX";
},
{
readonly $ref: "#/components/parameters/gazeY";
},
{
readonly $ref: "#/components/parameters/shape";
},
{
readonly $ref: "#/components/parameters/expression";
},
{
readonly $ref: "#/components/parameters/status";
},
{
readonly $ref: "#/components/parameters/view";
},
{
readonly $ref: "#/components/parameters/accessories";
},
{
readonly $ref: "#/components/parameters/finish";
},
{
readonly $ref: "#/components/parameters/eyePlacement";
}
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "GET, HEAD, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
readonly "/{did}": {
readonly get: {
readonly summary: "Generate a character descriptor";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/did";
},
{
readonly $ref: "#/components/parameters/skin";
},
{
readonly $ref: "#/components/parameters/skinVersion";
},
{
readonly $ref: "#/components/parameters/eyeStyle";
},
{
readonly $ref: "#/components/parameters/size";
},
{
readonly $ref: "#/components/parameters/animated";
},
{
readonly $ref: "#/components/parameters/blink";
},
{
readonly $ref: "#/components/parameters/gazeX";
},
{
readonly $ref: "#/components/parameters/gazeY";
},
{
readonly $ref: "#/components/parameters/IfNoneMatch";
},
{
readonly $ref: "#/components/parameters/shape";
},
{
readonly $ref: "#/components/parameters/expression";
},
{
readonly $ref: "#/components/parameters/status";
},
{
readonly $ref: "#/components/parameters/view";
},
{
readonly $ref: "#/components/parameters/accessories";
},
{
readonly $ref: "#/components/parameters/finish";
},
{
readonly $ref: "#/components/parameters/eyePlacement";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterDescriptorV1";
};
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
readonly head: {
readonly summary: "Headers for generate a character descriptor";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/did";
},
{
readonly $ref: "#/components/parameters/skin";
},
{
readonly $ref: "#/components/parameters/skinVersion";
},
{
readonly $ref: "#/components/parameters/eyeStyle";
},
{
readonly $ref: "#/components/parameters/size";
},
{
readonly $ref: "#/components/parameters/animated";
},
{
readonly $ref: "#/components/parameters/blink";
},
{
readonly $ref: "#/components/parameters/gazeX";
},
{
readonly $ref: "#/components/parameters/gazeY";
},
{
readonly $ref: "#/components/parameters/IfNoneMatch";
},
{
readonly $ref: "#/components/parameters/shape";
},
{
readonly $ref: "#/components/parameters/expression";
},
{
readonly $ref: "#/components/parameters/status";
},
{
readonly $ref: "#/components/parameters/view";
},
{
readonly $ref: "#/components/parameters/accessories";
},
{
readonly $ref: "#/components/parameters/finish";
},
{
readonly $ref: "#/components/parameters/eyePlacement";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly description: "Same status, headers and Content-Length as GET, no response body.";
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly description: "Invalid request, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "404": {
readonly description: "Not found, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "405": {
readonly description: "Not allowed, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
};
};
};
readonly options: {
readonly summary: "Public CORS preflight";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/did";
},
{
readonly $ref: "#/components/parameters/skin";
},
{
readonly $ref: "#/components/parameters/skinVersion";
},
{
readonly $ref: "#/components/parameters/eyeStyle";
},
{
readonly $ref: "#/components/parameters/size";
},
{
readonly $ref: "#/components/parameters/animated";
},
{
readonly $ref: "#/components/parameters/blink";
},
{
readonly $ref: "#/components/parameters/gazeX";
},
{
readonly $ref: "#/components/parameters/gazeY";
},
{
readonly $ref: "#/components/parameters/shape";
},
{
readonly $ref: "#/components/parameters/expression";
},
{
readonly $ref: "#/components/parameters/status";
},
{
readonly $ref: "#/components/parameters/view";
},
{
readonly $ref: "#/components/parameters/accessories";
},
{
readonly $ref: "#/components/parameters/finish";
},
{
readonly $ref: "#/components/parameters/eyePlacement";
}
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "GET, HEAD, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
readonly "/generate": {
readonly post: {
readonly summary: "Generate a character descriptor from JSON";
readonly description: "Stateless and unauthenticated; no query parameters. Unknown fields are rejected at every level. Streamed body size is checked independently of Content-Length.";
readonly "x-max-body-bytes": 16384;
readonly "x-reject-unknown-query-parameters": true;
readonly requestBody: {
readonly required: true;
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterGenerateRequestV1";
};
};
};
};
readonly responses: {
readonly "200": {
readonly description: "Generated descriptor; no-store, no ETag.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterDescriptorV1";
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
readonly "413": {
readonly $ref: "#/components/responses/BodyTooLarge";
};
readonly "415": {
readonly $ref: "#/components/responses/UnsupportedMediaType";
};
};
};
readonly options: {
readonly summary: "Public CORS preflight";
readonly parameters: readonly [
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "POST, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
readonly "/openapi.json": {
readonly get: {
readonly summary: "Read this OpenAPI schema";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly type: "object";
readonly description: "OpenAPI 3.1 document; servers[0].url reflects the configured mount path.";
};
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
readonly head: {
readonly summary: "Headers for read this openapi schema";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly description: "Same status, headers and Content-Length as GET, no response body.";
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly description: "Invalid request, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "404": {
readonly description: "Not found, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "405": {
readonly description: "Not allowed, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
};
};
};
readonly options: {
readonly summary: "Public CORS preflight";
readonly parameters: readonly [
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "GET, HEAD, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
readonly "/accessories": {
readonly get: {
readonly summary: "List combinable character accessories";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly type: "array";
readonly items: {
readonly $ref: "#/components/schemas/CharacterAccessoryDescriptionV1";
};
};
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
readonly head: {
readonly summary: "Headers for the character accessory catalog";
readonly parameters: readonly [
{
readonly $ref: "#/components/parameters/IfNoneMatch";
}
];
readonly "x-reject-unknown-query-parameters": true;
readonly "x-reject-duplicate-query-parameters": true;
readonly description: "Same status, headers and Content-Length as GET, no response body.";
readonly responses: {
readonly "200": {
readonly description: "Deterministic representation; public max-age=3600, must-revalidate.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "304": {
readonly description: "Matching validator, no body. CORS, ETag and SVG security headers are preserved.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly ETag: {
readonly $ref: "#/components/headers/ETag";
};
readonly "Content-Length": {
readonly $ref: "#/components/headers/ContentLength";
};
};
};
readonly "400": {
readonly description: "Invalid request, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "404": {
readonly description: "Not found, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
};
readonly "405": {
readonly description: "Not allowed, no body.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
};
};
};
readonly options: {
readonly summary: "Preflight for the character accessory catalog";
readonly parameters: readonly [
];
readonly responses: {
readonly "204": {
readonly description: "No body; schema-valid requests can be made cross-origin without credentials.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly "Access-Control-Allow-Methods": {
readonly schema: {
readonly type: "string";
readonly const: "GET, HEAD, OPTIONS";
};
};
readonly "Access-Control-Allow-Headers": {
readonly schema: {
readonly type: "string";
readonly const: "Content-Type, If-None-Match";
};
};
readonly "Access-Control-Max-Age": {
readonly schema: {
readonly type: "integer";
readonly const: 86400;
};
};
};
};
readonly "400": {
readonly $ref: "#/components/responses/InvalidRequest";
};
readonly "404": {
readonly $ref: "#/components/responses/NotFound";
};
readonly "405": {
readonly $ref: "#/components/responses/MethodNotAllowed";
};
};
};
};
};
readonly components: {
readonly schemas: {
readonly AgentDid: {
readonly type: "string";
readonly maxLength: 512;
readonly pattern: "^did:(?:(?:oas:[a-z0-9][a-z0-9-]{0,63}|l1fe):agent(?::instance)?:[A-Za-z0-9._-]+|oas:agent-instance:[0-7][0-9A-HJKMNP-TV-Z]{25})(?![\\s\\S])";
readonly description: "Existing agent or agent:instance DID, including the literal IAM did:oas:agent-instance:<canonical uppercase ULID> avatar format. Generation preserves the assigned DID and neither verifies nor registers a principal; authentication schemas are unchanged.";
};
readonly CharacterAppearanceV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"skin"
];
readonly properties: {
readonly skin: {
readonly type: "string";
readonly enum: readonly [
"autos",
"spacex",
"fold",
"sprig",
"ripple",
"halo",
"purl",
"prism",
"coil",
"kiln",
"wisp",
"relay",
"cairn",
"tuft",
"halloween",
"thanksgiving",
"christmas"
];
readonly default: "autos";
};
readonly skinVersion: {
readonly type: "integer";
readonly const: 1;
readonly default: 1;
};
readonly eyeStyle: {
readonly type: "string";
readonly const: "live-v1";
readonly default: "live-v1";
readonly description: "Shared geometry across all families. Future eye geometries receive new identifiers.";
};
readonly shape: {
readonly type: "string";
readonly enum: readonly [
"standard",
"slender",
"wide",
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet",
"kite",
"fan",
"bud",
"leaf",
"drop",
"wave",
"comet",
"satellite",
"mitt",
"hood",
"crystal",
"obelisk",
"spring",
"bellows",
"vase",
"teapot",
"flame",
"curl",
"radio",
"beacon",
"tower",
"arch",
"pom",
"bear",
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn",
"turkey",
"acorn",
"squash",
"pie",
"corn",
"light",
"tree",
"snowman",
"ornament",
"gift"
];
readonly description: "Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.";
};
readonly accessories: {
readonly $ref: "#/components/schemas/CharacterAccessoriesV1";
};
readonly finish: {
readonly $ref: "#/components/schemas/CharacterFinish";
};
readonly eyePlacement: {
readonly $ref: "#/components/schemas/CharacterEyePlacement";
};
};
readonly allOf: readonly [
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "autos";
};
};
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"slender",
"wide"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "spacex";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "fold";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"kite",
"fan"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "sprig";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"bud",
"leaf"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "ripple";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"drop",
"wave"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halo";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"comet",
"satellite"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "purl";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"mitt",
"hood"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "prism";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"crystal",
"obelisk"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "coil";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"spring",
"bellows"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "kiln";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"vase",
"teapot"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "wisp";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"flame",
"curl"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "relay";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"radio",
"beacon"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "cairn";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"tower",
"arch"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "tuft";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"pom",
"bear"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halloween";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "thanksgiving";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"turkey",
"acorn",
"squash",
"pie",
"corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "christmas";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"light",
"tree",
"snowman",
"ornament",
"gift"
];
};
};
};
}
];
};
readonly GazeV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"x",
"y"
];
readonly properties: {
readonly x: {
readonly type: "number";
readonly minimum: -1;
readonly maximum: 1;
readonly default: 0;
};
readonly y: {
readonly type: "number";
readonly minimum: -1;
readonly maximum: 1;
readonly default: 0;
};
};
};
readonly LiveEyeStateV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly properties: {
readonly blink: {
readonly type: "number";
readonly minimum: 0;
readonly maximum: 1;
readonly default: 0;
};
readonly gaze: {
readonly $ref: "#/components/schemas/GazeV1";
};
readonly status: {
readonly $ref: "#/components/schemas/AvatarStatus";
readonly description: "Runtime status alias or literal expression. Overrides the outer preferred expression.";
};
readonly expression: {
readonly $ref: "#/components/schemas/AvatarExpression";
readonly description: "Explicit runtime expression; overrides state.status mapping and outer preferred expression. Null is not accepted by this stateless API.";
};
};
readonly description: "Optional stateless snapshot. Resolution: state.expression > state.status mapping > outer expression > neutral. Unknown fields and null values are refused.";
};
readonly CharacterOptionsV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly properties: {
readonly skin: {
readonly type: "string";
readonly enum: readonly [
"autos",
"spacex",
"fold",
"sprig",
"ripple",
"halo",
"purl",
"prism",
"coil",
"kiln",
"wisp",
"relay",
"cairn",
"tuft",
"halloween",
"thanksgiving",
"christmas"
];
readonly default: "autos";
};
readonly skinVersion: {
readonly type: "integer";
readonly const: 1;
readonly default: 1;
};
readonly eyeStyle: {
readonly type: "string";
readonly const: "live-v1";
readonly default: "live-v1";
readonly description: "Shared geometry across all families. Future eye geometries receive new identifiers.";
};
readonly size: {
readonly type: "integer";
readonly minimum: 32;
readonly maximum: 2048;
readonly default: 512;
};
readonly animated: {
readonly type: "boolean";
readonly default: true;
readonly description: "Native SMIL animation with no JavaScript or CSS.";
};
readonly state: {
readonly $ref: "#/components/schemas/LiveEyeStateV1";
};
readonly shape: {
readonly type: "string";
readonly enum: readonly [
"standard",
"slender",
"wide",
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet",
"kite",
"fan",
"bud",
"leaf",
"drop",
"wave",
"comet",
"satellite",
"mitt",
"hood",
"crystal",
"obelisk",
"spring",
"bellows",
"vase",
"teapot",
"flame",
"curl",
"radio",
"beacon",
"tower",
"arch",
"pom",
"bear",
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn",
"turkey",
"acorn",
"squash",
"pie",
"corn",
"light",
"tree",
"snowman",
"ornament",
"gift"
];
readonly description: "Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.";
};
readonly expression: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned"
];
readonly default: "neutral";
readonly description: "Outer preferred expression fallback. Explicit state.expression wins, then state.status mapping, then this preference, then neutral.";
};
readonly view: {
readonly type: "string";
readonly enum: readonly [
"avatar",
"full"
];
readonly default: "avatar";
readonly description: "Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.";
};
readonly accessories: {
readonly $ref: "#/components/schemas/CharacterAccessoriesV1";
};
readonly finish: {
readonly $ref: "#/components/schemas/CharacterFinish";
};
readonly eyePlacement: {
readonly $ref: "#/components/schemas/CharacterEyePlacement";
};
};
readonly allOf: readonly [
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "autos";
};
};
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"slender",
"wide"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "spacex";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "fold";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"kite",
"fan"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "sprig";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"bud",
"leaf"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "ripple";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"drop",
"wave"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halo";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"comet",
"satellite"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "purl";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"mitt",
"hood"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "prism";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"crystal",
"obelisk"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "coil";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"spring",
"bellows"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "kiln";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"vase",
"teapot"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "wisp";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"flame",
"curl"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "relay";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"radio",
"beacon"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "cairn";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"tower",
"arch"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "tuft";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"pom",
"bear"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halloween";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "thanksgiving";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"turkey",
"acorn",
"squash",
"pie",
"corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "christmas";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"light",
"tree",
"snowman",
"ornament",
"gift"
];
};
};
};
}
];
};
readonly CharacterGenerateRequestV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"did"
];
readonly properties: {
readonly did: {
readonly $ref: "#/components/schemas/AgentDid";
};
readonly skin: {
readonly type: "string";
readonly enum: readonly [
"autos",
"spacex",
"fold",
"sprig",
"ripple",
"halo",
"purl",
"prism",
"coil",
"kiln",
"wisp",
"relay",
"cairn",
"tuft",
"halloween",
"thanksgiving",
"christmas"
];
readonly default: "autos";
};
readonly skinVersion: {
readonly type: "integer";
readonly const: 1;
readonly default: 1;
};
readonly eyeStyle: {
readonly type: "string";
readonly const: "live-v1";
readonly default: "live-v1";
readonly description: "Shared geometry across all families. Future eye geometries receive new identifiers.";
};
readonly size: {
readonly type: "integer";
readonly minimum: 32;
readonly maximum: 2048;
readonly default: 512;
};
readonly animated: {
readonly type: "boolean";
readonly default: true;
readonly description: "Native SMIL animation with no JavaScript or CSS.";
};
readonly state: {
readonly $ref: "#/components/schemas/LiveEyeStateV1";
};
readonly shape: {
readonly type: "string";
readonly enum: readonly [
"standard",
"slender",
"wide",
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet",
"kite",
"fan",
"bud",
"leaf",
"drop",
"wave",
"comet",
"satellite",
"mitt",
"hood",
"crystal",
"obelisk",
"spring",
"bellows",
"vase",
"teapot",
"flame",
"curl",
"radio",
"beacon",
"tower",
"arch",
"pom",
"bear",
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn",
"turkey",
"acorn",
"squash",
"pie",
"corn",
"light",
"tree",
"snowman",
"ornament",
"gift"
];
readonly description: "Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.";
};
readonly expression: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned"
];
readonly default: "neutral";
readonly description: "Outer preferred expression fallback. Explicit state.expression wins, then state.status mapping, then this preference, then neutral.";
};
readonly view: {
readonly type: "string";
readonly enum: readonly [
"avatar",
"full"
];
readonly default: "avatar";
readonly description: "Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.";
};
readonly accessories: {
readonly $ref: "#/components/schemas/CharacterAccessoriesV1";
};
readonly finish: {
readonly $ref: "#/components/schemas/CharacterFinish";
};
readonly eyePlacement: {
readonly $ref: "#/components/schemas/CharacterEyePlacement";
};
};
readonly allOf: readonly [
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "autos";
};
};
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"slender",
"wide"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "spacex";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "fold";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"kite",
"fan"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "sprig";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"bud",
"leaf"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "ripple";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"drop",
"wave"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halo";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"comet",
"satellite"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "purl";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"mitt",
"hood"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "prism";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"crystal",
"obelisk"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "coil";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"spring",
"bellows"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "kiln";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"vase",
"teapot"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "wisp";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"flame",
"curl"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "relay";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"radio",
"beacon"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "cairn";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"tower",
"arch"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "tuft";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"pom",
"bear"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halloween";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "thanksgiving";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"turkey",
"acorn",
"squash",
"pie",
"corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "christmas";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"light",
"tree",
"snowman",
"ornament",
"gift"
];
};
};
};
}
];
};
readonly CharacterDescriptorV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"did",
"skin",
"skinVersion",
"eyeStyle",
"shape",
"color",
"size",
"animated",
"state",
"svg",
"expression",
"view",
"accessories",
"finish",
"eyePlacement"
];
readonly properties: {
readonly did: {
readonly $ref: "#/components/schemas/AgentDid";
};
readonly skin: {
readonly type: "string";
readonly enum: readonly [
"autos",
"spacex",
"fold",
"sprig",
"ripple",
"halo",
"purl",
"prism",
"coil",
"kiln",
"wisp",
"relay",
"cairn",
"tuft",
"halloween",
"thanksgiving",
"christmas"
];
readonly default: "autos";
};
readonly skinVersion: {
readonly type: "integer";
readonly const: 1;
readonly default: 1;
};
readonly eyeStyle: {
readonly type: "string";
readonly const: "live-v1";
readonly default: "live-v1";
readonly description: "Shared geometry across all families. Future eye geometries receive new identifiers.";
};
readonly size: {
readonly type: "integer";
readonly minimum: 32;
readonly maximum: 2048;
readonly default: 512;
};
readonly animated: {
readonly type: "boolean";
readonly default: true;
readonly description: "Native SMIL animation with no JavaScript or CSS.";
};
readonly state: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"blink",
"gaze"
];
readonly properties: {
readonly blink: {
readonly type: "number";
readonly minimum: 0;
readonly maximum: 1;
readonly default: 0;
};
readonly gaze: {
readonly $ref: "#/components/schemas/GazeV1";
};
readonly status: {
readonly $ref: "#/components/schemas/AvatarStatus";
};
readonly expression: {
readonly $ref: "#/components/schemas/AvatarExpression";
};
};
readonly description: "Normalized blink/gaze, retaining status/expression only when explicitly supplied in input state. Descriptor.expression is the resolved expression; old snapshots without state status/expression preserve their prior shape.";
};
readonly color: {
readonly type: "string";
readonly pattern: "^#[0-9a-fA-F]{6}$";
};
readonly svg: {
readonly type: "string";
readonly description: "Escaped, self-contained SVG on a transparent background. No external resources, JavaScript, CSS or fonts.";
};
readonly shape: {
readonly type: "string";
readonly enum: readonly [
"standard",
"slender",
"wide",
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet",
"kite",
"fan",
"bud",
"leaf",
"drop",
"wave",
"comet",
"satellite",
"mitt",
"hood",
"crystal",
"obelisk",
"spring",
"bellows",
"vase",
"teapot",
"flame",
"curl",
"radio",
"beacon",
"tower",
"arch",
"pom",
"bear",
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn",
"turkey",
"acorn",
"squash",
"pie",
"corn",
"light",
"tree",
"snowman",
"ornament",
"gift"
];
readonly description: "Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.";
};
readonly expression: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned"
];
readonly default: "neutral";
readonly description: "Resolved expression: state.expression > state.status mapping > outer preferred expression > neutral. Body shape/color remain unchanged.";
};
readonly view: {
readonly type: "string";
readonly enum: readonly [
"avatar",
"full"
];
readonly default: "avatar";
readonly description: "Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.";
};
readonly accessories: {
readonly $ref: "#/components/schemas/CharacterAccessoriesV1";
};
readonly finish: {
readonly $ref: "#/components/schemas/CharacterFinish";
};
readonly eyePlacement: {
readonly $ref: "#/components/schemas/CharacterEyePlacement";
};
};
readonly allOf: readonly [
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "autos";
};
};
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"slender",
"wide"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "spacex";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "fold";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"kite",
"fan"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "sprig";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"bud",
"leaf"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "ripple";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"drop",
"wave"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halo";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"comet",
"satellite"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "purl";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"mitt",
"hood"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "prism";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"crystal",
"obelisk"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "coil";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"spring",
"bellows"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "kiln";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"vase",
"teapot"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "wisp";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"flame",
"curl"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "relay";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"radio",
"beacon"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "cairn";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"tower",
"arch"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "tuft";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"standard",
"pom",
"bear"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "halloween";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "thanksgiving";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"turkey",
"acorn",
"squash",
"pie",
"corn"
];
};
};
};
},
{
readonly if: {
readonly properties: {
readonly skin: {
readonly const: "christmas";
};
};
readonly required: readonly [
"skin"
];
};
readonly then: {
readonly properties: {
readonly shape: {
readonly enum: readonly [
"light",
"tree",
"snowman",
"ornament",
"gift"
];
};
};
};
}
];
};
readonly CharacterSkinV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"id",
"label",
"version",
"eyeStyles",
"shapes",
"expressions"
];
readonly properties: {
readonly id: {
readonly type: "string";
readonly enum: readonly [
"autos",
"spacex",
"fold",
"sprig",
"ripple",
"halo",
"purl",
"prism",
"coil",
"kiln",
"wisp",
"relay",
"cairn",
"tuft",
"halloween",
"thanksgiving",
"christmas"
];
readonly default: "autos";
};
readonly label: {
readonly type: "string";
};
readonly version: {
readonly type: "integer";
readonly const: 1;
};
readonly eyeStyles: {
readonly type: "array";
readonly items: {
readonly type: "string";
readonly const: "live-v1";
readonly default: "live-v1";
readonly description: "Shared geometry across all families. Future eye geometries receive new identifiers.";
};
readonly minItems: 1;
readonly uniqueItems: true;
};
readonly shapes: {
readonly type: "array";
readonly items: {
readonly type: "string";
readonly enum: readonly [
"standard",
"slender",
"wide",
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet",
"kite",
"fan",
"bud",
"leaf",
"drop",
"wave",
"comet",
"satellite",
"mitt",
"hood",
"crystal",
"obelisk",
"spring",
"bellows",
"vase",
"teapot",
"flame",
"curl",
"radio",
"beacon",
"tower",
"arch",
"pom",
"bear",
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn",
"turkey",
"acorn",
"squash",
"pie",
"corn",
"light",
"tree",
"snowman",
"ornament",
"gift"
];
readonly description: "Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.";
};
readonly minItems: 1;
readonly uniqueItems: true;
};
readonly expressions: {
readonly type: "array";
readonly items: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned"
];
readonly default: "neutral";
readonly description: "Shared eye expression across all skins. Body shape and color remain unchanged. Explicit blink shrinks expression eye bars and gaze translates both together.";
};
readonly minItems: 18;
readonly maxItems: 18;
readonly uniqueItems: true;
};
};
readonly allOf: readonly [
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "autos";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"slender",
"wide"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "spacex";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet"
];
};
readonly minItems: 8;
readonly maxItems: 8;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "fold";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"kite",
"fan"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "sprig";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"bud",
"leaf"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "ripple";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"drop",
"wave"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "halo";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"comet",
"satellite"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "purl";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"mitt",
"hood"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "prism";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"crystal",
"obelisk"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "coil";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"spring",
"bellows"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "kiln";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"vase",
"teapot"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "wisp";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"flame",
"curl"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "relay";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"radio",
"beacon"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "cairn";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"tower",
"arch"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "tuft";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"standard",
"pom",
"bear"
];
};
readonly minItems: 3;
readonly maxItems: 3;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "halloween";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn"
];
};
readonly minItems: 5;
readonly maxItems: 5;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "thanksgiving";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"turkey",
"acorn",
"squash",
"pie",
"corn"
];
};
readonly minItems: 5;
readonly maxItems: 5;
};
};
};
},
{
readonly if: {
readonly required: readonly [
"id"
];
readonly properties: {
readonly id: {
readonly const: "christmas";
};
};
};
readonly then: {
readonly properties: {
readonly shapes: {
readonly items: {
readonly enum: readonly [
"light",
"tree",
"snowman",
"ornament",
"gift"
];
};
readonly minItems: 5;
readonly maxItems: 5;
};
};
};
}
];
};
readonly CharacterApiError: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"error"
];
readonly properties: {
readonly error: {
readonly type: "string";
readonly enum: readonly [
"invalid_request",
"body_too_large",
"unsupported_media_type",
"method_not_allowed",
"not_found"
];
};
};
};
readonly AvatarExpression: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned"
];
readonly description: "Shared eye expression across all families; does not change identity-derived shape or color.";
};
readonly AvatarStatus: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned",
"idle",
"listening",
"reasoning",
"working",
"speaking",
"success",
"blocked",
"error"
];
readonly description: "Expressions map to themselves. Aliases: idle→neutral, listening→attentive, reasoning→thoughtful, working→attentive, speaking/success→happy, blocked/error→concerned. Presentation only; not evidence of actual agent activity.";
};
readonly CharacterStatusV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"status",
"expression"
];
readonly properties: {
readonly status: {
readonly $ref: "#/components/schemas/AvatarStatus";
};
readonly expression: {
readonly $ref: "#/components/schemas/AvatarExpression";
};
};
};
readonly CharacterAccessory: {
readonly type: "string";
readonly enum: readonly [
"glasses",
"headphones"
];
readonly description: "Closed package-owned accessory identifier; independent of character family.";
};
readonly CharacterAccessoriesV1: {
readonly type: "array";
readonly items: {
readonly $ref: "#/components/schemas/CharacterAccessory";
};
readonly maxItems: 2;
readonly uniqueItems: true;
readonly default: readonly [
];
readonly description: "Optional independent accessories, canonicalized to glasses then headphones. Omitted selection resolves to []; no null, unknown identifier or duplicate is accepted.";
};
readonly CharacterAccessoryDescriptionV1: {
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly [
"id",
"label",
"description"
];
readonly properties: {
readonly id: {
readonly $ref: "#/components/schemas/CharacterAccessory";
};
readonly label: {
readonly type: "string";
readonly minLength: 1;
};
readonly description: {
readonly type: "string";
readonly minLength: 1;
};
};
};
readonly CharacterFinish: {
readonly type: "string";
readonly enum: readonly [
"plush",
"flat"
];
readonly default: "plush";
readonly description: "Shared body finish on every family: plush by default, flat for the vector material. Appearance only; identity and live state stay independent.";
};
readonly CharacterEyePlacement: {
readonly type: "string";
readonly enum: readonly [
"face",
"raised"
];
readonly default: "face";
readonly description: "Shared live-v1 eye placement on every family: on the face by default, or raised above the head. Appearance only; all eighteen expressions remain available.";
};
};
readonly parameters: {
readonly did: {
readonly name: "did";
readonly in: "path";
readonly required: true;
readonly schema: {
readonly $ref: "#/components/schemas/AgentDid";
};
readonly description: "Percent-encode the entire DID as one path segment.";
};
readonly IfNoneMatch: {
readonly name: "If-None-Match";
readonly in: "header";
readonly schema: {
readonly type: "string";
readonly maxLength: 4096;
};
readonly description: "GET/HEAD accepts a strong/weak validator, comma-separated list or *. Headers over 4096 characters are ignored.";
};
readonly skin: {
readonly name: "skin";
readonly in: "query";
readonly schema: {
readonly type: "string";
readonly enum: readonly [
"autos",
"spacex",
"fold",
"sprig",
"ripple",
"halo",
"purl",
"prism",
"coil",
"kiln",
"wisp",
"relay",
"cairn",
"tuft",
"halloween",
"thanksgiving",
"christmas"
];
readonly default: "autos";
};
};
readonly skinVersion: {
readonly name: "skinVersion";
readonly in: "query";
readonly schema: {
readonly type: "integer";
readonly const: 1;
readonly default: 1;
};
};
readonly eyeStyle: {
readonly name: "eyeStyle";
readonly in: "query";
readonly schema: {
readonly type: "string";
readonly const: "live-v1";
readonly default: "live-v1";
readonly description: "Shared geometry across all families. Future eye geometries receive new identifiers.";
};
};
readonly size: {
readonly name: "size";
readonly in: "query";
readonly schema: {
readonly type: "integer";
readonly minimum: 32;
readonly maximum: 2048;
readonly default: 512;
};
readonly description: "Unsigned decimal integer, no leading zeroes.";
};
readonly animated: {
readonly name: "animated";
readonly in: "query";
readonly schema: {
readonly type: "boolean";
readonly default: true;
readonly description: "Native SMIL animation with no JavaScript or CSS.";
};
readonly description: "Exactly true or false.";
};
readonly blink: {
readonly name: "blink";
readonly in: "query";
readonly schema: {
readonly type: "number";
readonly minimum: 0;
readonly maximum: 1;
readonly default: 0;
};
readonly description: "Finite ordinary decimal notation, no exponent, whitespace or leading +.";
};
readonly gazeX: {
readonly name: "gazeX";
readonly in: "query";
readonly schema: {
readonly type: "number";
readonly minimum: -1;
readonly maximum: 1;
readonly default: 0;
};
readonly description: "Finite ordinary decimal notation, no exponent, whitespace or leading +. gazeX and gazeY must be supplied together.";
};
readonly gazeY: {
readonly name: "gazeY";
readonly in: "query";
readonly schema: {
readonly type: "number";
readonly minimum: -1;
readonly maximum: 1;
readonly default: 0;
};
readonly description: "Finite ordinary decimal notation, no exponent, whitespace or leading +. gazeX and gazeY must be supplied together.";
};
readonly shape: {
readonly name: "shape";
readonly in: "query";
readonly schema: {
readonly type: "string";
readonly enum: readonly [
"standard",
"slender",
"wide",
"circle",
"pebble",
"squircle",
"capsule",
"triangle",
"hexagon",
"cloud",
"droplet",
"kite",
"fan",
"bud",
"leaf",
"drop",
"wave",
"comet",
"satellite",
"mitt",
"hood",
"crystal",
"obelisk",
"spring",
"bellows",
"vase",
"teapot",
"flame",
"curl",
"radio",
"beacon",
"tower",
"arch",
"pom",
"bear",
"pumpkin",
"ghost",
"bat",
"witch-hat",
"candy-corn",
"turkey",
"acorn",
"squash",
"pie",
"corn",
"light",
"tree",
"snowman",
"ornament",
"gift"
];
readonly description: "Optional body override; must belong to the selected skin. Omitted shape is deterministically selected from the DID and skin.";
};
};
readonly expression: {
readonly name: "expression";
readonly in: "query";
readonly schema: {
readonly type: "string";
readonly enum: readonly [
"neutral",
"attentive",
"surprised",
"excited",
"happy",
"laughing",
"angry",
"sad",
"scared",
"suspicious",
"confused",
"curious",
"proud",
"shy",
"unimpressed",
"sleepy",
"thoughtful",
"concerned"
];
readonly default: "neutral";
readonly description: "Shared eye expression across all skins. Body shape and color remain unchanged. Explicit blink shrinks expression eye bars and gaze translates both together.";
};
readonly description: "Outer preferred expression fallback. A status query is state.status and overrides this preference. Explicit runtime expression overrides can be supplied in POST state.expression.";
};
readonly status: {
readonly name: "status";
readonly in: "query";
readonly schema: {
readonly $ref: "#/components/schemas/AvatarStatus";
};
readonly description: "Parsed as state.status. Overrides expression query preference with its mapped expression. Duplicate/unknown status values are refused before rendering or cache validation.";
};
readonly view: {
readonly name: "view";
readonly in: "query";
readonly schema: {
readonly type: "string";
readonly enum: readonly [
"avatar",
"full"
];
readonly default: "avatar";
readonly description: "Face crop for avatars by default; full shows the complete body. Rendering only, independent of stored appearance and runtime eye state.";
};
};
readonly accessories: {
readonly name: "accessories";
readonly in: "query";
readonly required: false;
readonly style: "form";
readonly explode: false;
readonly allowEmptyValue: true;
readonly schema: {
readonly $ref: "#/components/schemas/CharacterAccessoriesV1";
};
readonly description: "One comma-separated selection, for example glasses,headphones. Empty string means []; either input order normalizes to catalog order. Repeated query parameters, duplicates, unknown IDs, whitespace and empty elements are refused.";
};
readonly finish: {
readonly name: "finish";
readonly in: "query";
readonly schema: {
readonly $ref: "#/components/schemas/CharacterFinish";
};
};
readonly eyePlacement: {
readonly name: "eyePlacement";
readonly in: "query";
readonly schema: {
readonly $ref: "#/components/schemas/CharacterEyePlacement";
};
};
};
readonly headers: {
readonly CorsOrigin: {
readonly schema: {
readonly type: "string";
readonly const: "*";
};
};
readonly CorsExpose: {
readonly schema: {
readonly type: "string";
readonly const: "ETag, Content-Length";
};
};
readonly NoSniff: {
readonly schema: {
readonly type: "string";
readonly const: "nosniff";
};
};
readonly CacheControl: {
readonly schema: {
readonly type: "string";
};
};
readonly ETag: {
readonly schema: {
readonly type: "string";
};
readonly description: "Strong SHA-256 validator for exact response bytes.";
};
readonly ContentLength: {
readonly schema: {
readonly type: "integer";
readonly minimum: 0;
};
};
readonly SvgCsp: {
readonly schema: {
readonly type: "string";
readonly const: "default-src 'none'; img-src 'none'; style-src 'none'; sandbox";
};
};
};
readonly responses: {
readonly InvalidRequest: {
readonly description: "Invalid DID, malformed value or JSON, unknown field, unknown or duplicate query parameter.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterApiError";
};
};
};
};
readonly NotFound: {
readonly description: "Route outside this handler or unsupported route shape.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterApiError";
};
};
};
};
readonly MethodNotAllowed: {
readonly description: "Method not supported; Allow identifies allowed methods.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
readonly Allow: {
readonly schema: {
readonly type: "string";
};
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterApiError";
};
};
};
};
readonly BodyTooLarge: {
readonly description: "Announced or streamed body exceeds 16384 bytes.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterApiError";
};
};
};
};
readonly UnsupportedMediaType: {
readonly description: "Requires uncompressed UTF-8 application/json, optionally charset=utf-8.";
readonly headers: {
readonly "Access-Control-Allow-Origin": {
readonly $ref: "#/components/headers/CorsOrigin";
};
readonly "Access-Control-Expose-Headers": {
readonly $ref: "#/components/headers/CorsExpose";
};
readonly "X-Content-Type-Options": {
readonly $ref: "#/components/headers/NoSniff";
};
readonly "Cache-Control": {
readonly $ref: "#/components/headers/CacheControl";
};
};
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/CharacterApiError";
};
};
};
};
};
};
};Source: @openagentid/sdk@0.7.2, dist/character-api.d.ts:11.
createCharacterApiHandler
Unauthenticated, stateless decoration only. This handler never resolves, registers, authenticates or verifies the requested agent identity.
declare function createCharacterApiHandler(options?: CharacterApiHandlerOptions): (request: Request) => Promise<Response>;Source: @openagentid/sdk@0.7.2, dist/character-api.d.ts:9.
Package requirements
Dependencies
| Package | Published range |
|---|---|
| zod | ^3.23.8 |
| jose | ^5.10.0 |
| @noble/hashes | ^1.8.0 |
| @scure/base | ^1.2.6 |
Peer dependencies
| Package | Published range | Optional |
|---|---|---|
| @openagentid/aegis-sdk | ^0.1.0 | Yes |
| @openagentid/arsenal-sdk | ^0.1.0 | Yes |
| @openagentid/crypto-wasm | ^0.1.0 | Yes |
| @openagentid/oas-sdk | ^1.0.2 | Yes |
Archive verification
Pinned integrity:
sha512-9YlDb02di8sGffhuMOwNAQa/M3oBrhaqPc7t+qBltdoQRCqlxDmYB/nTRSB4eZgwE4lvM4TKzI72nJtJSVm/ww==