# Prompt Guide

## Retrieve

`models.prompt_guide.retrieve(strmodel_id, PromptGuideRetrieveParams**kwargs)  -> PromptGuideRetrieveResponse`

**get** `/models/{modelId}/prompt-guide`

Get the prompt guide of the given `modelId`

### Parameters

- `model_id: str`

- `project_id: Optional[str]`

  The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)

### Returns

- `class PromptGuideRetrieveResponse: …`

  - `prompt_guide: PromptGuide`

    - `value: str`

      The markdown prompt guide used as the system prompt for Prompt Spark.

      Instructions and baked-in examples both live in this single markdown document.
      No runtime templating is performed on it.

### Example

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
prompt_guide = client.models.prompt_guide.retrieve(
    model_id="modelId",
)
print(prompt_guide.prompt_guide)
```

#### Response

```json
{
  "promptGuide": {
    "value": "value"
  }
}
```

## Update

`models.prompt_guide.update(strmodel_id, PromptGuideUpdateParams**kwargs)  -> PromptGuideUpdateResponse`

**put** `/models/{modelId}/prompt-guide`

Update the markdown prompt guide of the given `modelId`

### Parameters

- `model_id: str`

- `prompt_guide: str`

  The markdown prompt guide (ex: `# Instructions\n...`). Set to `null` to delete the prompt guide.

- `project_id: Optional[str]`

  The projectId used for ownership resource management. Either to assert ownership or to set the owner of the resource(s)

### Returns

- `class PromptGuideUpdateResponse: …`

  - `prompt_guide: PromptGuide`

    - `value: str`

      The markdown prompt guide used as the system prompt for Prompt Spark.

      Instructions and baked-in examples both live in this single markdown document.
      No runtime templating is performed on it.

### Example

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
prompt_guide = client.models.prompt_guide.update(
    model_id="modelId",
    prompt_guide="promptGuide",
)
print(prompt_guide.prompt_guide)
```

#### Response

```json
{
  "promptGuide": {
    "value": "value"
  }
}
```

## Domain Types

### Prompt Guide Retrieve Response

- `class PromptGuideRetrieveResponse: …`

  - `prompt_guide: PromptGuide`

    - `value: str`

      The markdown prompt guide used as the system prompt for Prompt Spark.

      Instructions and baked-in examples both live in this single markdown document.
      No runtime templating is performed on it.

### Prompt Guide Update Response

- `class PromptGuideUpdateResponse: …`

  - `prompt_guide: PromptGuide`

    - `value: str`

      The markdown prompt guide used as the system prompt for Prompt Spark.

      Instructions and baked-in examples both live in this single markdown document.
      No runtime templating is performed on it.