Open a draft version
If the user is editing a published version, clone it into a new draft so mutations have somewhere to land. The editor UI usually does this for the operator BEFORE the AI panel runs, but if you arrive on a published version (e.g. user opened the panel without clicking 'Create draft'), call this. The result includes the new draft `versionId`; the editor refreshes to it. Optionally pass `sourceVersionId` to clone from a specific older version instead of the latest.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Agent slug within the workspace.
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/workspaces/string/agents/string/versions" \ -H "Content-Type: application/json" \ -d '{}'{
"versionId": "string",
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Check what blocks publishing POST
Dry-run the publish validator against the current version WITHOUT publishing. Returns { errorCount, riskCount, diagnostics }, errors block publish, risks don't. Call this before publish_version to see and fix blockers first; a result with errorCount 0 means publish_version won't fail validation.
Delete a version DELETE
Delete an old draft or retired version of this agent. The API refuses three cases: (1) the published/live version (publish a different version first), (2) the agent's only remaining version (archive the agent instead), (3) a version that handled real calls, every session records the version that served it, and deleting the version would erase the record of which prompt and tools produced those calls' scores. Editor test chats do not count, so a draft you only tried in the text tester stays deletable. Tools and test-run history for that version cascade; call transcripts themselves stay.