v1

latestOpenAPI 3.1.02026-07-26132433.7 KB
ZeroClick

Create a response (ZeroClick-authenticated)

OpenAI-style Responses endpoint, authenticated by verifying the zc-signature HMAC over the raw request bytes. The request is routed by model using model metadata, and the same orchestration as /v1/responses runs behind it.

On success, actual token usage is settled with ZeroClick and reported via the zc-usage response header.

post/zeroclick/v1/responses

Headers

zc-request-idstring
Example:zcreq_1

ZeroClick request id, echoed in logs for correlation. Set by ZeroClick when it proxies the request.

zc-agent-idstring
Example:agt_1

Identifier of the buying agent. Used to partition logs/analytics by agent; becomes the synthesized caller identity.

Request body

modelstring required
inputstring required

Prompt text. Combined with instructions (as a system message) to form the model input.

instructionsstring

System-style instructions prepended to the input. Classification models may pass comma-separated or bracketed candidate labels here.

max_output_tokensinteger nullable
parallel_tool_callsboolean
previous_response_idstring nullable
storeboolean
temperaturenumber nullable
top_pnumber nullable
truncation'auto' | 'disabled'
categoriesstring[]

Candidate labels for text-classification models.

multilingualboolean
metadataobject

Up to 16 string key/value pairs echoed back in the response envelope. Also carries GLiNER usecase options (usecase, schema, labels, threshold, mask, replacement_char), which are consumed and not necessarily echoed.

Example request

{
  "model": "LFM2.5-1.2B-Instruct"
}

Response

OpenAI Responses response object. Includes the zc-usage header settling actual usage with ZeroClick.

idstring
object'response'
created_atinteger
status'completed' | 'failed'
completed_atinteger nullable
{"stackTrail":"components:schemas:ResponsesResponse:properties:incomplete_details","oasType":"schema","type":"unknown","nullable":true}
instructionsstring nullable
max_output_tokensinteger nullable
modelstring
parallel_tool_callsboolean
previous_response_idstring nullable
storeboolean
temperaturenumber nullable
tool_choicestring
top_pnumber nullable
truncation'auto' | 'disabled'
userstring nullable
metadataobject