Skip to content

Scenario Management

Basics

  • Base URL: https://api.ticos.cn
  • Upsert scenario: POST /scenarios
  • Delete scenario: DELETE /scenarios/{id}
  • Auth: Authorization: Bearer <token>

1. Upsert scenario (POST /scenarios)

Supports application/json and multipart/form-data.

Request fields

  • id (optional): scenario unique ID
  • title (optional): scenario title
  • content (required): scenario content

JSON example

{
"id": "scenario_idxxx",
"title": "Cardiology Doctor",
"content": "Education background ..."
}

Form example

curl --location --request POST 'https://api.ticos.cn/scenarios' \
--header 'Authorization: Bearer <API_KEY>' \
--form 'id="scenario_idxxx"' \
--form 'title="Cardiology Doctor"' \
--form 'content="Education background ..."'

2. Delete scenario (DELETE /scenarios/{id})

Example

curl --location --request DELETE 'https://api.ticos.cn/scenarios/scenario_idxxx' \
--header 'Authorization: Bearer <API_KEY>'

Common status codes

  • 200 OK: success
  • 400 Bad Request: invalid request
  • 401 Unauthorized: authentication failed
  • 404 Not Found: ID not found
  • 500 Internal Server Error: server error