Quickstart

Get from zero to an invoked device function in a few curls.

Create an API key in the dashboard under API keys, then come back here with $ORQUESTR_API_KEY.

1. API key

Export your key and base URL:

export API=https://api.orquestr.dev/cloud
export ORQUESTR_API_KEY="sk_live_…"   # account API key
export CUSTOMER_ID="…"                 # customer UUID

Send it on every request:

Authorization: Bearer $ORQUESTR_API_KEY

2. List devices

curl -s "$API/v1/devices?customer_id=$CUSTOMER_ID" \
  -H "Authorization: Bearer $ORQUESTR_API_KEY"

Response: { data: Device[], meta }. Results respect the API key’s optional customer / license / device filters.

3. List functions for a device

curl -s "$API/v1/devices/$DEVICE_ID/functions" \
  -H "Authorization: Bearer $ORQUESTR_API_KEY"

Response: { data: Function[], meta } (meta includes device_id and adapter).

4. Invoke (example: product search)

curl -s -X POST \
  "$API/v1/devices/$DEVICE_ID/functions/sicarv4.products.search" \
  -H "Authorization: Bearer $ORQUESTR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "input": {
      "q": "coca 600",
      "status": "1",
      "servicio": "0",
      "existencia_op": "gte",
      "existencia": "1",
      "limit": "50"
    }
  }'

The device must be enrolled and online via the Gateway. Response is { "data": { device_id, function_id, operation, result } } — result is the agent payload (rows / error).

All SICAR V4 functions

Full catalog with parameters and examples.

API reference

How to authenticate and call the Cloud API.

Getting started

Functions

Adapters

Quickstart

Quickstart

1. API key

2. List devices

3. List functions for a device

4. Invoke (example: product search)

All SICAR V4 functions

API reference

​Quickstart

​1. API key

​2. List devices

​3. List functions for a device

​4. Invoke (example: product search)

All SICAR V4 functions

API reference

Quickstart

1. API key

2. List devices

3. List functions for a device

4. Invoke (example: product search)