Handouts
Function-calling namespace: handouts
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode. - Send token in header:
x-stack-access-token: <access_token>(orAuthorization: Bearer <access_token>). - In
optionalmode: no token is allowed; invalid token is rejected with401.
create
Source: backend/endpoints/handouts/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
title | string | Yes | - |
description | string | No | - |
type | string | Yes | oneof: video |
url | string | Yes | - |
thumbnailUrl | string | No | - |
organizationId | string | No | - |
isGlobal | boolean | No | nullable |
isActive | boolean | No | nullable |
createdBy | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "handouts",
"apiName": "create",
"data": {
"title": "value",
"type": "video",
"url": "value"
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/handouts/delete
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "handouts",
"apiName": "delete",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/handouts/get-by-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "handouts",
"apiName": "getById",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }list
Source: backend/endpoints/handouts/list
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | No | - |
createdBy | string | No | - |
search | string | No | - |
sortBy | string | No | - |
sortOrder | string | No | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "handouts",
"apiName": "list",
"data": {
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByConsultationId
Source: backend/endpoints/handouts/list-by-consultation-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
consultationId | string | Yes | - |
organizationId | string | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "handouts",
"apiName": "listByConsultationId",
"data": {
"consultationId": "consultation_123"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/handouts/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
title | string | No | nullable |
description | string | No | nullable |
type | string | No | nullable |
url | string | No | nullable |
thumbnailUrl | string | No | nullable |
organizationId | string | No | nullable |
isGlobal | boolean | No | nullable |
isActive | boolean | No | nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "handouts",
"apiName": "update",
"data": {
"id": "id_123"
}
}'Example Response
{ "status": "ok", "data": {} }