SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Knowledge Hub

Get an AI agent by id.

Get an AI agent by id.

GEThttps://app.softsolz.uk/api/v1/services/smart-chat/agents/{id}

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

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

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 GET \
--url https://app.softsolz.uk/api/v1/services/smart-chat/agents/{id} \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

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 · 200

{
"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"
}
}