cURL examples

Copy-paste requests for every public endpoint. Replace the placeholder key with your own; never commit a real key.

Before you start

An API key from your dashboard with the scopes each call needs
Your key exported as an environment variable, not pasted inline into shell history

Setup

Export your key

export SIMCOAI_API_KEY="pk_simco_live_example"

Account

Confirm the key works

Start here. If this fails, nothing else will work either.

curl -sS https://api.simcoai.co.uk/v1/me \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY"

Expected result

A JSON envelope with success: true and your key prefix and scopes under data. A 401 means the key or header name is wrong.

Records

List and create

List refunds

curl -sS https://api.simcoai.co.uk/v1/refunds \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY"

Create an order

curl -sS -X POST https://api.simcoai.co.uk/v1/orders \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "order_number": "ORD-2048",
    "status": "processing",
    "total_amount": "99.00",
    "currency": "GBP"
  }'

Fetch one record

curl -sS https://api.simcoai.co.uk/v1/orders/ord_01HQ... \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY"

Update a record

curl -sS -X PATCH https://api.simcoai.co.uk/v1/orders/ord_01HQ... \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"shipped"}'

Chat

Ask the AI a question

Uses the same business knowledge as your AI receptionist.

curl -sS -X POST https://api.simcoai.co.uk/v1/chat \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"What are your opening hours?"}'

Signing

Check your HMAC implementation

Returns a worked example you can compare your own signing code against.

curl -sS https://api.simcoai.co.uk/v1/signature-example \
  -H "X-SIMCOAI-API-Key: $SIMCOAI_API_KEY"