Properties
| Name | Type | Description |
|---|---|---|
| ok | boolean | Whether the request succeeded |
| protocol | string | |
| version | string | |
| node | string | |
| timestamp | string | |
| request_id | string | The id of the request this envelope answers. The same value is the X-Request-Id response header and the requestId of every node log line written for the request, so an operator finds the request by it |
| data | object | Response payload (present when ok=true) |
| error | object | |
| hints | object | |
| meta | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/aimeat-io/json-schema/aimeat-io-aimeat-envelope-schema.json",
"title": "AimeatEnvelope",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/aimeat-io-actions-api-openapi.yml#/components/schemas/AimeatEnvelope",
"type": "object",
"required": [
"ok",
"protocol",
"version",
"node",
"timestamp",
"request_id"
],
"properties": {
"ok": {
"type": "boolean",
"description": "Whether the request succeeded"
},
"protocol": {
"type": "string",
"const": "aimeat"
},
"version": {
"type": "string"
},
"node": {
"type": "string"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"request_id": {
"type": "string",
"description": "The id of the request this envelope answers. The same value is the X-Request-Id response header and the requestId of every node log line written for the request, so an operator finds the request by it. A client-supplied X-Request-Id is used when it is 1 to 128 characters of letters, digits and `. _ : -`; otherwise the node makes one."
},
"data": {
"type": "object",
"description": "Response payload (present when ok=true)"
},
"error": {
"$ref": "#/$defs/ErrorDetail"
},
"hints": {
"$ref": "#/$defs/Hints"
},
"meta": {
"$ref": "#/$defs/EnvelopeMeta"
}
},
"$defs": {
"AiProvenanceRecord": {
"type": "object",
"description": "An `aimeat.provenance/v1` document: how much of a piece of content a model produced, and how\nmuch a person did. Readers MUST branch on `spec` and MUST NOT assume fields; an unknown\n`spec` reads as UNSTATED, never as an error and never as \"a human wrote it\". Canonical\nschema, versioned and machine-readable, at `/v1/schemas/ai-provenance/v1.json`.\n\nThis is a self-describing document, not a route DTO, so it keeps ONE spelling - camelCase -\non every carrier it travels on, next to the snake_case DTO fields around it.\n",
"required": [
"spec",
"level",
"humanInvolvement",
"generatedAt"
],
"properties": {
"spec": {
"type": "string",
"const": "aimeat.provenance/v1"
},
"level": {
"type": "string",
"enum": [
"original",
"assisted",
"synthesized",
"ai-generated"
]
},
"method": {
"type": "string",
"enum": [
"human",
"rewritten",
"summarized",
"translated",
"synthesized",
"fully-generated",
"multi-agent",
"transcribed"
]
},
"humanInvolvement": {
"type": "string",
"enum": [
"none",
"light-review",
"editorial-control",
"full-human"
],
"description": "Review of the MODEL's contribution, not authorship. `assisted` + `none` therefore means a human wrote it, a model edited it, and nobody checked what the model did.\n"
},
"generatedAt": {
"type": "string",
"format": "date-time"
},
"mediaKind": {
"type": "string",
"enum": [
"text",
"image",
"audio",
"video",
"code",
"data"
],
"description": "What kind of thing the record describes. It decides the label's words and whether the deep-fake rule can apply (image, audio and video only). Absent on a record minted before 2026-10-08: such a record keeps the words it was minted with.\n"
},
"mediaType": {
"type": "string",
"description": "The IANA media type of the bytes, parameters dropped."
},
"resemblesReal": {
"type": "string",
"enum": [
"yes",
"no",
"unknown"
],
"description": "The declarer's answer to whether the content resembles a real person, place, object or event. Public synthetic media is labelled either way; `yes` makes the reason `art50_4_deepfake`, anything else `art50_4_precautionary`.\n"
},
"generator": {
"type": "object",
"properties": {
"principal": {
"type": "string"
},
"model": {
"type": "string"
},
"provider": {
"type": "string"
},
"nodeId": {
"type": "string"
},
"pipeline": {
"type": "string"
},
"upstreamMarks": {
"type": "string",
"enum": [
"yes",
"no",
"unknown"
]
}
}
},
"sources": {
"type": "array",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"pattern": "^https?://",
"description": "http or https ONLY. Zod's URL validation accepts `javascript:` and `data:` because they parse, so the scheme is checked separately. A source is a place a reader can go and look."
},
"title": {
"type": "string"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"role": {
"type": "string"
}
}
}
},
"derivedFrom": {
"type": "array",
"items": {
"type": "string"
}
},
"attestation": {
"type": "object",
"properties": {
"stampedBy": {
"type": "string",
"enum": [
"node",
"principal"
]
},
"observed": {
"type": "boolean",
"description": "True ONLY when this node witnessed the generation. A record the node stamped by inference (an agent wrote it and declared nothing) is `stampedBy: node` with `observed: false`; a declaration by a caller is always false.\n"
},
"contentHash": {
"type": "string",
"pattern": "^sha256:[a-f0-9]{64}$"
},
"recordUrl": {
"type": "string",
"format": "uri"
}
}
},
"disclosure": {
"type": "object",
"description": "Computed by the node, never hand-written by a caller. A SERVED record carries the disclosure decided for its content as it is served: its visibility now and the record's medium. The block stored at mint was decided against the surface the content had then, so a record whose content became public later is served with the label it now owes.\n",
"required": [
"required",
"reason",
"short"
],
"properties": {
"required": {
"type": "boolean"
},
"reason": {
"type": "string",
"description": "Why a visible disclosure is (or is not) owed. Three of these are easy to confuse:\n\n`art50_4_public_interest` — the content IS stated to inform the public on a matter of public interest, so Article 50(4)'s text limb applies.\n\n`art50_4_precautionary` — nobody stated whether it is. The node labels anyway (over-labelling is the safe direction), but the record does not borrow a statutory basis to justify a precaution.\n\n`policy` — the law positively EXEMPTED this content and the operator labelled it regardless. Distinct from `precautionary`, where applicability was never established rather than decided.\n",
"enum": [
"art50_1_interaction",
"art50_2_synthetic_output",
"art50_4_deepfake",
"art50_4_public_interest",
"art50_4_precautionary",
"policy",
"none"
]
},
"strength": {
"type": "string",
"enum": [
"full",
"light",
"none"
],
"description": "How prominent the visible label is, from the node's AI-label setting (`full`, `light`) or `none` when nothing is owed."
},
"short": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"long": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"notes": {
"type": "string",
"maxLength": 1000
}
}
},
"EnvelopeMeta": {
"type": "object",
"description": "Facts ABOUT the response rather than parts of it: pagination, and `provenance`.\n\n`provenance` is the SINGLE carrier for AI provenance across every route that serves\ngenerated content (EU AI Act Article 50 transparency). It lives in `meta` and never in\n`data`, on every route without exception - `data` shapes are what published apps read, so\ncarrying it there would be a per-route breaking change, and splitting it across `data` on\nsome routes and `meta` on others is what makes an SDK need a special case per endpoint.\n",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total": {
"type": "integer"
},
"provenance": {
"type": "object",
"description": "The provenance of the content in `data`, when this node has a statement about it.",
"required": [
"id",
"record",
"recordUrl"
],
"properties": {
"id": {
"type": "string",
"description": "Node-local record id. A convenience handle - the content hash is the real join key."
},
"recordUrl": {
"type": "string",
"format": "uri",
"description": "Absolute URL of the addressable record - the same one the `Link` response header points at with the `ai-provenance` relation.\n"
},
"record": {
"$ref": "#/$defs/AiProvenanceRecord"
}
}
}
}
},
"ErrorDetail": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Machine-readable error code. Common codes:\n- AUTH_REQUIRED: Missing authentication. A browser's own top-level navigation to such a GET address (`Sec-Fetch-Mode: navigate`, `Sec-Fetch-Dest: document`) is answered `302` to the sign-in page `/v1/profile` instead; every other caller gets this 401.\n- INVALID_TOKEN: The token was refused (expired, revoked, a deleted personal access token, an account that no longer accepts it), on any route; or it verified but is not for this route (from 4.0.0, an MCP OAuth access token on a REST route)\n- ACCESS_DENIED: Insufficient permissions\n- NOT_FOUND: Resource not found\n- INSUFFICIENT_MORSELS: Wallet balance too low\n- QUOTA_EXCEEDED: Memory/storage quota exceeded\n- RATE_LIMITED: Too many requests\n- VERSION_CONFLICT: Optimistic lock failure\n- INVALID_INPUT: Request validation failed\n- INVALID_GAII: Malformed GAII format\n- AGENT_NOT_FOUND: Referenced agent does not exist\n- ACTION_NOT_FOUND: Referenced action does not exist\n- WORK_EXPIRED: Work item TTL exceeded\n- DISPUTE_CLOSED: Dispute already resolved\n- PEER_UNREACHABLE: Federation peer not responding\n- NAME_TAKEN: Owner/agent name already registered\n- ESCROW_FAILED: Could not hold morsels in escrow\n- SCHEMA_VALIDATION_FAILED: Value does not match schema\n- CONSENT_DENIED: Access denied by consent policy\n- TOTP_REQUIRED: Two-factor authentication required\n- TOTP_LOCKED: Account locked due to failed TOTP attempts\n- TOTP_REPLAY: TOTP code already used\n- TOTP_ALREADY_ENABLED: TOTP already set up\n- CSM_NOT_FOUND: CSM service not found\n- VALIDATION_ERROR: A field of the request is not valid. `details` lists each field (FieldError): its path, a code, the limit and a sentence in the caller's language. A NUL character or a broken (lone surrogate) character anywhere in the body, the query or the path gets this answer on every route.\n- ALREADY_FLAGGED: User has already flagged this target\n- EMAIL_UNAVAILABLE: Email service not configured\n- FEATURE_DISABLED: Feature disabled on this node\n- INVALID_STATUS: Invalid status transition\n- MEMBERSHIP_EXISTS: Already a member of this organism\n"
},
"message": {
"type": "string"
},
"details": {
"description": "More about the error. On VALIDATION_ERROR, one FieldError per field that is not valid.",
"oneOf": [
{
"type": "object"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/FieldError"
}
}
]
},
"retry_after": {
"type": "integer",
"description": "Seconds to wait before retry (present on RATE_LIMITED)"
}
}
},
"FieldError": {
"type": "object",
"description": "One field a request was refused for (VALIDATION_ERROR). `path` is the name a form gives the field, so a page shows `message` under it.",
"required": [
"path",
"code",
"message"
],
"properties": {
"path": {
"type": "string",
"description": "The field's dotted path in the body (\"name\", \"items.2.title\"); \"query.<name>\" for the query string; \"\" for the request itself."
},
"code": {
"type": "string",
"enum": [
"too_long",
"too_short",
"required",
"blank",
"control_char",
"nul_byte",
"invalid_unicode",
"unknown_field",
"invalid_type",
"invalid_format",
"invalid_value",
"invalid"
],
"description": "What is wrong. It does not change with the language."
},
"message": {
"type": "string",
"description": "What is wrong, in the caller's language (?lang=, the aimeat-lang cookie, Accept-Language)."
},
"max": {
"type": "integer",
"description": "The limit, on too_long."
},
"min": {
"type": "integer",
"description": "The minimum, on too_short and required."
}
}
},
"HintAction": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"HEAD"
]
},
"url": {
"type": "string"
},
"note": {
"type": "string",
"description": "A sentence on how to use the action (an example header, a condition)."
},
"example_body": {
"type": "object"
}
}
},
"Hints": {
"type": "object",
"properties": {
"next_actions": {
"type": "array",
"items": {
"$ref": "#/$defs/HintAction"
}
},
"help_url": {
"type": "string"
}
}
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/aimeat-io-aimeat-envelope"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.