Create an AI agent.

POSThttps://app.softsolz.uk/api/v1/services/smart-chat/agents

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

namestringrequired

Agent name.

instructionsstringrequired

System instructions / persona.

descriptionstring | null

Short description.

allowed_tablesarray of strings

Tenant tables the agent may read (unknown names are dropped).

visibilitystring

Visibility (default "tenant").

shared_user_idsarray of integers

Member ids (required when visibility=shared).

shared_role_idsarray of integers

Role ids (when visibility=shared).

Response

Response Body

idstringAgent id.

namestringAgent name.

descriptionstring | nullShort description.

instructionsstringSystem instructions / persona.

allowed_tablesarray of stringsTenant tables the agent may read.

visibilitystringVisibility.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

Request

curl --request POST \
  --url https://app.softsolz.uk/api/v1/services/smart-chat/agents \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "AR Assistant",
  "instructions": "You are an AR assistant that helps chase overdue invoices.",
  "description": "Chases overdue invoices.",
  "allowed_tables": [
    "invoices",
    "customers"
  ],
  "visibility": "tenant"
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 201

{
  "data": {
    "id": "a0000000-0000-0000-0000-000000000001",
    "name": "AR Assistant",
    "description": "Helps chase overdue invoices.",
    "instructions": "You are an AR assistant...",
    "allowed_tables": [
      "invoices",
      "customers"
    ],
    "visibility": "tenant",
    "created_at": "2026-06-01T09:00:00.000Z",
    "updated_at": "2026-06-02T09:00:00.000Z"
  }
}