Core resources

Structured outputs

Reusable JSON schemas the assistant extracts from a conversation — capture fields like appointment date, order id, or qualification status as structured data on the call record.

GET/structured-outputs agents:read

List schemas

All structured-output schemas in the workspace.

bash

curl https://api.bolchoai.in/v1/structured-outputs -H "Authorization: Bearer $BOLCHO_API_KEY"

POST/structured-outputs agents:write

Create schema

Define a named JSON schema to extract.

Body

name*	string	Schema name.
description	string	What it captures.
schema	object	JSON Schema of the fields to extract (default {}).

bash

curl -X POST https://api.bolchoai.in/v1/structured-outputs \
  -H "Authorization: Bearer $BOLCHO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "schema": {}
}'

Response

json

{ "id": "…", "name": "Appointment", "schema": { "type": "object", "properties": { "date": { "type": "string" } } } }

PATCH/structured-outputs/{id} agents:write

Update schema

Update a schema's name, description, or shape.

Path parameters

id*

uuid

Schema id.

Body

name*	string	Schema name.
description	string	What it captures.
schema	object	JSON Schema.

bash

curl -X PATCH https://api.bolchoai.in/v1/structured-outputs/$ID \
  -H "Authorization: Bearer $BOLCHO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "schema": {}
}'

Response

json

{ "count": 1 }

DELETE/structured-outputs/{id} agents:write

Delete schema

Delete a structured-output schema.

Path parameters

id*

uuid

Schema id.

bash

curl -X DELETE https://api.bolchoai.in/v1/structured-outputs/$ID \
  -H "Authorization: Bearer $BOLCHO_API_KEY"

Response

json

{ "ok": true }