prompts

Api Create Prompt

post/v1/prompts/{application_id}

Request

  • Base URL: https://api.branchly.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.branchly.io/v1/prompts/{application_id}
  • Auth: HTTP bearer

Path parameters

application_idstring uuid required

Request body

promptstring required
type'chat' | 'search_answering' | 'suggested_questions' | 'chat_evaluation' required

Types of prompts in the system.

subtype'routing_instructions' | 'output_instructions'

Subtypes for prompts - used for routing vs output instructions.

interface_type'chat' | 'navigator' | 'search' | 'api' | 'form'

Coarser grouping of EmbedType for prompt scoping.

Follows the same pattern as StyleType in the interface_styles domain. Each value maps to one or more EmbedType values via embed_type_to_interface_type.

Response

Successful Response

idstring uuid required
application_idstring uuid required
promptstring required
is_activeboolean required
type'chat' | 'search_answering' | 'suggested_questions' | 'chat_evaluation' required

Types of prompts in the system.

subtype'routing_instructions' | 'output_instructions'

Subtypes for prompts - used for routing vs output instructions.

interface_type'chat' | 'navigator' | 'search' | 'api' | 'form'

Coarser grouping of EmbedType for prompt scoping.

Follows the same pattern as StyleType in the interface_styles domain. Each value maps to one or more EmbedType values via embed_type_to_interface_type.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.