Functions

Function registry

List registered functions

get

Query parameters

cidsstringOptional

Comma-separated list of CIDs to filter by

Example: QmAbc...,QmDef...

creatorstringOptional

A valid EVM (0x-prefixed hex) address.

Example: 0x1234567890abcdef1234567890abcdef12345678

offsetintegerOptionalDefault: 0

limitinteger · min: 1 · max: 100OptionalDefault: 10

Responses

200

List of functions

application/json

CIDstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco

namestringRequired

versionstringRequired

descriptionstringRequired

createdAtstring · date-timeRequired

get/functions

GET /functions HTTP/1.1
Host: api-protocol.mimic.fi
Accept: */*

200

List of functions

[
  {
    "CID": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
    "name": "text",
    "version": "text",
    "description": "text",
    "createdAt": "2026-01-01T00:00:00.000Z"
  }
]

Upload a new function

post

Uploads a function bundle. The request must be multipart/form-data containing exactly two files using the same multipart field name file. The filenames must be manifest.json and function.wasm.

Authorizations

x-api-keystringRequired

API key obtained from GET /users/api-key

Body

filestring · binary[] · min: 2 · max: 2Required

Exactly two uploaded files using the same multipart field name file. The filenames must be manifest.json and function.wasm.

Responses

200

Function registered

application/json

CIDstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco

namestringRequired

versionstringRequired

descriptionstringRequired

createdAtstring · date-timeRequired

400

Bad request — invalid parameters or body

application/json

401

Unauthorized — missing or invalid credentials

application/json

post/functions

POST /functions HTTP/1.1
Host: api-protocol.mimic.fi
x-api-key: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 19

{
  "file": [
    "binary"
  ]
}

{
  "CID": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
  "name": "text",
  "version": "text",
  "description": "text",
  "createdAt": "2026-01-01T00:00:00.000Z"
}

Get a function by CID

get

Path parameters

cidstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco

Responses

200

Function details

application/json

CIDstringRequired

An IPFS content identifier (CIDv0 or CIDv1 base32).

Example: QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco

namestringRequired

versionstringRequired

descriptionstringRequired

createdAtstring · date-timeRequired

404

Resource not found

application/json

get/functions/{cid}

GET /functions/{cid} HTTP/1.1
Host: api-protocol.mimic.fi
Accept: */*

{
  "CID": "QmXoypizjW3WknFiJnKLwHCnL72vedxjQkDDP1mXWo6uco",
  "name": "text",
  "version": "text",
  "description": "text",
  "createdAt": "2026-01-01T00:00:00.000Z"
}