API reference · API
Delete a character
DELETE/v1/studio/characters/{id}API key
The character and every picture it keeps. An API key with the chat scope (a write), of a personal account: a team's key is refused (403 policy_violation, code team_key), as is an agent's. Rate limited per key at the key's own requests a minute, in a window of its own. A 404 while video and sound jobs are switched off.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The character's id, sch_ followed by hex. |
Answer 200
Deleted.
| Field | Type | What it is |
|---|---|---|
| id | string | |
| object | string | |
| deleted | boolean |
Errors
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
- 429OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.