---
title: "POST /v1/functions/{functionId}/invoke"
method: POST
path: "/v1/functions/{functionId}/invoke"
tags: ["Invoke"]
---

# POST /v1/functions/{functionId}/invoke

`POST /v1/functions/{functionId}/invoke`

## Path parameters

- `functionId` string, required

## Query parameters

- `labelCount` integer
- `includeMetadata` boolean
- `modelId` string
- `capture` boolean
- `externalId` string

## Request body

- InvokeInput
  - `data` IFunctionInput
    - `size` integer
  - `externalId` string, nullable
  - `metadata` object, nullable

## Response `200`

Invoke succeeded

- FunctionOutput
  - `labelName` string, nullable
  - `labelId` string, nullable
  - `labelMetadata` object, nullable
  - `confidence` number, double
  - `decisionThreshold` number, double, nullable
  - `labelConfidences` LabelConfidence[], nullable
    - `labelId` string, nullable
    - `labelName` string, nullable
    - `labelMetadata` object, nullable
    - `confidence` number, double
    - `decisionThreshold` number, double, nullable
  - `externalId` string, nullable

## Other responses

- `400` — Bad Request
- `503` — Server Error

---

[API](https://skmtc.dev/nyckel/apis/nyckel-v1-api.md) · [All operations](https://skmtc.dev/nyckel/apis/nyckel-v1-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nyckel/nyckel-v1-api/revisions/b183d0887428/schema)