One workflow, several entry points
A board connects inputs, models and outputs. A publication freezes a version and defines what callers can provide and retrieve. The REST API channel makes that version executable over HTTP.
Board → Publication → Version → HTTP call → Results
Prepare the publication
Build and check the board
Connect inputs to processing steps and outputs on your board. Check the result in Naquada before making it available to your tools.
Choose inputs and outputs
Click Publish. In the publication, define exposed fields, their aliases and returned outputs. These aliases become the keys in your inputs object.
Enable the API and publish a version
Under Activation, enable REST API. Publish the desired version for that channel. Editing the source board does not change an already frozen version.
Authorize a key
Under Publications → Keys, create a key and grant access to this publication. Both the channel and the key’s access must be enabled.
Test, then move to production
A Sandbox key (ctr_sbx_…) returns test results without running models or spending credits. A Production key (ctr_prd_…) runs the workflow and uses the owner’s credits.
Keep the key on your server
Call the workflow
Replace my-workflow with the publication slug and version=1 with a version published for the API. The version parameter is required. The brief alias below is illustrative: use your publication’s own aliases.
curl --request POST \
"https://api.naquada.tech/api/v1/generate/my-workflow?version=1" \
--header "Authorization: Bearer $NAQUADA_PUBLICATION_KEY" \
--header "Content-Type: application/json" \
--data '{"inputs":{"brief":"A short product introduction"},"async_response":true}'With async_response: true, the API returns HTTP 202 and a resultId. Keep this identifier to track the execution. Response values below are illustrative.
{
"resultId": "12345678-1234-4234-8234-123456789abc",
"status": "processing",
"version": 1
}Retrieve results
Poll this URL using the same publication key. The response provides status; exposed results appear in outputs when processing finishes. In the example, set NAQUADA_RESULT_ID to the resultId you received.
curl "https://api.naquada.tech/api/v1/generate/results/$NAQUADA_RESULT_ID" \
--header "Authorization: Bearer $NAQUADA_PUBLICATION_KEY"processing: running · waiting_for_approval: human approval needed · completed: finished · partially_completed: partial results · failed: unsuccessful. Space polling requests apart and set a maximum wait in your application.
Without async_response: true, the call waits up to two minutes. It may return 202 if processing continues, so your integration must handle that case too.
Files, notifications and limits
For file fields, pass HTTPS URLs in inputs. Multiple-file fields accept a URL array. Alternatively use multipart/form-data: the data part holds the JSON envelope and each file part is named file_<alias>.
For completion notifications, configure an allowed webhook. Verify X-Naquada-Signature against the raw request body. Deliveries can be retried: process notifications idempotently.
Daily and monthly caps are independent. They apply only when enabled with a positive value. Production results use the publication owner’s budget.
Give your AI assistant a workflow
Expose a function in your service: it receives the expected fields, calls the published version, tracks resultId and returns outputs. Your assistant chooses when to call it; Naquada runs the prepared board.
Discover available contracts
List authorized publications, then retrieve the detailed contract using the publication ID, not the source board ID. Use these fields to describe the tool to your assistant.
curl "https://api.naquada.tech/api/v1/generate/boards" \
--header "Authorization: Bearer $NAQUADA_PUBLICATION_KEY"
curl "https://api.naquada.tech/api/v1/generate/discovery/$NAQUADA_PUBLICATION_ID" \
--header "Authorization: Bearer $NAQUADA_PUBLICATION_KEY"Account keys nqk_acc_… are separate from publication keys. Delegated invocation requires externalizations:invoke, access to the publication, and X-Naquada-Externalization-Key-Id containing an authorized Production publication key ID.
Read the CLI and MCP guide