latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

snippet

Generates code for a Snippet

post/snippets/generated

Request body

workspace_idstring required

The ID of the workspace that is requesting the code generation

snippet_type'css' | 'javascript' | 'xpath' | 'sql' | 'postman'
test_type'api' | 'browser' | 'performance' | 'mobile'

Type of test

namestring

The name of the snippet

promptstring

Client provided prompt for code snippet generation

additional_contextstring

Additional context for the code generation request

current_snippetstring

The current snippet body for the code generation request

session_idstring

The session id for the prompt

Response

The prompt result

bodystring

The code generated by the AI model

descriptionstring

An optional extended description field for the generated result

prompt_idstring

The id of the prompt request

session_idstring

The session id for the prompt

successboolean

Indicates if the code generation was successful

titlestring

A brief description of the generated code result

user_idstring

The id of the user asking for the prompt

workspace_idstring

The workspace id