Skip to content

Import Agent

POST /agents/import

Declared before /{agent_id} on purpose: a literal path segment must be matched before a parameter, or import is read as an agent id.

FieldTypeNotes
schema_versionintegeroptionalDefault 1. min 1
kindstringoptionalDefault "agent".
slugstringrequired—
namestringrequiredmin length 1 max length 200
descriptionstring | nulloptional—
scopeworkspace | organization | platform | nulloptional—
avatar_presetanalyst | archivist | builder | courier | gardener | navigator | scribe | sentinel | nulloptional—
image_urlstring | nulloptionalmax length 2048
is_activebooleanoptionalDefault true.
attributesobjectoptional—
revisionRevisionDocumentoptional—
personasPersonaDocument[]optional—
StatusDescriptionBody
201Successful ResponseAgentView
422Validation ErrorHTTPValidationError

The body shows the fields the schema always carries. Which combination is legal is a service rule the schema cannot express, so read the description above before copying this.

Terminal window
curl -X POST https://your-deployment.example.com/agents/import \
-H "Authorization: Bearer $COBRE_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"slug": "string",
"name": "string"
}'
FieldTypeNotes
idstring (uuid)required—
scopeworkspace | organization | platformrequired—
organization_idstring (uuid) | nullrequired, nullable—
workspace_idstring (uuid) | nullrequired, nullable—
slugstringrequired—
namestringrequired—
descriptionstring | nullrequired, nullable—
avatar_presetanalyst | archivist | builder | courier | gardener | navigator | scribe | sentinel | nullrequired, nullable—
image_urlstring | nullrequired, nullable—
is_activebooleanrequired—
attributesobjectrequired—
active_revision_idstring (uuid) | nullrequired, nullable—
created_by_user_idstring (uuid) | nullrequired, nullable—
created_atstring (date-time)required—
updated_atstring (date-time)required—
active_revisionAgentRevisionView | nulloptional—
revision_countinteger | nulloptional—