Skip to main content
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#overview

SourcePromptTemplate

Source persona template to convert into an agent profile during import. Its source_dsl contains the original template syntax from which the importer derives the profile template and variable specifications.

Meaning and usage​

Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#meaning

See the definition above.

Usage profiles​

Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#fields

UsageFields and validation
In requestsView fields

In requests​

Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#request

API JSON uses JSON field names (camelCase).

FieldTypePresenceMeaning
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#field-profileidSection ID: DOC-API-MODEL-schema-pjk9r8rn5b#request-field-profileidprofileIdstringOptionalIdentifier of the agent profile associated with the operation or generation.
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#field-nameSection ID: DOC-API-MODEL-schema-pjk9r8rn5b#request-field-namenamestringOptionalDisplay name for the imported agent profile.
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#field-whentouseSection ID: DOC-API-MODEL-schema-pjk9r8rn5b#request-field-whentousewhenToUsestringOptionalInstructions describing when the imported agent profile should be selected.
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#field-keywordsSection ID: DOC-API-MODEL-schema-pjk9r8rn5b#request-field-keywordskeywordsArray of stringOptionalKeywords associated with selection of the imported agent profile.
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#field-sourcedslSection ID: DOC-API-MODEL-schema-pjk9r8rn5b#request-field-sourcedslsourceDslstringOptionalRaw source-DSL system prompt.
Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#field-generationconfigSection ID: DOC-API-MODEL-schema-pjk9r8rn5b#request-field-generationconfiggenerationConfigGenerationConfigOptionalGeneration settings other than the prompt, such as temperature. Must not set model or models: import refuses a template that does, and the model is set afterwards with UpdateAgentProfile.

Where used​

Section ID: DOC-API-MODEL-schema-pjk9r8rn5b#where-used

ReferenceRelationship
Import a prompt libraryPOST /api/v1/agent-profiles/import

Download the public reference contract.

Document ID: DOC-API-MODEL-schema-pjk9r8rn5b